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

Introduction

This REST API allows you to update sections's page setup properties. The API returns updated data in XML/JSON format. The Resource Properties are 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.
BorderDistanceFromPageBorderDistanceFromGets or sets a value that indicates whether the specified page border is measured from the edge of the page or from the text it surrounds.
BottomMargindoubleReturns or sets 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.
FirstPageTrayintGets or sets the paper tray (bin) to use for the first page of a section. The value is implementation (printer) specific.
FooterDistancedoubleReturns or sets the distance (in points) between the footer and the bottom of the page.
GutterdoubleGets or sets the amount of extra space added to the margin for document binding.
HeaderDistancedoubleReturns or sets the distance (in points) between the header and the top of the page.
LeftMargindoubleReturns or sets the distance (in points) between the left edge of the page and the left boundary of the body text.
LineNumberCountByintReturns or sets the numeric increment for line numbers.
LineNumberDistanceFromTextdoubleGets or sets distance between the right edge of line numbers and the left edge of the document. Set this property to zero for automatic distance between the line numbers and text of the document.
LineNumberRestartModeLineNumberRestartModeGets or sets the way line numbering runs that is, whether it starts over at the beginning of a new page or section or runs continuously.
LineStartingNumberintGets or sets the starting line number.
OrientationOrientationReturns or sets the orientation of the page. Changing 'Orientation' swaps 'PageWidth' and 'PageHeight'.
OtherPagesTrayintGets or sets the paper tray (bin) to be used for all but the first page of a section. The value is implementation (printer) specific.
PageHeightdoubleReturns or sets the height of the page in points.
PageNumberStyleNumberStyleGets or sets the page number format.
PageStartingNumberintGets or sets 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.
PageWidthdoubleReturns or sets the width of the page in points.
PaperSizePaperSizeReturns or sets 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.
RightMargindoubleReturns or sets the distance (in points) between the right edge of the page and the right boundary of the body text.
RtlGutterboolGets or sets whether Microsoft Word uses gutters for the section based on a right-to-left language or a left-to-right language.
SectionStartSectionStartReturns or sets 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.
TopMargindoubleReturns or sets the distance (in points) between the top edge of the page and the top boundary of the body text.
VerticalAlignmentPageVerticalAlignmentReturns or sets the vertical alignment of text on each page in a document or section.

Resource URI

Aspose.Words Cloud APIs 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. Checkout 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
 Python
 Ruby
 Node.js
Labels
  • No labels