Text

Contents
[ ]
Request Response Model
Replace ReplaceTextOnlineRequest ReplaceTextOnlineResponse ReplaceTextParameters
ReplaceTextRequest ReplaceTextResponse FileLink
ReplaceTextParameters
ReplaceWithTextOnlineRequest ReplaceWithTextOnlineResponse ReplaceRange
ReplaceWithTextRequest DocumentResponse Document
ReplaceRange
Search SearchOnlineRequest SearchResponse SearchResultsCollection
SearchRequest

ReplaceRange

Represents a dTO container with a range element.

This class is used in ReplaceWithTextOnlineRequest, ReplaceWithTextRequest.

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.

ReplaceTextParameters

Represents a class for document replace text request building.

This class is used in ReplaceTextOnlineRequest, ReplaceTextRequest.

The following properties are defined:

Property Type Description
IsMatchCase bool Gets or sets a value indicating whether flag, true means the search is case-sensitive; false means the search is not case-sensitive.
IsMatchWholeWord bool Gets or sets a value indicating whether flag, means that only whole word matched are replaced.
IsOldValueRegex bool Gets or sets a value indicating whether flag, means that OldValue contains regex expression.
NewValue string Gets or sets the new text value to replace by.
OldValue string Gets or sets the old text value (or regex pattern IsOldValueRegex) to replace.

SearchResult

Represents a result of search operation.

This class is used in SearchResultsCollection.

The following properties are defined:

Property Type Description
RangeEnd DocumentPosition Gets or sets the link to result range end node.
RangeStart DocumentPosition Gets or sets the link to result range start node.

SearchResultsCollection

Represents a collection of search results.

This class is inherited from LinkElement and used in SearchResponse.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
ResultsList List<SearchResult> Gets or sets the collection of comments.

ReplaceTextOnlineRequest

Represents a request model for WordsApi.ReplaceTextOnline() operation.

An object of the ReplaceTextOnlineRequest class is created by the following constructor methods:

  • ReplaceTextOnlineRequest()
  • ReplaceTextOnlineRequest(Stream document, ReplaceTextParameters replaceText, 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.
replaceText ReplaceText ReplaceTextParameters The replace operation settings.
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.

ReplaceTextOnlineResponse

Represents a response model for WordsApi.ReplaceTextOnline() operation.

An object of the ReplaceTextOnlineResponse class is created by the following constructor methods:

Each of those arguments initializes the corresponding self-titled property:

Argument Property Type Description
model Model ReplaceTextResponse The response model.
document Document Dictionary<string,Stream> The document after modification.

ReplaceTextRequest

Represents a request model for WordsApi.ReplaceText() operation.

An object of the ReplaceTextRequest class is created by the following constructor methods:

  • ReplaceTextRequest()
  • ReplaceTextRequest(string name, ReplaceTextParameters replaceText, 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.
replaceText ReplaceText ReplaceTextParameters The replace operation settings.
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.

ReplaceTextResponse

Represents a REST response with a number of occurrences of the captured text in the document.

This class is inherited from WordsResponse and used in WordsApi, ReplaceTextOnlineResponse.

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
DocumentLink FileLink Gets or sets the link to the document.
Matches int Gets or sets the number of occurrences of the captured text in the document.

ReplaceWithTextOnlineRequest

Represents a request model for WordsApi operation.

An object of the ReplaceWithTextOnlineRequest class is created by the following constructor methods:

  • ReplaceWithTextOnlineRequest()
  • ReplaceWithTextOnlineRequest(Stream document, string rangeStartIdentifier, ReplaceRange rangeText, 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.
rangeText RangeText ReplaceRange Model with text for replacement.
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.

ReplaceWithTextOnlineResponse

Represents a response model for WordsApi operation.

An object of the ReplaceWithTextOnlineResponse class is created by the following constructor methods:

  • ReplaceWithTextOnlineResponse(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.

ReplaceWithTextRequest

Represents a request model for WordsApi.ReplaceWithText() operation.

An object of the ReplaceWithTextRequest class is created by the following constructor methods:

  • ReplaceWithTextRequest()
  • ReplaceWithTextRequest(string name, string rangeStartIdentifier, ReplaceRange rangeText, 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.
rangeText RangeText ReplaceRange Model with text for replacement.
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.

SearchOnlineRequest

Represents a request model for WordsApi.SearchOnline() operation.

An object of the SearchOnlineRequest class is created by the following constructor methods:

  • SearchOnlineRequest()
  • SearchOnlineRequest(Stream document, string pattern, 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.
pattern Pattern string The regular expression used to find matches.
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.

SearchRequest

Represents a request model for WordsApi.Search() operation.

An object of the SearchRequest class is created by the following constructor methods:

  • SearchRequest()
  • SearchRequest(string name, string pattern, 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.
pattern Pattern string The regular expression used to find matches.
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.

SearchResponse

Represents a REST response with a regular expression pattern and a collection of search results.

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.
SearchingPattern string Gets or sets the regular expression pattern used to find matches.
SearchResults SearchResultsCollection Gets or sets the collection of search results.
TableRow Watermark