Cmdlet

Get-OfficeWordDocumentProperty

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument System.String[]
Outputs: PSWriteOffice.Models.Word.WordDocumentPropertyInfo
Source: GetOfficeWordDocumentPropertyCommand.cs:11 Edit on GitHub

Gets built-in and custom document properties.

Syntax

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

Parameter set: Document

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

Parameter set: Path

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

Parameter set: LiteralPath

Examples

Example 1

Get-OfficeWordDocumentProperty -Name @('Name')

Example 2

Get-OfficeWordDocumentProperty -LiteralPath @('C:\Path')

Example 3

Get-OfficeWordDocumentProperty -Path @('C:\Path')

Parameters

-BuiltIn SwitchParameter optional: BuiltIn for this inspection.
-Custom SwitchParameter optional: Custom for this inspection.
-Document WordDocument optionalpipeline: True (ByValue)sets: Document: Document for this inspection.
-Name String[] optional: Name for this inspection.
-Path String[] requiredposition: 0pipeline: True (ByValue)sets: Path: Path for this inspection.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: LiteralPath for this inspection.

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.

Outputs

PSWriteOffice.Models.Word.WordDocumentPropertyInfo: Represents a Word document property exposed to PowerShell.