Cmdlet

Export-OfficeDocumentAsset

Module: PSWriteOffice
Inputs: System.String[]
Outputs: OfficeIMO.Reader.OfficeDocumentMaterializedAsset OfficeIMO.Reader.ReaderTableMaterializedExport OfficeIMO.Reader.ReaderVisualMaterializedExport
Source: ExportOfficeDocumentAssetCommand.cs:23 Edit on GitHub

Writes document media, tables or visuals using the native Reader materializers.

Syntax

Export-OfficeDocumentAsset
[-Extension <String[]>]
[-Indented]
[-Kind <String[]>]
[-MaximumInputBytes <Int64>]
[-MediaType <String[]>]
[-NoClobber]
[-NoMetadata]
[-NoPayload]
[-Options <Object[]>]
[-OutputDirectory] <String>
[-Path] <String[]>
[-Range <String>]
[-Reader <OfficeDocumentReader>]
[-Sheet <OfficeSheetSelector>]
[-TableFormat <Csv|Markdown|Json>]
[-ThrottleLimit <Int32>]
[-Type <Media|Table|Visual>]
[-ValidatePayloadHash]
[<CommonParameters>]

Parameter set: Path

Export-OfficeDocumentAsset
[-Extension <String[]>]
[-Indented]
[-Kind <String[]>]
-LiteralPath <String[]>
[-MaximumInputBytes <Int64>]
[-MediaType <String[]>]
[-NoClobber]
[-NoMetadata]
[-NoPayload]
[-Options <Object[]>]
[-OutputDirectory] <String>
[-Range <String>]
[-Reader <OfficeDocumentReader>]
[-Sheet <OfficeSheetSelector>]
[-TableFormat <Csv|Markdown|Json>]
[-ThrottleLimit <Int32>]
[-Type <Media|Table|Visual>]
[-ValidatePayloadHash]
[<CommonParameters>]

Parameter set: LiteralPath

Examples

Extract presentation images and embedded files.

Export-OfficeDocumentAsset ./Review.pptx ./Assets

Export report tables as CSV files.

Get-ChildItem ./Reports/*.docx | Export-OfficeDocumentAsset -OutputDirectory ./Tables -Type Table -TableFormat Csv

Keep existing image files.

Export-OfficeDocumentAsset ./Brochure.docx ./Images -Extension png,jpg -NoClobber

Parameters

-Extension String[] optional: Selected media extensions, with or without a leading dot.
-Indented SwitchParameter optional: Indent table and visual JSON.
-Kind String[] optional: Selected media asset kinds.
-MaximumInputBytes Int64 optional: Maximum input bytes per source.
-MediaType String[] optional: Selected media MIME types.
-NoClobber SwitchParameter optional: Leave existing output files unchanged and return skipped materialization results.
-NoMetadata SwitchParameter optional: Write visual payloads without JSON metadata.
-NoPayload SwitchParameter optional: Write only visual metadata.
-Options Object[] optional: Typed common and format read policies, or common/format-keyed hashtables.
-OutputDirectory String requiredposition: 1: Destination folder for the native materialized files.
-Path String[] requiredposition: 0pipeline: True (ByValue)sets: Path: Gets or sets input paths with provider wildcard expansion.
-Range String optional: A1 range within the selected worksheet.
-Reader OfficeDocumentReader optional: Caller-configured immutable Reader.
-Sheet OfficeSheetSelector optional: Worksheet name, one-based position or sheet object.
-TableFormat OfficeTableExportFormat[] optional: Table representations to write. All formats are included by default.; Possible values: Csv, Markdown, Json
-ThrottleLimit Int32 optional: Gets or sets the maximum number of concurrent background operations.
-Type OfficeDocumentAssetType[] optional: Media, tables or visuals. Media is the default.; Possible values: Media, Table, Visual
-ValidatePayloadHash SwitchParameter optional: Validate media payload hashes when the source supplies them.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath: Gets or sets input paths without wildcard expansion, binding FileInfo.FullName and provider PSPath.

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.