HeaderFooter

	Request	Response	Model
Delete	DeleteHeaderFooterOnlineRequest	Dictionary
	DeleteHeaderFooterRequest	Task
	DeleteHeadersFootersOnlineRequest	Dictionary
	DeleteHeadersFootersRequest	Task
Get	GetHeaderFooterOfSectionOnlineRequest	HeaderFooterResponse	HeaderFooter
	GetHeaderFooterOfSectionRequest
	GetHeaderFooterOnlineRequest
	GetHeaderFooterRequest
	GetHeaderFootersOnlineRequest	HeaderFootersResponse	HeaderFooterLinkCollection
	GetHeaderFootersRequest
Insert	InsertHeaderFooterOnlineRequest	InsertHeaderFooterOnlineResponse
	InsertHeaderFooterRequest	HeaderFooterResponse	HeaderFooter

HeaderFooter

Represents a dTO container with a section element.

This class is inherited from HeaderFooterLink and used in HeaderFooterResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Type	TypeEnum	Gets or sets the paragraph’s text.
ChildNodes	List<NodeLink>	Gets or sets the child nodes.
DrawingObjects	LinkElement	Gets or sets the link to DrawingObjects resource.
Paragraphs	LinkElement	Gets or sets the link to Paragraphs resource.

HeaderFooterLink

Represents a headerFooter link element.

This class is inherited from LinkElement and used in HeaderFooterLinkCollection.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
Type	TypeEnum	Gets or sets the paragraph’s text.

HeaderFooterLinkCollection

Represents a collection of HeaderFooter’s links.

This class is inherited from LinkElement and used in HeaderFootersResponse.

The following properties are defined:

Property	Type	Description
Link	WordsApiLink	Gets or sets the link to the document.
List	List<HeaderFooterLink>	Gets or sets the collection of HeaderFooter’s links.

DeleteHeaderFooterOnlineRequest

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

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

• DeleteHeaderFooterOnlineRequest()
• DeleteHeaderFooterOnlineRequest(Stream document, string sectionPath, int index, 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.
sectionPath	SectionPath	string	The path to the section in the document tree.
index	Index	int	Object index.
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.

DeleteHeaderFooterRequest

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

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

• DeleteHeaderFooterRequest()
• DeleteHeaderFooterRequest(string name, string sectionPath, int index, 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.
sectionPath	SectionPath	string	The path to the section in the document tree.
index	Index	int	Object index.
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.

DeleteHeadersFootersOnlineRequest

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

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

• DeleteHeadersFootersOnlineRequest()
• DeleteHeadersFootersOnlineRequest(Stream document, string sectionPath, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, string headersFootersTypes)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
sectionPath	SectionPath	string	The path to the section 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.
headersFootersTypes	HeadersFootersTypes	string	The list of HeaderFooter types.

DeleteHeadersFootersRequest

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

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

• DeleteHeadersFootersRequest()
• DeleteHeadersFootersRequest(string name, string sectionPath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string destFileName, string revisionAuthor, string revisionDateTime, string headersFootersTypes)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
sectionPath	SectionPath	string	The path to the section 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.
headersFootersTypes	HeadersFootersTypes	string	The list of HeaderFooter types.

GetHeaderFooterOfSectionOnlineRequest

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

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

• GetHeaderFooterOfSectionOnlineRequest()
• GetHeaderFooterOfSectionOnlineRequest(Stream document, int headerFooterIndex, int sectionIndex, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
headerFooterIndex	HeaderFooterIndex	int	The index of the HeaderFooter object.
sectionIndex	SectionIndex	int	The index of the section.
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.
filterByType	FilterByType	string	The list of HeaderFooter types.

GetHeaderFooterOfSectionRequest

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

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

• GetHeaderFooterOfSectionRequest()
• GetHeaderFooterOfSectionRequest(string name, int headerFooterIndex, int sectionIndex, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
headerFooterIndex	HeaderFooterIndex	int	The index of the HeaderFooter object.
sectionIndex	SectionIndex	int	The index of the section.
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.
filterByType	FilterByType	string	The list of HeaderFooter types.

GetHeaderFooterOnlineRequest

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

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

• GetHeaderFooterOnlineRequest()
• GetHeaderFooterOnlineRequest(Stream document, int headerFooterIndex, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
headerFooterIndex	HeaderFooterIndex	int	The index of the HeaderFooter object.
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.
filterByType	FilterByType	string	The list of HeaderFooter types.

GetHeaderFooterRequest

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

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

• GetHeaderFooterRequest()
• GetHeaderFooterRequest(string name, int headerFooterIndex, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
headerFooterIndex	HeaderFooterIndex	int	The index of the HeaderFooter object.
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.
filterByType	FilterByType	string	The list of HeaderFooter types.

GetHeaderFootersOnlineRequest

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

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

• GetHeaderFootersOnlineRequest()
• GetHeaderFootersOnlineRequest(Stream document, string sectionPath, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
document	Document	Stream	The document.
sectionPath	SectionPath	string	The path to the section 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.
filterByType	FilterByType	string	The list of HeaderFooter types.

GetHeaderFootersRequest

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

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

• GetHeaderFootersRequest()
• GetHeaderFootersRequest(string name, string sectionPath, string folder, string storage, string loadEncoding, string password, string encryptedPassword, string filterByType)

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

Argument	Property	Type	Description
name	Name	string	The filename of the input document.
sectionPath	SectionPath	string	The path to the section 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.
filterByType	FilterByType	string	The list of HeaderFooter types.

HeaderFooterResponse

Represents a REST response with a HeaderFooter.

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

The following properties are defined:

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

HeaderFootersResponse

Represents a REST response with a collection of HeaderFooter elements.

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.
HeaderFooters	HeaderFooterLinkCollection	Gets or sets the collection of HeaderFooter elements.

InsertHeaderFooterOnlineRequest

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

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

• InsertHeaderFooterOnlineRequest()
• InsertHeaderFooterOnlineRequest(Stream document, string sectionPath, string headerFooterType, 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.
sectionPath	SectionPath	string	The path to the section in the document tree.
headerFooterType	HeaderFooterType	string	Type of header/footer.
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.

InsertHeaderFooterOnlineResponse

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

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

• InsertHeaderFooterOnlineResponse(HeaderFooterResponse model, Dictionary<string,Stream> document)

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

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

InsertHeaderFooterRequest

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

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

• InsertHeaderFooterRequest()
• InsertHeaderFooterRequest(string name, string sectionPath, string headerFooterType, 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.
sectionPath	SectionPath	string	The path to the section in the document tree.
headerFooterType	HeaderFooterType	string	Type of header/footer.
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.

HeaderFooterLink.TypeEnum

The following values are defined: HeaderEven, HeaderPrimary, FooterEven, FooterPrimary, HeaderFirst, FooterFirst.