Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 609 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeOpenDocument

Module PSWriteOffice
Inputs
System.String
Outputs
OfficeIMO.OpenDocument.OdfDocument OfficeIMO.OpenDocument.OdtDocument OfficeIMO.OpenDocument.OdsDocument OfficeIMO.OpenDocument.OdpPresentation OfficeIMO.OpenDocument.OdgDocument
Source
GetOfficeOpenDocumentCommand.cs:9 Edit on GitHub

Loads a native ODT, ODS, ODP, or ODG document.

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

Examples

Authored help example

EXAMPLE 1

Get-OfficeOpenDocument -Path 'C:\Path'

Parameters

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

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.