DocumentStatistics

	Request	Response	Model
Get	GetDocumentStatisticsOnlineRequest	StatDataResponse	DocumentStatData FileLink
	GetDocumentStatisticsRequest

DocumentStatData

Represents a container for the document’s statistical data.

This class is used in StatDataResponse.

The following properties are defined:

Property	Type	Description
FootnotesStatData	FootnotesStatData	Gets or sets the detailed statistics on footnotes.
PageCount	int	Gets or sets the total count of pages in the document.
PageStatData	List<PageStatData>	Gets or sets the detailed statistics on all pages.
ParagraphCount	int	Gets or sets the total count of paragraphs in the document.
WordCount	int	Gets or sets the total count of words in the document.

FootnotesStatData

Represents a container for the footnotes statistical data.

This class is used in DocumentStatData, PageStatData.

The following properties are defined:

Property	Type	Description
ParagraphCount	int	Gets or sets the total count of paragraphs in footnotes.
WordCount	int	Gets or sets the total count of words in footnotes.

PageStatData

Represents a container for the page’s statistical data.

This class is used in DocumentStatData.

The following properties are defined:

Property	Type	Description
FootnotesStatData	FootnotesStatData	Gets or sets the detailed statistics on the footnotes.
PageNumber	int	Gets or sets the page number.
ParagraphCount	int	Gets or sets the total count of paragraphs in the page.
WordCount	int	Gets or sets the total count of words in the page.

StatDataResponse

Represents a REST response with document’s statistical data.

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.
DocumentLink	FileLink	Gets or sets the link to the document.
StatData	DocumentStatData	Gets or sets the statistical data of the document.

GetDocumentStatisticsOnlineRequest

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

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

• GetDocumentStatisticsOnlineRequest()
• GetDocumentStatisticsOnlineRequest(Stream document, string loadEncoding, string password, string encryptedPassword, bool? includeComments, bool? includeFootnotes, bool? includeTextInShapes)

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.
includeComments	IncludeComments	bool?	The flag indicating whether to include comments from the WordCount. The default value is “false”.
includeFootnotes	IncludeFootnotes	bool?	The flag indicating whether to include footnotes from the WordCount. The default value is “false”.
includeTextInShapes	IncludeTextInShapes	bool?	The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.

GetDocumentStatisticsRequest

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

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

• GetDocumentStatisticsRequest()
• GetDocumentStatisticsRequest(string name, string folder, string storage, string loadEncoding, string password, string encryptedPassword, bool? includeComments, bool? includeFootnotes, bool? includeTextInShapes)

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.
includeComments	IncludeComments	bool?	The flag indicating whether to include comments from the WordCount. The default value is “false”.
includeFootnotes	IncludeFootnotes	bool?	The flag indicating whether to include footnotes from the WordCount. The default value is “false”.
includeTextInShapes	IncludeTextInShapes	bool?	The flag indicating whether to include shape’s text from the WordCount. The default value is “false”.