New-BGInfoImage

Namespace PowerBGInfo

Inputs

None

Outputs

PowerBGInfo.BgInfoImage

Creates a BGInfo image overlay definition.

Remarks

Creates a BGInfo image overlay definition.

Examples

Authored help example

EXAMPLE 1


New-BGInfoImage -Path 'C:\Path'

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-BGInfoImage [-Anchor <TopLeft>] [-Fit <Stretch|Contain|Cover|Center|Tile>] [-Height <Int32>] [-OffsetX <Int32>] [-OffsetY <Int32>] [-Opacity <Double>] -Path <String> [-PositionX <Int32>] [-PositionY <Int32>] [-Width <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

Anchor BgInfoTextPosition optionalposition: namedpipeline: Falsevalues: 9: Anchor position for placement.; Possible values: TopLeft, TopCenter, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight
Fit BgInfoImageFit optionalposition: namedpipeline: Falsevalues: 5: How the image is fitted inside the destination rectangle.; Possible values: Stretch, Contain, Cover, Center, Tile
Height Int32 optionalposition: namedpipeline: False: Target image height in pixels. Omit with Width to preserve aspect ratio.
OffsetX Int32 optionalposition: namedpipeline: False: Horizontal offset from the anchor.
OffsetY Int32 optionalposition: namedpipeline: False: Vertical offset from the anchor.
Opacity Double optionalposition: namedpipeline: False: Image opacity from zero to one.
Path String requiredposition: 0pipeline: Falsealiases: FullName: Path to the image file.
PositionX Int32 optionalposition: namedpipeline: False: Absolute X position for placement.
PositionY Int32 optionalposition: namedpipeline: False: Absolute Y position for placement.
Width Int32 optionalposition: namedpipeline: False: Target image width in pixels. Omit with Height to preserve aspect ratio.

Outputs

PowerBGInfo.BgInfoImage