DoNotIncludeSubdocsInStats Class

Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics.When the object is serialized out as xml, its qualified name is w:doNotIncludeSubdocsInStats.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.DoNotIncludeSubdocsInStats

Namespace:  DocumentFormat.OpenXml.Wordprocessing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
Public Class DoNotIncludeSubdocsInStats _
    Inherits OnOffType
'Usage
Dim instance As DoNotIncludeSubdocsInStats
public class DoNotIncludeSubdocsInStats : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.38 doNotIncludeSubdocsInStats (Do Not Include Content in Text Boxes, Footnotes, and Endnotes in Document Statistics)

This element specifies if document content contained in text boxes, footnotes, and endnotes shall be excluded when an application calculates a given document’s statistics when these values are calculated and/or displayed by an application.

[Note: Some examples of document statistics that an application might chose to calculate are: number of words, number of characters, number of paragraphs, number of pages, number of lines, and so on. end note]

[Example: Consider a WordprocessingML that specifies that it must not include these document stories when its contents are used to calculate document statistics. This requirement would be specified using the following WordprocessingML in the document settings part:

<w:doNotIncludeSubdocsInStats w:val="true"/> 

The doNotIncludeSubdocsInStats element's val attribute has a value of true specifying that only the contents of the main document story should be used when calculating document statistics. end example]

Parent Elements

settings (§17.15.1.78)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© ISO/IEC29500: 2008.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

DoNotIncludeSubdocsInStats Members

DocumentFormat.OpenXml.Wordprocessing Namespace