Evotec

Project

PSWriteOffice

PSWriteOffice is an open-source PowerShell and .NET project with packages, release history, and technical documentation.

View on GitHub Releases Get package
Stars 144
Forks 12
Open issues 16
PowerShell Gallery downloads 150,904
Release v0.2.0
Language: C# Updated: 2026-04-06

API Reference

Cmdlet

Get-OfficeWordDocumentProperty

Namespace PSWriteOffice
Inputs
OfficeIMO.Word.WordDocument
Outputs
PSWriteOffice.Models.Word.WordDocumentPropertyInfo
Source
Sources/PSWriteOffice/Cmdlets/Word/GetOfficeWordDocumentPropertyCommand.cs:20 Edit on GitHub

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

Remarks

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

Examples

Authored help example

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: Represents a Word document property exposed to PowerShell.

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: Represents a Word document property exposed to PowerShell.