DocPartGallery class

Office 2013 and later

Document Part Gallery Filter. When the object is serialized out as xml, its qualified name is w:docPartGallery.

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

public class DocPartGallery : StringType

[ISO/IEC 29500-1 1st Edition]

docPartGallery (Document Part Gallery Filter)

This element specifies the gallery 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 gallery is a classification of document parts, which might then be subdivided into categories. [Example: A gallery with a name of custom1 might have categories of Legal Clauses, Conformance Clauses, etc. end example]. The gallery which shall be used 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 its default gallery. If this element is present, but no document parts of the specified gallery are located by the application, then document parts in the default gallery hall be displayed (i.e. the application shall behave as if the value wasomitted).

[Example: Consider the following properties for a structured document tag:

<w:sdtPr>
  <w:docPartList>
    <w:docPartGallery w:val="custom1"/>
  </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 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.

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