Skip to main content

ApiSection

Represents the ApiSection class.

Methods

MethodReturnsDescription
GetClassType"section"Returns a type of the ApiSection class.
GetFooterApiDocumentContentReturns the content for the specified footer type.
GetHeaderApiDocumentContentReturns the content for the specified header type.
GetNextApiSection | nullReturns the next section if exists.
GetPageHeighttwipsGets page height for current section.
GetPageWidthtwipsGets page width for current section.
GetPreviousApiSection | nullReturns the previous section if exists.
GetStartPageNumbernumberReturns the start page number of the specified section.
GetTypeSectionBreakTypeReturns the section break type.
RemoveFooterNoneRemoves the footer of the specified type from the current section. After removal, the footer will be inherited from \ the previous section, or if this is the first section in the document, no footer of the specified type will be presented.
RemoveHeaderNoneRemoves the header of the specified type from the current section. After removal, the header will be inherited from\ the previous section, or if this is the first section in the document, no header of the specified type will be presented.
SetEqualColumnsNoneSpecifies that all the text columns in the current section are of equal width.
SetFooterDistanceNoneSpecifies the distance from the bottom edge of the page to the bottom edge of the footer.
SetHeaderDistanceNoneSpecifies the distance from the top edge of the page to the top edge of the header.
SetNotEqualColumnsNoneSpecifies that all the columns in the current section have the different widths. Number of columns is equal \ to the length of the aWidth array. The length of the aSpaces array MUST BE equal to (aWidth.length - 1).
SetPageMarginsNoneSpecifies the page margins for all the pages in this section.
SetPageSizeNoneSpecifies the properties (size and orientation) for all the pages in the current section.
SetStartPageNumberbooleanSets the start page number for the specified section.
SetTitlePageNoneSpecifies whether the current section in this document has the different header and footer for the section first page.
SetTypeNoneSpecifies a type of the current section. The section type defines how the contents of the current \ section are placed relative to the previous section.
ToJSONJSONConverts the ApiSection object into the JSON object.