Get Started

API Reference

Cmdlet

Get-OfficeWordPictureControl

Aliases: WordPictureControls
Namespace PSWriteOffice
Aliases
WordPictureControls
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordPictureControl
Source
Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordPictureControlCommand.cs:24 Edit on GitHub

Gets picture content controls from a Word document.

Remarks

Gets picture content controls from a Word document.

Examples

Authored help example

Example 1: Find picture placeholder controls.

PS>


$pictures = Get-OfficeWordPictureControl -Path .\Template.docx -Tag 'logo-*'
            $pictures |
                Select-Object -Property Alias, Tag |
                Format-Table -AutoSize

Filters picture content controls used as image placeholders in a Word template.

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

Get-OfficeWordPictureControl [-Alias <String[]>] -InputPath <String> [-Tag <String[]>] [<CommonParameters>]
#
Parameter set: Path

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by picture control alias (wildcards supported).
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path
Path to the .docx file.
Tag String[] optionalposition: namedpipeline: False
Filter by picture control tag (wildcards supported).

Outputs

OfficeIMO.Word.WordPictureControl

Get-OfficeWordPictureControl [-Alias <String[]>] -Document <WordDocument> [-Tag <String[]>] [<CommonParameters>]
#
Parameter set: Document

Parameters

Alias String[] optionalposition: namedpipeline: False
Filter by picture control alias (wildcards supported).
Document WordDocument requiredposition: namedpipeline: True (ByValue)
Word document to read.
Tag String[] optionalposition: namedpipeline: False
Filter by picture control tag (wildcards supported).

Outputs

OfficeIMO.Word.WordPictureControl