Get-OfficeWordDocumentProperty

Namespace PSWriteOffice

Inputs

OfficeIMO.Word.WordDocument

Outputs

PSWriteOffice.Models.Word.WordDocumentPropertyInfo

Gets built-in and custom document properties from a Word document.

Remarks

Gets built-in and custom document properties from a Word document.

Examples

List document properties.


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

Returns built-in and custom Word document properties.

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-OfficeWordDocumentProperty [-BuiltIn] [-Custom] -InputPath <String> [-Name <String[]>] [<CommonParameters>]

Parameter set: Path

Parameters

BuiltIn SwitchParameter optionalposition: namedpipeline: False: Only return built-in document properties.
Custom SwitchParameter optionalposition: namedpipeline: False: Only return custom document properties.
InputPath String requiredposition: 0pipeline: Falsealiases: FilePath, Path: Path to the document.
Name String[] optionalposition: namedpipeline: False: Property name filter (wildcards supported).

Outputs

PSWriteOffice.Models.Word.WordDocumentPropertyInfo

Get-OfficeWordDocumentProperty [-BuiltIn] [-Custom] -Document <WordDocument> [-Name <String[]>] [<CommonParameters>]

Parameter set: Document

Parameters

BuiltIn SwitchParameter optionalposition: namedpipeline: False: Only return built-in document properties.
Custom SwitchParameter optionalposition: namedpipeline: False: Only return custom document properties.
Document WordDocument requiredposition: namedpipeline: True (ByValue): Document to inspect.
Name String[] optionalposition: namedpipeline: False: Property name filter (wildcards supported).

Outputs

PSWriteOffice.Models.Word.WordDocumentPropertyInfo