Footnote

	Request	Response	Model
Delete	DeleteFootnoteOnlineRequest	Dictionary
	DeleteFootnoteRequest	Task
Get	GetFootnoteOnlineRequest	FootnoteResponse	Footnote
	GetFootnoteRequest
	GetFootnotesOnlineRequest	FootnotesResponse	FootnoteCollection
	GetFootnotesRequest
Insert	InsertFootnoteOnlineRequest	InsertFootnoteOnlineResponse	FootnoteInsert
	InsertFootnoteRequest	FootnoteResponse	Footnote FootnoteInsert
Update	UpdateFootnoteOnlineRequest	UpdateFootnoteOnlineResponse	FootnoteUpdate
	UpdateFootnoteRequest	FootnoteResponse	Footnote FootnoteUpdate

Footnote

Represents a dTO container with a footnote.

This class is inherited from FootnoteLink and used in FootnoteCollection, FootnoteResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.
Content	StoryChildNodes	Gets or sets the content of the footnote.
FootnoteType	FootnoteTypeEnum	Gets or sets the value, that specifies whether this is a footnote or endnote.
Position	DocumentPosition	Gets or sets the link to comment range start node.
ReferenceMark	string	Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used.
Text	string	Gets or sets text of the footnote.

FootnoteBase

Represents a footnote base class.

The following properties are defined:

Property	Type	Description
FootnoteType	FootnoteTypeEnum	Gets or sets the option, that specifies whether this is a footnote or endnote.
Position	DocumentPosition	Gets or sets the link to comment range start node.
ReferenceMark	string	Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used.
Text	string	Gets or sets text of the footnote.

FootnoteCollection

Represents a dTO container with a collection of footnotes.

This class is inherited from LinkElement and used in FootnotesResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
List	List<Footnote>	Gets or sets the collection of footnotes.

FootnoteInsert

Represents a footnote for insert.

This class is inherited from FootnoteBase and used in InsertFootnoteOnlineRequest, InsertFootnoteRequest.

The following properties are defined:

Property	Type	Description
FootnoteType	FootnoteTypeEnum	Gets or sets the option, that specifies whether this is a footnote or endnote.
Position	DocumentPosition	Gets or sets the link to comment range start node.
ReferenceMark	string	Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used.
Text	string	Gets or sets text of the footnote.

FootnoteLink

Represents a footnote link.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
NodeId	string	Gets or sets the node id.

FootnoteUpdate

Represents a footnote for update.

This class is inherited from FootnoteBase and used in UpdateFootnoteOnlineRequest, UpdateFootnoteRequest.

The following properties are defined:

Property	Type	Description
FootnoteType	FootnoteTypeEnum	Gets or sets the option, that specifies whether this is a footnote or endnote.
Position	DocumentPosition	Gets or sets the link to comment range start node.
ReferenceMark	string	Gets or sets the custom reference mark to be used for this footnote. Default value is Empty, meaning auto-numbered footnotes are used.
Text	string	Gets or sets text of the footnote.

DeleteFootnoteOnlineRequest

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

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

• DeleteFootnoteOnlineRequest()
• DeleteFootnoteOnlineRequest(Stream document, int index, string nodePath, 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.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
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.

DeleteFootnoteRequest

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

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

• DeleteFootnoteRequest()
• DeleteFootnoteRequest(string name, int index, string nodePath, 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.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
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.

FootnoteResponse

Represents a REST response with a footnote.

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

The following properties are defined:

Property	Type	Description
RequestId	string	Gets or sets the request Id.
Footnote	Footnote	Gets or sets the footnote.

FootnotesResponse

Represents a REST response with a collection of footnotes.

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.
Footnotes	FootnoteCollection	Gets or sets the collection of footnotes.

GetFootnoteOnlineRequest

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

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

• GetFootnoteOnlineRequest()
• GetFootnoteOnlineRequest(Stream document, int index, string nodePath, 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.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
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.

GetFootnoteRequest

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

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

• GetFootnoteRequest()
• GetFootnoteRequest(string name, int index, string nodePath, 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.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
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.

GetFootnotesOnlineRequest

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

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

• GetFootnotesOnlineRequest()
• GetFootnotesOnlineRequest(Stream document, string nodePath, 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.
nodePath	NodePath	string	The path to the node in the document tree.
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.

GetFootnotesRequest

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

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

• GetFootnotesRequest()
• GetFootnotesRequest(string name, string nodePath, 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.
nodePath	NodePath	string	The path to the node in the document tree.
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.

InsertFootnoteOnlineRequest

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

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

• InsertFootnoteOnlineRequest()
• InsertFootnoteOnlineRequest(Stream document, FootnoteInsert footnoteDto, string nodePath, 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.
footnoteDto	FootnoteDto	FootnoteInsert	Footnote data.
nodePath	NodePath	string	The path to the node in the document tree.
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.

InsertFootnoteOnlineResponse

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

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

• InsertFootnoteOnlineResponse(FootnoteResponse model, Dictionary<string,Stream> document)

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

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

InsertFootnoteRequest

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

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

• InsertFootnoteRequest()
• InsertFootnoteRequest(string name, FootnoteInsert footnoteDto, string nodePath, 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.
footnoteDto	FootnoteDto	FootnoteInsert	Footnote data.
nodePath	NodePath	string	The path to the node in the document tree.
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.

UpdateFootnoteOnlineRequest

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

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

• UpdateFootnoteOnlineRequest()
• UpdateFootnoteOnlineRequest(Stream document, FootnoteUpdate footnoteDto, int index, string nodePath, 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.
footnoteDto	FootnoteDto	FootnoteUpdate	Footnote data.
index	Index	int	Object index.
nodePath	NodePath	string	The path to the node in the document tree.
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.

UpdateFootnoteOnlineResponse

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

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

• UpdateFootnoteOnlineResponse(FootnoteResponse model, Dictionary<string,Stream> document)

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

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

UpdateFootnoteRequest

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

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

• UpdateFootnoteRequest()
• UpdateFootnoteRequest(string name, int index, FootnoteUpdate footnoteDto, string nodePath, 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.
index	Index	int	Object index.
footnoteDto	FootnoteDto	FootnoteUpdate	Footnote data.
nodePath	NodePath	string	The path to the node in the document tree.
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.

Footnote.FootnoteTypeEnum

The following values are defined: Footnote, Endnote.

FootnoteBase.FootnoteTypeEnum

The following values are defined: Footnote, Endnote.