Watermark

Contents
[ ]
Request Response Model
Delete DeleteWatermarkOnlineRequest DeleteWatermarkOnlineResponse
DeleteWatermarkRequest DocumentResponse Document
Insert InsertWatermarkImageOnlineRequest InsertWatermarkImageOnlineResponse
InsertWatermarkImageRequest DocumentResponse Document
InsertWatermarkTextOnlineRequest InsertWatermarkTextOnlineResponse WatermarkText
InsertWatermarkTextRequest DocumentResponse Document
WatermarkText

WatermarkText

Represents a class for insert watermark text request building.

This class is used in InsertWatermarkTextOnlineRequest, InsertWatermarkTextRequest.

The following properties are defined:

Property Type Description
RotationAngle double Gets or sets the watermark rotation angle.
Text string Gets or sets the watermark text.

DeleteWatermarkOnlineRequest

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

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

  • DeleteWatermarkOnlineRequest()
  • DeleteWatermarkOnlineRequest(Stream document, 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.
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.

DeleteWatermarkOnlineResponse

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

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

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

DeleteWatermarkRequest

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

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

  • DeleteWatermarkRequest()
  • DeleteWatermarkRequest(string name, 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.
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.

InsertWatermarkImageOnlineRequest

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

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

  • InsertWatermarkImageOnlineRequest()
  • InsertWatermarkImageOnlineRequest(Stream document, Stream imageFile, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, double? rotationAngle, string image)

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

Argument Property Type Description
document Document Stream The document.
imageFile ImageFile Stream File with image.
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.
rotationAngle RotationAngle double? The rotation angle of the watermark.
image Image string The filename of the image. If the parameter value is missing — the image data is expected in the request content.

InsertWatermarkImageOnlineResponse

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

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

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

InsertWatermarkImageRequest

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

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

  • InsertWatermarkImageRequest()
  • InsertWatermarkImageRequest(string name, Stream imageFile, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, double? rotationAngle, string image)

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

Argument Property Type Description
name Name string The filename of the input document.
imageFile ImageFile Stream File with image.
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.
rotationAngle RotationAngle double? The rotation angle of the watermark.
image Image string The filename of the image. If the parameter value is missing — the image data is expected in the request content.

InsertWatermarkTextOnlineRequest

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

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

  • InsertWatermarkTextOnlineRequest()
  • InsertWatermarkTextOnlineRequest(Stream document, WatermarkText watermarkText, 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.
watermarkText WatermarkText WatermarkText The watermark data.
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.

InsertWatermarkTextOnlineResponse

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

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

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

InsertWatermarkTextRequest

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

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

  • InsertWatermarkTextRequest()
  • InsertWatermarkTextRequest(string name, WatermarkText watermarkText, 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.
watermarkText WatermarkText WatermarkText The watermark data.
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.
Text WordsApi