Project

PSWriteOffice

PowerShell document automation across Word, Excel, PowerPoint, PDF, Reader, Confluence, Visio, and open text formats.

View on GitHub Releases Get package
Stars 159
Forks 14
PowerShell Gallery downloads 158,661
Release v3.0.5
Language: C# Updated: 2026-09-03

API Reference

Cmdlet

Get-OfficeOpenDocument

Namespace PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.OpenDocument.OdfDocument OfficeIMO.OpenDocument.OdtDocument OfficeIMO.OpenDocument.OdsDocument OfficeIMO.OpenDocument.OdpPresentation
Source
Sources/PSWriteOffice/Cmdlets/OpenDocument/GetOfficeOpenDocumentCommand.cs:9 Edit on GitHub

Loads a native ODT, ODS, or ODP document.

Remarks

Loads a native ODT, ODS, or ODP document.

Examples

Authored help example

EXAMPLE 1


Get-OfficeOpenDocument -Path 'C:\Path'

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-OfficeOpenDocument [-MaxCompressionRatio <Double>] [-MaxDepth <Int32>] [-MaxEntries <Int32>] [-MaxEntryUncompressedBytes <Int64>] [-MaxPackageBytes <Int64>] [-MaxTotalKdfIterations <Int64>] [-MaxTotalUncompressedBytes <Int64>] [-MaxXmlCharacters <Int64>] [-MaxXmlDepth <Int32>] [-Options <OdfLoadOptions>] [-Password <String>] -Path <String> [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

MaxCompressionRatio Double optionalposition: namedpipeline: False
Maximum declared expansion ratio for a compressed entry.
MaxDepth Int32 optionalposition: namedpipeline: False
Maximum archive path depth.
MaxEntries Int32 optionalposition: namedpipeline: False
Maximum number of ZIP entries.
MaxEntryUncompressedBytes Int64 optionalposition: namedpipeline: False
Maximum uncompressed size of one package entry.
MaxPackageBytes Int64 optionalposition: namedpipeline: False
Maximum source package size in bytes.
MaxTotalKdfIterations Int64 optionalposition: namedpipeline: False
Maximum aggregate PBKDF2 iterations across encrypted entries.
MaxTotalUncompressedBytes Int64 optionalposition: namedpipeline: False
Maximum aggregate uncompressed package size.
MaxXmlCharacters Int64 optionalposition: namedpipeline: False
Maximum characters allowed in one parsed XML part.
MaxXmlDepth Int32 optionalposition: namedpipeline: False
Maximum element nesting depth in one parsed XML part.
Options OdfLoadOptions optionalposition: namedpipeline: False
Optional bounded package and XML settings.
Password String optionalposition: namedpipeline: False
Password used to decrypt an encrypted OpenDocument package.
Path String requiredposition: 0pipeline: True (ByValue)
Path to an ODT, ODS, or ODP file.

Outputs

OfficeIMO.OpenDocument.OdfDocument, OfficeIMO.OpenDocument.OdtDocument, OfficeIMO.OpenDocument.OdsDocument, OfficeIMO.OpenDocument.OdpPresentation