ParagraphFormat
Contents
[
Hide
]
ParagraphFormatBase
Represents a paragraph format element base class.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Link | WordsApiLink | Gets or sets the link to the document. |
| AddSpaceBetweenFarEastAndAlpha | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph. |
| AddSpaceBetweenFarEastAndDigit | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph. |
| Alignment | AlignmentEnum | Gets or sets text alignment for the paragraph. |
| Bidi | bool | Gets or sets a value indicating whether this is a right-to-left paragraph. |
| DropCapPosition | DropCapPositionEnum | Gets or sets the position for a drop cap text. |
| FirstLineIndent | double | Gets or sets the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. |
| KeepTogether | bool | Gets or sets a value indicating whether all lines in the paragraph are to remain on the same page. |
| KeepWithNext | bool | Gets or sets a value indicating whether the paragraph is to remains on the same page as the paragraph that follows it. |
| LeftIndent | double | Gets or sets the value (in points) , that represents the left indent for paragraph. |
| LineSpacing | double | Gets or sets the line spacing (in points) for the paragraph. |
| LineSpacingRule | LineSpacingRuleEnum | Gets or sets the line spacing for the paragraph. |
| LinesToDrop | int | Gets or sets the number of lines of the paragraph text used to calculate the drop cap height. |
| NoSpaceBetweenParagraphsOfSameStyle | bool | Gets or sets a value indicating whether SpaceBefore and SpaceAfter will be ignored between the paragraphs of the same style. |
| OutlineLevel | OutlineLevelEnum | Gets or sets the outline level of the paragraph in the document. |
| PageBreakBefore | bool | Gets or sets a value indicating whether a page break is forced before the paragraph. |
| RightIndent | double | Gets or sets the value (in points) that represents the right indent for paragraph. |
| Shading | Shading | Gets or sets the Shading object, that refers to the shading formatting for the paragraph. |
| SpaceAfter | double | Gets or sets the amount of spacing (in points) after the paragraph. |
| SpaceAfterAuto | bool | Gets or sets a value indicating whether the amount of spacing after the paragraph is set automatically. |
| SpaceBefore | double | Gets or sets the amount of spacing (in points) before the paragraph. |
| SpaceBeforeAuto | bool | Gets or sets a value indicating whether the amount of spacing before the paragraph is set automatically. |
| StyleIdentifier | StyleIdentifierEnum | Gets or sets the locale independent style identifier of the paragraph style applied to this formatting. |
| StyleName | string | Gets or sets the name of the paragraph style applied to this formatting. |
| SuppressAutoHyphens | bool | Gets or sets a value indicating whether the current paragraph should be exempted from any hyphenation which is applied in the document settings. |
| SuppressLineNumbers | bool | Gets or sets a value indicating whether the current paragraph’s lines should be exempted from line numbering which is applied in the parent section. |
| WidowControl | bool | Gets or sets a value indicating whether the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph. |
ParagraphFormat
Represents a paragraph format element.
This class is inherited from ParagraphFormatBase and used in ParagraphFormatResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Link | WordsApiLink | Gets or sets the link to the document. |
| AddSpaceBetweenFarEastAndAlpha | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph. |
| AddSpaceBetweenFarEastAndDigit | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph. |
| Alignment | AlignmentEnum | Gets or sets text alignment for the paragraph. |
| Bidi | bool | Gets or sets a value indicating whether this is a right-to-left paragraph. |
| DropCapPosition | DropCapPositionEnum | Gets or sets the position for a drop cap text. |
| FirstLineIndent | double | Gets or sets the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. |
| KeepTogether | bool | Gets or sets a value indicating whether all lines in the paragraph are to remain on the same page. |
| KeepWithNext | bool | Gets or sets a value indicating whether the paragraph is to remains on the same page as the paragraph that follows it. |
| LeftIndent | double | Gets or sets the value (in points) , that represents the left indent for paragraph. |
| LineSpacing | double | Gets or sets the line spacing (in points) for the paragraph. |
| LineSpacingRule | LineSpacingRuleEnum | Gets or sets the line spacing for the paragraph. |
| LinesToDrop | int | Gets or sets the number of lines of the paragraph text used to calculate the drop cap height. |
| NoSpaceBetweenParagraphsOfSameStyle | bool | Gets or sets a value indicating whether SpaceBefore and SpaceAfter will be ignored between the paragraphs of the same style. |
| OutlineLevel | OutlineLevelEnum | Gets or sets the outline level of the paragraph in the document. |
| PageBreakBefore | bool | Gets or sets a value indicating whether a page break is forced before the paragraph. |
| RightIndent | double | Gets or sets the value (in points) that represents the right indent for paragraph. |
| Shading | Shading | Gets or sets the Shading object, that refers to the shading formatting for the paragraph. |
| SpaceAfter | double | Gets or sets the amount of spacing (in points) after the paragraph. |
| SpaceAfterAuto | bool | Gets or sets a value indicating whether the amount of spacing after the paragraph is set automatically. |
| SpaceBefore | double | Gets or sets the amount of spacing (in points) before the paragraph. |
| SpaceBeforeAuto | bool | Gets or sets a value indicating whether the amount of spacing before the paragraph is set automatically. |
| StyleIdentifier | StyleIdentifierEnum | Gets or sets the locale independent style identifier of the paragraph style applied to this formatting. |
| StyleName | string | Gets or sets the name of the paragraph style applied to this formatting. |
| SuppressAutoHyphens | bool | Gets or sets a value indicating whether the current paragraph should be exempted from any hyphenation which is applied in the document settings. |
| SuppressLineNumbers | bool | Gets or sets a value indicating whether the current paragraph’s lines should be exempted from line numbering which is applied in the parent section. |
| WidowControl | bool | Gets or sets a value indicating whether the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph. |
| IsHeading | bool | Gets or sets a value indicating whether the paragraph style is one of the built-in Heading styles. |
| IsListItem | bool | Gets or sets a value indicating whether the paragraph is an item in a bulleted or numbered list. |
ParagraphFormatUpdate
Represents a paragraph format element update DTO.
This class is inherited from ParagraphFormatBase and used in UpdateParagraphFormatOnlineRequest, UpdateParagraphFormatRequest.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| Link | WordsApiLink | Gets or sets the link to the document. |
| AddSpaceBetweenFarEastAndAlpha | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of Latin text and regions of East Asian text in the current paragraph. |
| AddSpaceBetweenFarEastAndDigit | bool | Gets or sets a value indicating whether inter-character spacing is automatically adjusted between regions of numbers and regions of East Asian text in the current paragraph. |
| Alignment | AlignmentEnum | Gets or sets text alignment for the paragraph. |
| Bidi | bool | Gets or sets a value indicating whether this is a right-to-left paragraph. |
| DropCapPosition | DropCapPositionEnum | Gets or sets the position for a drop cap text. |
| FirstLineIndent | double | Gets or sets the value (in points) for a first line or hanging indent. Use a positive value to set a first-line indent, and use a negative value to set a hanging indent. |
| KeepTogether | bool | Gets or sets a value indicating whether all lines in the paragraph are to remain on the same page. |
| KeepWithNext | bool | Gets or sets a value indicating whether the paragraph is to remains on the same page as the paragraph that follows it. |
| LeftIndent | double | Gets or sets the value (in points) , that represents the left indent for paragraph. |
| LineSpacing | double | Gets or sets the line spacing (in points) for the paragraph. |
| LineSpacingRule | LineSpacingRuleEnum | Gets or sets the line spacing for the paragraph. |
| LinesToDrop | int | Gets or sets the number of lines of the paragraph text used to calculate the drop cap height. |
| NoSpaceBetweenParagraphsOfSameStyle | bool | Gets or sets a value indicating whether SpaceBefore and SpaceAfter will be ignored between the paragraphs of the same style. |
| OutlineLevel | OutlineLevelEnum | Gets or sets the outline level of the paragraph in the document. |
| PageBreakBefore | bool | Gets or sets a value indicating whether a page break is forced before the paragraph. |
| RightIndent | double | Gets or sets the value (in points) that represents the right indent for paragraph. |
| Shading | Shading | Gets or sets the Shading object, that refers to the shading formatting for the paragraph. |
| SpaceAfter | double | Gets or sets the amount of spacing (in points) after the paragraph. |
| SpaceAfterAuto | bool | Gets or sets a value indicating whether the amount of spacing after the paragraph is set automatically. |
| SpaceBefore | double | Gets or sets the amount of spacing (in points) before the paragraph. |
| SpaceBeforeAuto | bool | Gets or sets a value indicating whether the amount of spacing before the paragraph is set automatically. |
| StyleIdentifier | StyleIdentifierEnum | Gets or sets the locale independent style identifier of the paragraph style applied to this formatting. |
| StyleName | string | Gets or sets the name of the paragraph style applied to this formatting. |
| SuppressAutoHyphens | bool | Gets or sets a value indicating whether the current paragraph should be exempted from any hyphenation which is applied in the document settings. |
| SuppressLineNumbers | bool | Gets or sets a value indicating whether the current paragraph’s lines should be exempted from line numbering which is applied in the parent section. |
| WidowControl | bool | Gets or sets a value indicating whether the first and last lines in the paragraph are to remain on the same page as the rest of the paragraph. |
Shading
Represents a dTO container with a paragraph format shading element.
This class is used in ParagraphFormat, ParagraphFormatBase, ParagraphFormatUpdate.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| BackgroundPatternColor | XmlColor | Gets or sets the color that’s applied to the background of the Shading object. |
| ForegroundPatternColor | XmlColor | Gets or sets the color that’s applied to the foreground of the Shading object. |
| Texture | TextureEnum | Gets or sets the shading texture. |
GetParagraphFormatOnlineRequest
Represents a request model for WordsApi.GetParagraphFormatOnline() operation.
An object of the GetParagraphFormatOnlineRequest class is created by the following constructor methods:
- GetParagraphFormatOnlineRequest()
- GetParagraphFormatOnlineRequest(Stream document, int index, string nodePath, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| document | Document | Stream | The document. |
| index | Index | int | Object index. |
| nodePath | NodePath | string | The path to the node in the document tree. |
| 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. |
GetParagraphFormatRequest
Represents a request model for WordsApi.GetParagraphFormat() operation.
An object of the GetParagraphFormatRequest class is created by the following constructor methods:
- GetParagraphFormatRequest()
- GetParagraphFormatRequest(string name, int index, string nodePath, string folder, string storage, string loadEncoding, string password, string encryptedPassword)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| name | Name | string | The filename of the input document. |
| index | Index | int | Object index. |
| nodePath | NodePath | string | The path to the node in the document tree. |
| 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. |
ParagraphFormatResponse
Represents a REST response with the formatting properties of a paragraph.
This class is inherited from WordsResponse and used in WordsApi, UpdateParagraphFormatOnlineResponse.
The following properties are defined:
| Property | Type | Description |
|---|---|---|
| RequestId | string | Gets or sets the request Id. |
| ParagraphFormat | ParagraphFormat | Gets or sets the formatting properties of a paragraph. |
UpdateParagraphFormatOnlineRequest
Represents a request model for WordsApi.UpdateParagraphFormatOnline() operation.
An object of the UpdateParagraphFormatOnlineRequest class is created by the following constructor methods:
- UpdateParagraphFormatOnlineRequest()
- UpdateParagraphFormatOnlineRequest(Stream document, ParagraphFormatUpdate paragraphFormatDto, int index, string nodePath, 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. |
| paragraphFormatDto | ParagraphFormatDto | ParagraphFormatUpdate | Dto for paragraph format update. |
| index | Index | int | Object index. |
| nodePath | NodePath | string | The path to the node in the document tree. |
| 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. |
UpdateParagraphFormatOnlineResponse
Represents a response model for WordsApi.UpdateParagraphFormatOnline() operation.
An object of the UpdateParagraphFormatOnlineResponse class is created by the following constructor methods:
- UpdateParagraphFormatOnlineResponse(ParagraphFormatResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
| Argument | Property | Type | Description |
|---|---|---|---|
| model | Model | ParagraphFormatResponse | The response model. |
| document | Document | Dictionary<string,Stream> | The document after modification. |
UpdateParagraphFormatRequest
Represents a request model for WordsApi.UpdateParagraphFormat() operation.
An object of the UpdateParagraphFormatRequest class is created by the following constructor methods:
- UpdateParagraphFormatRequest()
- UpdateParagraphFormatRequest(string name, int index, ParagraphFormatUpdate paragraphFormatDto, string nodePath, 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. |
| index | Index | int | Object index. |
| paragraphFormatDto | ParagraphFormatDto | ParagraphFormatUpdate | Dto for paragraph format update. |
| nodePath | NodePath | string | The path to the node in the document tree. |
| 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. |
ParagraphFormatBase.AlignmentEnum
The following values are defined: Left, Center, Right, Justify, Distributed, ArabicMediumKashida, ArabicHighKashida, ArabicLowKashida, ThaiDistributed.
ParagraphFormatBase.DropCapPositionEnum
The following values are defined: None, Normal, Margin.
ParagraphFormatBase.LineSpacingRuleEnum
The following values are defined: AtLeast, Exactly, Multiple.
ParagraphFormatBase.OutlineLevelEnum
The following values are defined: Level1, Level2, Level3, Level4, Level5, Level6, Level7, Level8, Level9, BodyText.