Border
Border
Represents a border of an object.
This class is inherited from LinkElement and used in BorderResponse, BordersCollection, Font, UpdateBorderOnlineRequest, UpdateBorderRequest.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
BorderType | BorderTypeEnum | Gets or sets the border type. |
Color | XmlColor | Gets or sets the border color. |
DistanceFromText | double | Gets or sets the distance of the border from text or from the page edge in points. |
LineStyle | LineStyleEnum | Gets or sets the border style. |
LineWidth | double | Gets or sets the border width in points. |
Shadow | bool | Gets or sets a value indicating whether the border has a shadow. |
BordersCollection
Represents a collection of borders.
This class is inherited from LinkElement and used in BordersResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
Link | WordsApiLink | Gets or sets the link to the document. |
List | List<Border> | Gets or sets the collection of comments. |
BorderResponse
Represents a REST response with a border.
This class is inherited from WordsResponse and used in WordsApi, DeleteBorderOnlineResponse, UpdateBorderOnlineResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
Border | Border | Gets or sets the border. |
BordersResponse
Represents a REST response with a collection of borders.
This class is inherited from WordsResponse and used in WordsApi, DeleteBordersOnlineResponse.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
Borders | BordersCollection | Gets or sets the collection of borders. |
DeleteBorderOnlineRequest
Represents a request model for WordsApi.DeleteBorderOnline() operation.
An object of the DeleteBorderOnlineRequest class is created by the following constructor methods:
- DeleteBorderOnlineRequest()
- DeleteBorderOnlineRequest(Stream document, string borderType, 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. |
borderType | BorderType | string | Border type. |
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. |
DeleteBorderOnlineResponse
Represents a response model for WordsApi.DeleteBorderOnline() operation.
An object of the DeleteBorderOnlineResponse class is created by the following constructor methods:
- DeleteBorderOnlineResponse(BorderResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | BorderResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
DeleteBorderRequest
Represents a request model for WordsApi.DeleteBorder() operation.
An object of the DeleteBorderRequest class is created by the following constructor methods:
- DeleteBorderRequest()
- DeleteBorderRequest(string name, string borderType, 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. |
borderType | BorderType | string | Border type. |
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. |
DeleteBordersOnlineRequest
Represents a request model for WordsApi.DeleteBordersOnline() operation.
An object of the DeleteBordersOnlineRequest class is created by the following constructor methods:
- DeleteBordersOnlineRequest()
- DeleteBordersOnlineRequest(Stream document, 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. |
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. |
DeleteBordersOnlineResponse
Represents a response model for WordsApi.DeleteBordersOnline() operation.
An object of the DeleteBordersOnlineResponse class is created by the following constructor methods:
- DeleteBordersOnlineResponse(BordersResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | BordersResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
DeleteBordersRequest
Represents a request model for WordsApi.DeleteBorders() operation.
An object of the DeleteBordersRequest class is created by the following constructor methods:
- DeleteBordersRequest()
- DeleteBordersRequest(string name, 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. |
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. |
GetBorderOnlineRequest
Represents a request model for WordsApi.GetBorderOnline() operation.
An object of the GetBorderOnlineRequest class is created by the following constructor methods:
- GetBorderOnlineRequest()
- GetBorderOnlineRequest(Stream document, string borderType, 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. |
borderType | BorderType | string | Border type. |
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. |
GetBorderRequest
Represents a request model for WordsApi.GetBorder() operation.
An object of the GetBorderRequest class is created by the following constructor methods:
- GetBorderRequest()
- GetBorderRequest(string name, string borderType, 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. |
borderType | BorderType | string | Border type. |
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. |
GetBordersOnlineRequest
Represents a request model for WordsApi.GetBordersOnline() operation.
An object of the GetBordersOnlineRequest class is created by the following constructor methods:
- GetBordersOnlineRequest()
- GetBordersOnlineRequest(Stream document, 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. |
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. |
GetBordersRequest
Represents a request model for WordsApi.GetBorders() operation.
An object of the GetBordersRequest class is created by the following constructor methods:
- GetBordersRequest()
- GetBordersRequest(string name, 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. |
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. |
UpdateBorderOnlineRequest
Represents a request model for WordsApi.UpdateBorderOnline() operation.
An object of the UpdateBorderOnlineRequest class is created by the following constructor methods:
- UpdateBorderOnlineRequest()
- UpdateBorderOnlineRequest(Stream document, Border borderProperties, string borderType, 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. |
borderProperties | BorderProperties | Border | Border properties. |
borderType | BorderType | string | Border type. |
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. |
UpdateBorderOnlineResponse
Represents a response model for WordsApi.UpdateBorderOnline() operation.
An object of the UpdateBorderOnlineResponse class is created by the following constructor methods:
- UpdateBorderOnlineResponse(BorderResponse model, Dictionary<string,Stream> document)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
model | Model | BorderResponse | The response model. |
document | Document | Dictionary<string,Stream> | The document after modification. |
UpdateBorderRequest
Represents a request model for WordsApi.UpdateBorder() operation.
An object of the UpdateBorderRequest class is created by the following constructor methods:
- UpdateBorderRequest()
- UpdateBorderRequest(string name, string borderType, Border borderProperties, 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. |
borderType | BorderType | string | Border type. |
borderProperties | BorderProperties | Border | Border properties. |
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. |
Border.BorderTypeEnum
The following values are defined: Bottom, Left, Right, Top, Horizontal, Vertical, DiagonalDown, DiagonalUp, None.
Border.LineStyleEnum
The following values are defined: None, Single, Thick, Double, Hairline, Dot, DashLargeGap, DotDash, DotDotDash, Triple, ThinThickSmallGap, ThickThinSmallGap, ThinThickThinSmallGap, ThinThickMediumGap, ThickThinMediumGap, ThinThickThinMediumGap, ThinThickLargeGap, ThickThinLargeGap, ThinThickThinLargeGap, Wave, DoubleWave, DashSmallGap, DashDotStroker, Emboss3D, Engrave3D, Outset, Inset.