New-OfficeWordImageOptions

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Word.WordImageExportOptions

Source

Sources/PSWriteOffice/Cmdlets/Word/NewOfficeWordImageOptionsCommand.cs:17 Edit on GitHub

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Remarks

Creates discoverable page and rendering settings for Export-OfficeWordImage.

Examples

Authored help example

Render the first two pages at higher density.

PS>


$options = New-OfficeWordImageOptions -PageIndex 0 -PageCount 2 -TargetDpi 144 -IncludeDocumentContent
            Export-OfficeWordImage -Path .\Report.docx -OutputPath .\Pages -Options $options

Supplying PageCount selects batch export, so OutputPath is a folder. Use -AllPages on the export command for the complete document.

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

New-OfficeWordImageOptions [-BackgroundColor <String>] [-IncludeDocumentContent] [-MaximumDegreeOfParallelism <Int32>] [-MaximumOutputCount <Int32>] [-MaximumOutputHeight <Int32>] [-MaximumOutputWidth <Int32>] [-MaximumRasterPixels <Int64>] [-MaximumTotalEncodedBytes <Int64>] [-MaximumTotalRasterPixels <Int64>] [-PageCount <Int32>] [-PageIndex <Int32>] [-RasterOverflowBehavior <ReduceScale|Throw>] [-RenderTimeoutSeconds <Double>] [-Scale <Double>] [-TargetDpi <Double>] [-TextShapingLanguage <String>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BackgroundColor String optionalposition: namedpipeline: False
IncludeDocumentContent SwitchParameter optionalposition: namedpipeline: False: Render document content.
MaximumDegreeOfParallelism Int32 optionalposition: namedpipeline: False
MaximumOutputCount Int32 optionalposition: namedpipeline: False
MaximumOutputHeight Int32 optionalposition: namedpipeline: False
MaximumOutputWidth Int32 optionalposition: namedpipeline: False
MaximumRasterPixels Int64 optionalposition: namedpipeline: False
MaximumTotalEncodedBytes Int64 optionalposition: namedpipeline: False
MaximumTotalRasterPixels Int64 optionalposition: namedpipeline: False
PageCount Int32 optionalposition: namedpipeline: False: Maximum pages exported. Supplying this value selects batch export.
PageIndex Int32 optionalposition: namedpipeline: False: Zero-based first page index.
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2: Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
Scale Double optionalposition: namedpipeline: False
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False

Outputs

OfficeIMO.Word.WordImageExportOptions