New-OfficeHtmlRenderOptions

Namespace PSWriteOffice

Inputs

None

Outputs

OfficeIMO.Html.HtmlRenderOptions

Source

Sources/PSWriteOffice/Cmdlets/Html/NewOfficeHtmlRenderOptionsCommand.cs:18 Edit on GitHub

Creates discoverable layout, resource-limit, and rendering settings for HTML image export.

Remarks

Creates discoverable layout, resource-limit, and rendering settings for HTML image export.

Examples

Authored help example

Render HTML with a bounded viewport and resource budget.

PS>


$render = New-OfficeHtmlRenderOptions -ViewportWidth 1280 -ViewportHeight 720 -MaxPageCount 10
            Export-OfficeHtmlImage -Path .\Report.html -OutputPath .\Report.svg -RenderOptions $render

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-OfficeHtmlRenderOptions [-BackgroundColor <String>] [-BaseUri <String>] [-DefaultFontFamily <String>] [-DefaultFontSize <Double>] [-DefaultLineHeight <Double>] [-FidelityPolicy <AllowDiagnosedLoss|RequireNoLoss>] [-HonorCssPageRules] [-MaxHtmlNodes <Int32>] [-MaximumDegreeOfParallelism <Int32>] [-MaximumOutputCount <Int32>] [-MaximumOutputHeight <Int32>] [-MaximumOutputWidth <Int32>] [-MaximumRasterPixels <Int64>] [-MaximumTotalEncodedBytes <Int64>] [-MaximumTotalRasterPixels <Int64>] [-MaxInputCharacters <Int32>] [-MaxPageCount <Int32>] [-MaxTotalResourceBytes <Int64>] [-Mode <Continuous|Paged>] [-PageSize <OfficePageSize>] [-RasterOverflowBehavior <ReduceScale|Throw>] [-RenderTimeoutSeconds <Double>] [-ResourceTimeoutSeconds <Double>] [-Scale <Double>] [-TargetDpi <Double>] [-TextShapingLanguage <String>] [-ViewportHeight <Double>] [-ViewportWidth <Double>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

BackgroundColor String optionalposition: namedpipeline: False
BaseUri String optionalposition: namedpipeline: False: Base URI for relative resources.
DefaultFontFamily String optionalposition: namedpipeline: False: Default font family.
DefaultFontSize Double optionalposition: namedpipeline: False: Default font size.
DefaultLineHeight Double optionalposition: namedpipeline: False: Default line-height multiplier.
FidelityPolicy HtmlRenderFidelityPolicy optionalposition: namedpipeline: Falsevalues: 2: Fidelity policy for unsupported content.; Possible values: AllowDiagnosedLoss, RequireNoLoss
HonorCssPageRules SwitchParameter optionalposition: namedpipeline: False: Honor CSS page rules.
MaxHtmlNodes Int32 optionalposition: namedpipeline: False: Maximum HTML nodes.
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
MaxInputCharacters Int32 optionalposition: namedpipeline: False: Maximum HTML input characters.
MaxPageCount Int32 optionalposition: namedpipeline: False: Maximum rendered page count.
MaxTotalResourceBytes Int64 optionalposition: namedpipeline: False: Maximum resource bytes loaded for the document.
Mode HtmlRenderMode optionalposition: namedpipeline: Falsevalues: 2: HTML render mode.; Possible values: Continuous, Paged
PageSize OfficePageSize optionalposition: namedpipeline: False: Page size used by paged rendering.
RasterOverflowBehavior OfficeRasterOverflowBehavior optionalposition: namedpipeline: Falsevalues: 2: Possible values: ReduceScale, Throw
RenderTimeoutSeconds Double optionalposition: namedpipeline: False
ResourceTimeoutSeconds Double optionalposition: namedpipeline: False: Maximum duration allowed for one resource load.
Scale Double optionalposition: namedpipeline: False
TargetDpi Double optionalposition: namedpipeline: False
TextShapingLanguage String optionalposition: namedpipeline: False
ViewportHeight Double optionalposition: namedpipeline: False: Optional viewport height in CSS pixels.
ViewportWidth Double optionalposition: namedpipeline: False: Viewport width in CSS pixels.

Outputs

OfficeIMO.Html.HtmlRenderOptions