Page
| Request | Response | Model | ||
|---|---|---|---|---|
| Insert | InsertPageNumbersOnlineRequest | InsertPageNumbersOnlineResponse | PageNumber | |
| InsertPageNumbersRequest | DocumentResponse | DocumentPageNumber | ||
| Render | RenderPageOnlineRequest | Stream | ||
| RenderPageRequest | ||||
PageNumber
Represents a class is used for insert page number request building.
This class is used in InsertPageNumbersOnlineRequest, InsertPageNumbersRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Alignment | string | Gets or sets text alignment, possible values are left, right, center or justify. |
| Format | string | Gets or sets the page number format, e.g. “{PAGE} of {NUMPAGES}”. |
| IsTop | bool | Gets or sets a value indicating whether if true the page number is added at the top of the page, else at the bottom. |
| SetPageNumberOnFirstPage | bool | Gets or sets a value indicating whether if true the page number is added on first page too. |
InsertPageNumbersOnlineRequest
Represents a request model for WordsApi.InsertPageNumbersOnline() operation.
An object of the InsertPageNumbersOnlineRequest class is created by the following constructor methods:
- InsertPageNumbersOnlineRequest()
- InsertPageNumbersOnlineRequest(Stream document, PageNumber pageNumber, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| pageNumber | PageNumber | PageNumber | Page number dto. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
InsertPageNumbersOnlineResponse
Represents a response model for WordsApi.InsertPageNumbersOnline() operation.
An object of the InsertPageNumbersOnlineResponse class is created by the following constructor methods:
- InsertPageNumbersOnlineResponse(DocumentResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | DocumentResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
InsertPageNumbersRequest
Represents a request model for WordsApi.InsertPageNumbers() operation.
An object of the InsertPageNumbersRequest class is created by the following constructor methods:
- InsertPageNumbersRequest()
- InsertPageNumbersRequest(string name, PageNumber pageNumber, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| pageNumber | PageNumber | PageNumber | Page number dto. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| destFileName | DestFileName | string | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
| revisionAuthor | RevisionAuthor | string | Initials of the author to use for revisions.If you set this parameter and then make some changes to the document programmatically, save the document and later open the document in MS Word you will see these changes as revisions. |
| revisionDateTime | RevisionDateTime | string | The date and time to use for revisions. |
RenderPageOnlineRequest
Represents a request model for WordsApi.RenderPageOnline() operation.
An object of the RenderPageOnlineRequest class is created by the following constructor methods:
- RenderPageOnlineRequest()
- RenderPageOnlineRequest(Stream document, int pageIndex, string format, string loadEncoding, string password, string encryptedPassword, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| pageIndex | PageIndex | int | The index of the page. |
| format | Format | string | The destination format. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
RenderPageRequest
Represents a request model for WordsApi.RenderPage() operation.
An object of the RenderPageRequest class is created by the following constructor methods:
- RenderPageRequest()
- RenderPageRequest(string name, int pageIndex, string format, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string fontsLocation)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| pageIndex | PageIndex | int | The index of the page. |
| format | Format | string | The destination format. |
| folder | Folder | string | Original document folder. |
| storage | Storage | string | Original document storage. |
| loadEncoding | LoadEncoding | string | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
| password | Password | string | Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API. |
| encryptedPassword | EncryptedPassword | string | Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details. |
| fontsLocation | FontsLocation | string | Folder in filestorage with custom fonts. |
PageSetup.BorderAppliesToEnum
The following values are defined: AllPages, FirstPage, OtherPages.
PageSetup.BorderDistanceFromEnum
The following values are defined: Text, PageEdge.
PageSetup.LineNumberRestartModeEnum
The following values are defined: RestartPage, RestartSection, Continuous.
PageSetup.OrientationEnum
The following values are defined: Portrait, Landscape.
PageSetup.PageNumberStyleEnum
The following values are defined: Arabic, UppercaseRoman, LowercaseRoman, UppercaseLetter, LowercaseLetter, Ordinal, Number, OrdinalText, Hex, ChicagoManual, Kanji, KanjiDigit, AiueoHalfWidth, IrohaHalfWidth, ArabicFullWidth, ArabicHalfWidth, KanjiTraditional, KanjiTraditional2, NumberInCircle, DecimalFullWidth, Aiueo, Iroha, LeadingZero, Bullet, Ganada, Chosung, GB1, GB2, GB3, GB4, Zodiac1, Zodiac2, Zodiac3, TradChinNum1, TradChinNum2, TradChinNum3, TradChinNum4, SimpChinNum1, SimpChinNum2, SimpChinNum3, SimpChinNum4, HanjaRead, HanjaReadDigit, Hangul, Hanja, Hebrew1, Arabic1, Hebrew2, Arabic2, HindiLetter1, HindiLetter2, HindiArabic, HindiCardinalText, ThaiLetter, ThaiArabic, ThaiCardinalText, VietCardinalText, NumberInDash, LowercaseRussian, UppercaseRussian, None, Custom.
PageSetup.PaperSizeEnum
The following values are defined: A3, A4, A5, B4, B5, Executive, Folio, Ledger, Legal, Letter, EnvelopeDL, Quarto, Statement, Tabloid, Paper10x14, Paper11x17, Custom.
PageSetup.SectionStartEnum
The following values are defined: Continuous, NewColumn, NewPage, EvenPage, OddPage.
PageSetup.VerticalAlignmentEnum
The following values are defined: Top, Center, Justify, Bottom.