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

Set-OfficeExcelDocumentProperty

Module: PSWriteOffice
Inputs: OfficeIMO.Excel.ExcelDocument
Outputs: OfficeIMO.Excel.ExcelDocument
Source: SetOfficeExcelDocumentPropertyCommand.cs:20 Edit on GitHub

Sets a built-in or application document property on an Excel workbook.

Syntax

Set-OfficeExcelDocumentProperty
[-Custom]
[-Document <ExcelDocument>]
[-Name] <String>
[-PassThru]
[[-Value] <Object>]
[<CommonParameters>]

Parameter set: All Parameter Sets

Examples

Stamp publishing metadata while creating a workbook.

New-OfficeExcel -Path .\Report.xlsx {
    Set-OfficeExcelDocumentProperty -Name Title -Value 'Operational dashboard'
    Set-OfficeExcelDocumentProperty -Name Department -Value 'Operations' -Custom
}

Updates built-in or custom workbook properties through the current Excel DSL context.

Parameters

-Custom SwitchParameter optional: Treat the property as a custom workbook property.
-Document ExcelDocument optionalpipeline: True (ByValue): Workbook to update when provided explicitly.
-Name String requiredposition: 0: Property name to update.
-PassThru SwitchParameter optional: Emit the updated workbook.
-Value Object optionalposition: 1: Property value.

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.