Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

Stars 654

Forks 82

Open issues 1

Total downloads 4,320,051

Release OfficeIMO-v3.5.3

Language: C# Updated: 2026-11-03

Cmdlet

Get-OfficeWordDocumentProperty

Module: PSWriteOffice
Inputs: OfficeIMO.Word.WordDocument
Outputs: PSWriteOffice.Models.Word.WordDocumentPropertyInfo
Source: GetOfficeWordDocumentPropertyCommand.cs:23 Edit on GitHub

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

Syntax

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

Parameter set: Path

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

Parameter set: Document

Examples

Read release metadata from a document.

$properties = Get-OfficeWordDocumentProperty -Path .\Report.docx -Name Title, Subject, ReleaseStatus
$properties |
    Select-Object -Property Name, Value, IsCustom |
    Format-Table -AutoSize

Returns selected built-in and custom properties for a document metadata check.

Parameters

-BuiltIn SwitchParameter optional: Only return built-in document properties.
-Custom SwitchParameter optional: Only return custom document properties.
-Name String[] optional: Property name filter (wildcards supported).
-Path String requiredposition: 0aliases: FilePath, InputPathsets: Path: Path to the document.
-Document WordDocument requiredpipeline: True (ByValue)sets: Document: Document to inspect.

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.