Get Started

API Reference

Cmdlet

New-OfficePowerPointImageOptions

Namespace PSWriteOffice
Inputs
None
Outputs
OfficeIMO.PowerPoint.PowerPointPresentationImageExportOptions
Source
Sources/PSWriteOffice/Cmdlets/PowerPoint/NewOfficePowerPointImageOptionsCommand.cs:16 Edit on GitHub

Creates discoverable slide selection and rendering settings for Export-OfficePowerPointImage.

Remarks

Creates discoverable slide selection and rendering settings for Export-OfficePowerPointImage.

Examples

Authored help example

Render selected slides with their backgrounds and content.

PS>


$options = New-OfficePowerPointImageOptions -SlideNumber 1,3 -IncludeSlideBackground -IncludeSlideContent
            Export-OfficePowerPointImage -Path .\Deck.pptx -OutputPath .\Slides -Options $options

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-OfficePowerPointImageOptions [-BackgroundColor <String>] [-IncludeAutoShapes] [-IncludeCharts] [-IncludeHiddenShapes] [-IncludeHiddenSlides] [-IncludePictures] [-IncludeSlideBackground] [-IncludeSlideContent] [-IncludeTables] [-IncludeTextBoxes] [-MaximumDegreeOfParallelism <Int32>] [-MaximumOutputCount <Int32>] [-MaximumOutputHeight <Int32>] [-MaximumOutputWidth <Int32>] [-MaximumRasterPixels <Int64>] [-MaximumTotalEncodedBytes <Int64>] [-MaximumTotalRasterPixels <Int64>] [-RasterOverflowBehavior <ReduceScale|Throw>] [-RenderTimeoutSeconds <Double>] [-Scale <Double>] [-SlideNumber <Int32[]>] [-TargetDpi <Double>] [-TextShapingLanguage <String>] [<CommonParameters>]
#
Parameter set: All Parameter Sets

Parameters

BackgroundColor String optionalposition: namedpipeline: False
IncludeAutoShapes SwitchParameter optionalposition: namedpipeline: False
Render auto shapes.
IncludeCharts SwitchParameter optionalposition: namedpipeline: False
Render charts.
IncludeHiddenShapes SwitchParameter optionalposition: namedpipeline: False
Render hidden shapes.
IncludeHiddenSlides SwitchParameter optionalposition: namedpipeline: False
Include hidden slides.
IncludePictures SwitchParameter optionalposition: namedpipeline: False
Render pictures.
IncludeSlideBackground SwitchParameter optionalposition: namedpipeline: False
Render slide backgrounds.
IncludeSlideContent SwitchParameter optionalposition: namedpipeline: False
Render slide content.
IncludeTables SwitchParameter optionalposition: namedpipeline: False
Render tables.
IncludeTextBoxes SwitchParameter optionalposition: namedpipeline: False
Render text boxes.
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
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2
Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
Scale Double optionalposition: namedpipeline: False
SlideNumber Int32[] optionalposition: namedpipeline: False
One-based slide numbers to export.
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False

Outputs

OfficeIMO.PowerPoint.PowerPointPresentationImageExportOptions