Skip to end of metadata
Go to start of metadata
Contents Summary
  

Introduction

This REST API allows you to read the page setup of a section. The API returns JSON/XML representation of the section page setup. The resource properties are the following:

Property NameTypeDescription
BidiboolSpecifies that this section contains bidirectional (complex scripts) text.
BorderAlwaysInFrontboolSpecifies where the page border is positioned relative to intersecting texts and objects.
BorderAppliesToPageBorderAppliesToSpecifies which pages the page border is printed on.
BorderDistanceFromPageBorderDistanceFromSpecifies a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds.
BottomMargindoubleSpecifies the distance (in points) between the bottom edge of the page and the bottom boundary of the body text.
DifferentFirstPageHeaderFooterboolTrue if a different header or footer is used on the first page.
FirstPageTrayintSpecifies the paper tray (bin) to use for the first page of a section. The value is implementation (printer) specific.
FooterDistancedoubleSpecifies the distance (in points) between the footer and the bottom of the page.
GutterdoubleSpecifies the amount of extra space added to the margin for document binding.
HeaderDistancedoubleSpecifies the distance (in points) between the header and the top of the page.
LeftMargindoubleSpecifies the distance (in points) between the left edge of the page and the left boundary of the body text.
LineNumberCountByintSpecifies the numeric increment for line numbers.
LineNumberDistanceFromTextdoubleSpecifies the distance between the right edge of line numbers and the left edge of the document. Set this property to zero for the automatic distance between the line numbers and text of the document.
LineNumberRestartModeLineNumberRestartModeSpecifies the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously.
LineStartingNumberintSpecifies the starting line number.
OrientationOrientationSpecifies the orientation of the page. Changing 'Orientation' swaps 'PageWidth' and 'PageHeight'.
OtherPagesTrayintSpecifies the paper tray (bin) to be used for all but the first page of a section. The value is implementation (printer) specific.
PageHeightdoubleSpecifies the height of the page in points.
PageNumberStyleNumberStyleSpecifies the page number format.
PageStartingNumberintSpecifies the starting page number of the section. The 'RestartPageNumbering' property, if set to false, will override the 'PageStartingNumber' property so that page numbering can continue from the previous section.
PageWidthdoubleSpecifies the width of the page in points.
PaperSizePaperSizeSpecifies the paper size. Setting this property updates 'PageWidth' and 'PageHeight' values. Setting this value to 'Custom' does not change existing values.
RestartPageNumberingboolTrue if page numbering restarts at the beginning of the section. If set to false, the 'RestartPageNumbering' property will override the 'PageStartingNumber' property so that page numbering can continue from the previous section.
RightMargindoubleSpecifies the distance (in points) between the right edge of the page and the right boundary of the body text.
RtlGutterboolSpecifies whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
SectionStartSectionStartSpecifies the type of section break for the specified object.
SuppressEndnotesboolTrue if endnotes are printed at the end of the next section that doesn't suppress endnotes. Suppressed endnotes are printed before the endnotes in that section.
TopMargindoubleSpecifies the distance (in points) between the top edge of the page and the top boundary of the body text.
VerticalAlignmentPageVerticalAlignmentSpecifies the vertical alignment of text on each page in a document or section.

Please note that the SDKs of this cloud API are available in Python, C#, Java, Ruby, PHP, Node.js, Android, Swift and Go languages.

Resource URI

Swagger UI lets you call this REST API directly from the browser.  

cURL Example

 Request
 Response

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of Aspose.Words Cloud SDKs along with working examples, to get you started in no time. Please check Available SDKs article to learn how to add an SDK to your project.

SDK Examples

 C#
 Java
 PHP
 Python
 Ruby
 Node.js
 Android
 Swift
 Go
Labels
  • No labels