OfficeIMO

API Reference

Command

Get-OfficeWordContentControl

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
OfficeIMO.Word.WordStructuredDocumentTag

Gets structured content controls from a Word document.

Remarks

Gets structured content controls from a Word document.

Examples

List all content controls.


PS>Get-OfficeWordContentControl -Path .\Report.docx
        

Returns all structured document tags in the document.

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-OfficeWordContentControl [-Alias <String[]>] -InputPath <String> [-Tag <String[]>] [-Text <String[]>] [<CommonParameters>]
#
Parameter set: Path

Parameters

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

Outputs

OfficeIMO.Word.WordStructuredDocumentTag

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

Parameters

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

Outputs

OfficeIMO.Word.WordStructuredDocumentTag