Hyperlink

	Request	Response	Model
*Get*	GetDocumentHyperlinkByIndexOnlineRequest	HyperlinkResponse	Hyperlink
	GetDocumentHyperlinkByIndexRequest	HyperlinkResponse	Hyperlink
	GetDocumentHyperlinksOnlineRequest	HyperlinksResponse	Hyperlinks
	GetDocumentHyperlinksRequest	HyperlinksResponse	Hyperlinks

Represents a hyperlink element.

This class is inherited from LinkElement and used in HyperlinkResponse, Hyperlinks.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
DisplayText	string	Gets or sets the hypelink’s display text.
Value	string	Gets or sets the value.

Hyperlinks

Represents a collection of Hyperlink.

This class is inherited from LinkElement and used in HyperlinksResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
HyperlinkList	List<Hyperlink>	Gets or sets the array of Hyperlink.

Represents a REST response with a hyperlink.

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.
Hyperlink	Hyperlink	Gets or sets the hyperlink.

Represents a REST response with a collection of hyperlinks.

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.
Hyperlinks	Hyperlinks	Gets or sets the collection of hyperlinks.

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

GetDocumentHyperlinkByIndexOnlineRequest()
GetDocumentHyperlinkByIndexOnlineRequest(Stream document, int hyperlinkIndex, 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.
hyperlinkIndex	HyperlinkIndex	int	The index of the hyperlink.
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.

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

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

GetDocumentHyperlinkByIndexRequest()
GetDocumentHyperlinkByIndexRequest(string name, int hyperlinkIndex, 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.
hyperlinkIndex	HyperlinkIndex	int	The index of the hyperlink.
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.

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

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

GetDocumentHyperlinksOnlineRequest()
GetDocumentHyperlinksOnlineRequest(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.

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

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

GetDocumentHyperlinksRequest()
GetDocumentHyperlinksRequest(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.