PageSetup module
- class PageSetup.PageSetup
Bases:
DocumentSerializable- property Bidi: bool
Gets or sets whether section contains right-to-left text. :return: bool
- property Borders: Borders
Gets the page borders collection.
- property CharacterSpacingControl: CharacterSpacing
Character Spacing Control. :return: CharacterSpacing
- property ClientHeight: float
Gets the height of the client area.
- Returns:
The height of the client area.
- Return type:
float
- property ClientWidth: float
Gets the width of the client area.
- Returns:
The width of the client area.
- Return type:
float
- property ColumnsLineBetween: bool
Gets or sets the value specifies if a vertical line is draw between each of the text columns in the this section. :return: bool
- property DefaultTabWidth: float
Gets or sets the length of the auto tab.
- Returns:
The length of the auto tab.
- Return type:
float
Gets or sets a value indicating whether the current section has a different header/footer for the first page.
- Returns:
True if the current section has a different header/footer for the first page; otherwise, False.
- Return type:
bool
Gets or sets a value indicating whether the document has different headers and footers for odd-numbered and even-numbered pages.
- Returns:
True if the document has different headers and footers for odd-numbered and even-numbered pages; otherwise, False.
- Return type:
bool
- property EqualColumnWidth: bool
Gets or sets a value indicating whether equal column width. :return: bool
Gets or sets the footer height in points.
- Returns:
The footer height.
- Return type:
float
- property GridType: GridPitchType
Gets or Sets the grid type of this section. :return: GridPitchType
- property Gutter: float
Gets or sets the extra space added to the margin for document binding in points.
- Returns:
The gutter space.
- Return type:
float
- property HeaderDistance: float
Gets or sets the height of the header in points.
- Returns:
The header height.
- Return type:
float
- InsertPageNumbers(fromTopPage: bool, horizontalAlignment: PageNumberAlignment)
Inserts the page numbers. :param fromTopPage: bool :param horizontalAlignment: PageNumberAlignment :return: None
- property IsFrontPageBorder: bool
Gets or sets a value indicating whether this instance is a front page border.
- property IsTopGutter: bool
Gets the TopGutter property of the text.
- Returns:
The TopGutter property of the text.
- Return type:
bool
- property LineNumberingDistanceFromText: float
Gets or sets the distance from text in line numbering.
- property LineNumberingRestartMode: LineNumberingRestartMode
Returns or sets the line numbering mode.
- property LineNumberingStartValue: int
Gets or sets the line numbering start value.
- property LineNumberingStep: int
Gets or sets the line numbering step.
- property LinesPerPage: int
Gets or sets the number of lines per page in the document grid. :return: int
- property Margins: MarginsF
Gets or sets the page margins in points.
- Returns:
The page margins.
- Return type:
- property Orientation: PageOrientation
Gets or sets the orientation of the page.
- Returns:
The page orientation.
- Return type:
Gets or sets a value indicating whether the page border includes the footer. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrom, then it can be ignored.
- property PageBorderIncludeHeader: bool
Gets or sets a value indicating whether the page border includes the header. If the page border is not measured from the text extents using a value of text in the PageBorderOffsetFrom, then it can be ignored.
- property PageBorderOffsetFrom: PageBorderOffsetFrom
Gets or sets the position of the page border.
- property PageBordersApplyType: PageBordersApplyType
Gets or sets the value that determines on which pages the border is applied.
- property PageNumberStyle: PageNumberStyle
Gets or sets the page number style. :return: PageNumberStyle
- property PageSize: SizeF
Gets or sets the page size in points.
- Returns:
The page size.
- Return type:
SizeF
- property PageStartingNumber: int
Gets or sets the page starting number. :return: int
- property RestartPageNumbering: bool
Gets or sets a value indicating whether to restart page numbering. :return: bool
- ToString() str
- Returns:
str
- property VerticalAlignment: PageAlignment
Gets or sets the vertical alignment.
- Returns:
The vertical alignment.
- Return type: