API Reference
Cmdlet
Add-OfficeExcelImageFromUrl
Adds an image from a URL anchored to a worksheet cell or range.
Remarks
Adds an image from a URL anchored to a worksheet cell or range.
Examples
Example 1: Insert a scaled image from a URL at B2.
PS>
ExcelSheet 'Data' { Add-OfficeExcelImageFromUrl -Address 'B2' -Url 'https://example.org/logo.png' -ScalePercent 20 -Name Logo -AltText 'Company logo' }
Downloads the remote image, sizes it to 20 percent of its original dimensions, and anchors it to cell B2.
Example 2: Pin a URL image to a worksheet range.
PS>
ExcelSheet 'Data' { Add-OfficeExcelImageFromUrl -Range 'A1:C15' -Url 'https://example.org/logo.png' -Placement MoveAndSize }
Uses Excel's two-cell anchor so the image moves and resizes with the cells in A1:C15.
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
Add-OfficeExcelImageFromUrl [-Address <String>] [-AltText <String>] [-Column <Nullable`1>] [-Decorative] [-EndOffsetXPixels <Int32>] [-EndOffsetYPixels <Int32>] [-HeightPixels <Int32>] [-Name <String>] [-NoLockAspectRatio] [-OffsetXPixels <Int32>] [-OffsetYPixels <Int32>] [-PassThru] [-Placement <MoveAndSize|MoveOnly|FreeFloating>] [-Range <String>] [-RotationDegrees <Double>] [-Row <Nullable`1>] [-ScalePercent <Nullable`1>] [-Title <String>] -Url <String> [-WidthPixels <Int32>] [<CommonParameters>]Parameter set:
ContextParameters
- Address String
- A1-style cell address (e.g., A1, C5).
- AltText String
- Optional alternative text description for accessibility.
- Column Nullable`1
- 1-based column index.
- Decorative SwitchParameter
- Marks the image as decorative by clearing alternative text metadata.
- EndOffsetXPixels Int32
- Horizontal offset in pixels for the range end marker when using Range.
- EndOffsetYPixels Int32
- Vertical offset in pixels for the range end marker when using Range.
- HeightPixels Int32
- Image height in pixels.
- Name String
- Optional drawing name used by Excel's selection pane.
- NoLockAspectRatio SwitchParameter
- Do not lock the image aspect ratio in Excel.
- OffsetXPixels Int32
- Horizontal offset in pixels from the cell origin.
- OffsetYPixels Int32
- Vertical offset in pixels from the cell origin.
- PassThru SwitchParameter
- Emit the worksheet after inserting the image.
- Placement ExcelImagePlacement
- How a range-anchored image behaves when cells move or resize. Possible values: MoveAndSize, MoveOnly, FreeFloating
- Possible values:
MoveAndSize,MoveOnly,FreeFloating - Range String
- A1-style range (for example, A1:C15) for a two-cell anchor that can move and resize with cells.
- RotationDegrees Double
- Clockwise image rotation in degrees.
- Row Nullable`1
- 1-based row index.
- ScalePercent Nullable`1
- Percentage of the original image size. Cannot be combined with WidthPixels or HeightPixels.
- Title String
- Optional alternative text title.
- Url String
- Image URL to download.
- WidthPixels Int32
- Image width in pixels.
Add-OfficeExcelImageFromUrl [-Address <String>] [-AltText <String>] [-Column <Nullable`1>] [-Decorative] -Document <ExcelDocument> [-EndOffsetXPixels <Int32>] [-EndOffsetYPixels <Int32>] [-HeightPixels <Int32>] [-Name <String>] [-NoLockAspectRatio] [-OffsetXPixels <Int32>] [-OffsetYPixels <Int32>] [-PassThru] [-Placement <MoveAndSize|MoveOnly|FreeFloating>] [-Range <String>] [-RotationDegrees <Double>] [-Row <Nullable`1>] [-ScalePercent <Nullable`1>] [-Sheet <String>] [-SheetIndex <Nullable`1>] [-Title <String>] -Url <String> [-WidthPixels <Int32>] [<CommonParameters>]Parameter set:
DocumentParameters
- Address String
- A1-style cell address (e.g., A1, C5).
- AltText String
- Optional alternative text description for accessibility.
- Column Nullable`1
- 1-based column index.
- Decorative SwitchParameter
- Marks the image as decorative by clearing alternative text metadata.
- Document ExcelDocument
- Workbook to operate on outside the DSL context.
- EndOffsetXPixels Int32
- Horizontal offset in pixels for the range end marker when using Range.
- EndOffsetYPixels Int32
- Vertical offset in pixels for the range end marker when using Range.
- HeightPixels Int32
- Image height in pixels.
- Name String
- Optional drawing name used by Excel's selection pane.
- NoLockAspectRatio SwitchParameter
- Do not lock the image aspect ratio in Excel.
- OffsetXPixels Int32
- Horizontal offset in pixels from the cell origin.
- OffsetYPixels Int32
- Vertical offset in pixels from the cell origin.
- PassThru SwitchParameter
- Emit the worksheet after inserting the image.
- Placement ExcelImagePlacement
- How a range-anchored image behaves when cells move or resize. Possible values: MoveAndSize, MoveOnly, FreeFloating
- Possible values:
MoveAndSize,MoveOnly,FreeFloating - Range String
- A1-style range (for example, A1:C15) for a two-cell anchor that can move and resize with cells.
- RotationDegrees Double
- Clockwise image rotation in degrees.
- Row Nullable`1
- 1-based row index.
- ScalePercent Nullable`1
- Percentage of the original image size. Cannot be combined with WidthPixels or HeightPixels.
- Sheet String
- Worksheet name when using Document.
- SheetIndex Nullable`1
- Worksheet index (0-based) when using Document.
- Title String
- Optional alternative text title.
- Url String
- Image URL to download.
- WidthPixels Int32
- Image width in pixels.