Cmdlet

Open-OfficeOpenDocument

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

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

Syntax

Open-OfficeOpenDocument
[[-Content] <ScriptBlock>]
[-MaxCompressionRatio <Double>]
[-MaxDepth <Int32>]
[-MaxEntries <Int32>]
[-MaxEntryUncompressedBytes <Int64>]
[-MaxPackageBytes <Int64>]
[-MaxTotalKdfIterations <Int64>]
[-MaxTotalUncompressedBytes <Int64>]
[-MaxXmlCharacters <Int64>]
[-MaxXmlDepth <Int32>]
[-PassThru]
[-Password <SecureString>]
[-Path] <String>
[-Show]
[<CommonParameters>]

Parameter set: Path

Open-OfficeOpenDocument
[[-Content] <ScriptBlock>]
-LiteralPath <String>
[-MaxCompressionRatio <Double>]
[-MaxDepth <Int32>]
[-MaxEntries <Int32>]
[-MaxEntryUncompressedBytes <Int64>]
[-MaxPackageBytes <Int64>]
[-MaxTotalKdfIterations <Int64>]
[-MaxTotalUncompressedBytes <Int64>]
[-MaxXmlCharacters <Int64>]
[-MaxXmlDepth <Int32>]
[-PassThru]
[-Password <SecureString>]
[-Show]
[<CommonParameters>]

Parameter set: LiteralPath

Examples

Example 1

Open-OfficeOpenDocument -Path 'C:\Path'

Example 2

Open-OfficeOpenDocument -LiteralPath 'C:\Path'

Parameters

-Content ScriptBlock optionalposition: 1: An optional authoring block; omission returns the live document.
-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.
-PassThru SwitchParameter optional: Emit the FileInfo after a completed authoring block.
-Password SecureString optional: Password used to decrypt an encrypted OpenDocument package.
-Path String requiredposition: 0pipeline: True (ByValue)sets: Path: Path to an ODT, ODS, ODP, or ODG file.
-Show SwitchParameter optional: Open the saved document after a completed authoring block.
-LiteralPath String requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Exact source path without wildcard expansion.

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.