Bookmark

Contents
[ ]
Request Response Model
GetByName GetBookmarkByNameOnlineRequest BookmarkResponse Bookmark
GetBookmarkByNameRequest
Get GetBookmarksOnlineRequest BookmarksResponse Bookmarks
GetBookmarksRequest
Update UpdateBookmarkOnlineRequest UpdateBookmarkOnlineResponse BookmarkData
UpdateBookmarkRequest BookmarkResponse Bookmark
BookmarkData

Bookmark

Represents a single bookmark.

This class is inherited from LinkElement and used in BookmarkResponse, Bookmarks.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
Name string Gets or sets the name of the bookmark.
Text string Gets or sets text, enclosed in the bookmark.

Bookmarks

Represents a an array of bookmarks.

This class is inherited from LinkElement and used in BookmarksResponse.

The following properties are defined:

Property Type Description
Link WordsApiLink Gets or sets the link to the document.
BookmarkList List<Bookmark> Gets or sets the array of bookmarks.

BookmarkData

Represents a dTO for bookmark updating.

This class is used in UpdateBookmarkOnlineRequest, UpdateBookmarkRequest.

The following properties are defined:

Property Type Description
Name string Gets or sets the name of the bookmark.
Text string Gets or sets text, enclosed in the bookmark.

BookmarkResponse

Represents a REST response with a bookmark.

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

The following properties are defined:

Property Type Description
RequestId string Gets or sets the request Id.
Bookmark Bookmark Gets or sets the bookmark.

BookmarksResponse

Represents a REST response with a collection of bookmarks.

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.
Bookmarks Bookmarks Gets or sets the collection of bookmarks.

GetBookmarkByNameOnlineRequest

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

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

  • GetBookmarkByNameOnlineRequest()
  • GetBookmarkByNameOnlineRequest(Stream document, string bookmarkName, 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.
bookmarkName BookmarkName string The name of the bookmark.
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.

GetBookmarkByNameRequest

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

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

  • GetBookmarkByNameRequest()
  • GetBookmarkByNameRequest(string name, string bookmarkName, 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.
bookmarkName BookmarkName string The name of the bookmark.
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.

GetBookmarksOnlineRequest

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

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

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

GetBookmarksRequest

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

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

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

UpdateBookmarkOnlineRequest

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

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

  • UpdateBookmarkOnlineRequest()
  • UpdateBookmarkOnlineRequest(Stream document, string bookmarkName, BookmarkData bookmarkData, 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.
bookmarkName BookmarkName string The name of the bookmark.
bookmarkData BookmarkData BookmarkData Bookmark 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.

UpdateBookmarkOnlineResponse

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

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

  • UpdateBookmarkOnlineResponse(BookmarkResponse model, Dictionary<string,Stream> document)

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

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

UpdateBookmarkRequest

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

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

  • UpdateBookmarkRequest()
  • UpdateBookmarkRequest(string name, string bookmarkName, BookmarkData bookmarkData, 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.
bookmarkName BookmarkName string The name of the bookmark.
bookmarkData BookmarkData BookmarkData Bookmark 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.
Batch Border