< Back

DocumentOption

Sun Jan 19, 2020 6:37 pm

NAME DocumentOption



SYNOPSIS

Initializes a new PScribo global/document options/settings.





SYNTAX

DocumentOption [-ForceUppercaseHeader] [-ForceUppercaseSection] [-EnableSectionNumbering] [-SpaceSeparator

<String>] [-Margin <UInt16>] [-PageSize <String>] [-Orientation <String>] [-DefaultFont <String[]>]

[<CommonParameters>]



DocumentOption [-ForceUppercaseHeader] [-ForceUppercaseSection] [-EnableSectionNumbering] [-SpaceSeparator

<String>] -MarginTopAndBottom <UInt16> -MarginLeftAndRight <UInt16> [-PageSize <String>] [-Orientation <String>]

[-DefaultFont <String[]>] [<CommonParameters>]





DESCRIPTION





PARAMETERS

-ForceUppercaseHeader [<SwitchParameter>]

Forces document header to be displayed in upper case.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-ForceUppercaseSection [<SwitchParameter>]

Forces all section headers to be displayed in upper case.



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-EnableSectionNumbering [<SwitchParameter>]

Enable section/heading numbering



Required? false

Position? named

Default value False

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-SpaceSeparator <String>

Default space replacement separator



Required? false

Position? named

Default value

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Margin <UInt16>

Default page top, bottom, left and right margin (pt)



Required? false

Position? named

Default value 72

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-MarginTopAndBottom <UInt16>

Default page top and bottom margins (pt)



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-MarginLeftAndRight <UInt16>

Default page left and right margins (pt)



Required? true

Position? named

Default value 0

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-PageSize <String>

Default page size



Required? false

Position? named

Default value A4

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-Orientation <String>

Page orientation



Required? false

Position? named

Default value Portrait

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



-DefaultFont <String[]>

Default document font(s)



Required? false

Position? named

Default value @('Calibri','Candara','Segoe','Segoe UI','Optima','Arial','Sans-Serif')

Accept pipeline input? true (ByPropertyName)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Options are reset upon each invocation.





RELATED LINKS