Range
Request | Response | Model | ||
---|---|---|---|---|
Get | GetRangeTextOnlineRequest | RangeTextResponse | ||
GetRangeTextRequest | ||||
Remove | RemoveRangeOnlineRequest | RemoveRangeOnlineResponse | ||
RemoveRangeRequest | DocumentResponse | Document |
RangeDocumentDto
Represents a dTO container with a Range element.
A single DocumentName
property is defined:
Property | Type | Description |
---|---|---|
DocumentName | string | Gets or sets the name for a new document. |
ReplaceRangeDto
Represents a dTO container with a range element.
The following properties are defined:
Property | Type | Description |
---|---|---|
Text | string | Gets or sets the range’s text. |
TextType | TextTypeEnum | Gets or sets the range’s text type. |
RangeTextResponse
Represents a REST response with a range’s text.
This class is inherited from WordsResponse and used in WordsApi.
The following properties are defined:
Property | Type | Description |
---|---|---|
RequestId | string | Gets or sets the request Id. |
Text | string | Gets or sets the range’s text. |
GetRangeTextOnlineRequest
Represents a request model for WordsApi.GetRangeTextOnline() operation.
An object of the GetRangeTextOnlineRequest class is created by the following constructor methods:
- GetRangeTextOnlineRequest()
- GetRangeTextOnlineRequest(Stream document, string rangeStartIdentifier, string rangeEndIdentifier, 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. |
rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
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. |
GetRangeTextRequest
Represents a request model for WordsApi.GetRangeText() operation.
An object of the GetRangeTextRequest class is created by the following constructor methods:
- GetRangeTextRequest()
- GetRangeTextRequest(string name, string rangeStartIdentifier, string rangeEndIdentifier, 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. |
rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
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. |
RemoveRangeOnlineRequest
Represents a request model for WordsApi operation.
An object of the RemoveRangeOnlineRequest class is created by the following constructor methods:
- RemoveRangeOnlineRequest()
- RemoveRangeOnlineRequest(Stream document, string rangeStartIdentifier, string rangeEndIdentifier, string loadEncoding, string password, string encryptedPassword, string destFileName)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
document | Document | Stream | The document. |
rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
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. |
RemoveRangeOnlineResponse
Represents a response model for WordsApi operation.
An object of the RemoveRangeOnlineResponse class is created by the following constructor methods:
- RemoveRangeOnlineResponse(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. |
RemoveRangeRequest
Represents a request model for WordsApi.RemoveRange() operation.
An object of the RemoveRangeRequest class is created by the following constructor methods:
- RemoveRangeRequest()
- RemoveRangeRequest(string name, string rangeStartIdentifier, string rangeEndIdentifier, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName)
Each of those arguments initializes the corresponding self-titled property:
Argument | Property | Type | Description |
---|---|---|---|
name | Name | string | The filename of the input document. |
rangeStartIdentifier | RangeStartIdentifier | string | The range start identifier. |
rangeEndIdentifier | RangeEndIdentifier | string | The range end identifier. |
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. |
ReplaceRange.TextTypeEnum
The following values are defined: Text, Html.
ReplaceRangeDto.TextTypeEnum
The following values are defined: Text, Html.