DefaultTextBoxFormFieldString class

Office 2013 and later

Default Text Box Form Field String. When the object is serialized out as xml, its qualified name is w:default.

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

public class DefaultTextBoxFormFieldString : String255Type

[ISO/IEC 29500-1 1st Edition]

default (Default Text Box Form Field String)

This element specifies the default string for the parent text box form field. This string is the content which shall be displayed in the document story within this form field if its current run contents are empty (i.e. there is not actual content within the text box). If the type (§17.16.34) of the current form field is calculation, then this string shall hold the calculation to be performed.

If this element is omitted, then the current text box form field shall not have a default value.

[Example: Consider the following WordprocessingML fragment for a text box form field:

<w:fldChar w:fldCharType="begin">
  <w:ffData>
    <w:textInput>
      <w:default w:val="No content."/>
    </w:textInput>
  </w:ffData>
</w:fldChar>

The default element specifies the default value of the text box form field to be No content.Since the form field does not contain any value, this is the content which must be displayed when the contents of the form field are displayed by an application. end example]

Parent Elements

textInput (§17.16.33)

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: