Share via


ListEntryFormField Class

Drop-Down List Entry.When the object is serialized out as xml, its qualified name is w:listEntry.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.String255Type
        DocumentFormat.OpenXml.Wordprocessing.ListEntryFormField

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

Syntax

'Declaration
Public Class ListEntryFormField _
    Inherits String255Type
'Usage
Dim instance As ListEntryFormField
public class ListEntryFormField : String255Type

Remarks

[ISO/IEC 29500-1 1st Edition]

17.16.20 listEntry (Drop-Down List Entry)

This element specifies the presence of a single drop-down list entry within the parent drop-down list form field in the document. The order of appearance of the series of listEntry elements in the WordprocessingML markup shall dictate the order of the entries in the drop-down list when it is displayed.

[Example: Consider the following WordprocessingML fragment for the properties of a drop-down list form field:

<w:ffData>
<w:ddList>
<w:listEntry w:val="One" />
<w:listEntry w:val="Two" />
<w:listEntry w:val="Three" />
</w:ddList>
</w:ffData>

The three listEntry elements each specify one drop-down list entry for the parent drop-down list form field. In this case, these properties specify that the drop-down list must contain three entries of One, Two, and Three in that order when displayed. end example]

Parent Elements

ddList (§17.16.9)

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.

See Also

Reference

ListEntryFormField Members

DocumentFormat.OpenXml.Wordprocessing Namespace