DocPartCategory Class
Document Part Category Filter.When the object is serialized out as xml, its qualified name is w:docPartCategory.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.StringType
DocumentFormat.OpenXml.Wordprocessing.DocPartCategory
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class DocPartCategory _
Inherits StringType
'Usage
Dim instance As DocPartCategory
public class DocPartCategory : StringType
Remarks
[ISO/IEC 29500-1 1st Edition]
17.5.2.10 docPartCategory (Document Part Category Filter)
This element specifies the category of document parts which shall be used as the filter when determining the possible choices of document parts which are displayed for insertion into the parent structured document tag. A document part category is a sub-classification within a given document part gallery which can be used to further categorize the parts in a given gallery. [Example: Gallery custom1 might have categories of Legal Clauses, Conformance Clauses, etc. end example]. The category which shall be used as a filter is stored in this element's val attribute.
If this element is omitted, then the parent structured document tag shall display all document parts in the specified gallery regardless their specified category. If this element is present, but no document parts of the specified gallery and category combination are located by the application, then no document parts shall be displayed (i.e. the application shall not fall back to showing document parts in all categories in the specified gallery).
[Example: Consider the following properties for a structured document tag:
<w:sdtPr> <w:docPartList> <w:docPartGallery w:val="custom1"/> <w:docPartCategory w:val="Legal Clauses"/> </w:docPartList> </w:sdtPr>
This structured document tag specifies that it must present a selection of document parts for insertion via the docPartList element (§17.5.2.12) , and those document parts must only be the parts which are in the custom1 gallery via the docPartType element (§17.5.2.11), and within that gallery, only the document parts which are in a category called Legal Clauses via this element. end example]
Parent Elements |
|---|
docPartList (§17.5.2.12); docPartObj (§17.5.2.13) |
Attributes |
Description |
|---|---|
val (String Value) |
Specifies that its contents contain a string. The contents of this string are interpreted based on the context of the parent XML element. [Example: Consider the following WordprocessingML fragment: <w:pPr> <w:pStyle w:val="heading1" /> </w:pPr> The value of the val attribute is the ID of the associated paragraph style's styleId. However, consider the following fragment: <w:sdtPr> <w:alias w:val="SDT Title Example" /> … </w:sdtPr> In this case, the decimal number in the val attribute is the caption of the parent structured document tag. In each case, the value is interpreted in the context of the parent element. end example] The possible values for this attribute are defined by the ST_String simple type (§22.9.2.13). |
[Note: The W3C XML Schema definition of this element’s content model (CT_String) is located in §A.1. end note]
© 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.