StatusText Class

  • Article

Associated Status Text.When the object is serialized out as xml, its qualified name is w:statusText.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.StatusText

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

Syntax

'Declaration
Public Class StatusText _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As StatusText

public class StatusText : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.16.26 statusText (Associated Status Text)

This element specifies optional status text which shall be associated with the parent form field. The method or user interface by which this status text can be surfaced is not defined by ISO/IEC 29500.

If this element is omitted, then no status text shall be associated with the current form field.

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

<w:fldSimple w:instr="FORMDROPDOWN">
<w:ffData>
<w:statusText w:type="text" w:val="Example status text." />
<w:ddList>
…
</w:ddList>
</w:ffData>
</w:fldSimple>

The statusText element specifies the status text for the parent form field - in this case, literal text consisting of the string Example status text.end example]

Parent Elements

ffData (§17.16.17)

Attributes

Description

type (Status Text Type)

Specifies the type of status text which is specified by this element, defined by the simple type below.

If this attribute is omitted, then its value shall be assumed to be text.

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

<w:ffData>
<w:statusText w:type="text" w:val="Example status text." />
</w:ffData>

The type attribute has a value of text, which specifies that the text in the val attribute is the literal status text for this form field. end example]

The possible values for this attribute are defined by the ST_InfoTextType simple type (§17.18.43).

val (Status Text Value)

Specifies the status text for the current form field. Based on the value of the type attribute, the contents of this field shall be interpreted as follows:

  • When the type attribute value is text, contains the literal status text for the form field.

  • When the type attribute value is autoText, contains the name of a glossary document entry which contains the status text for the form field.

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

<w:ffData>
<w:statusText w:type="autoText" w:val="MyStatusText" />
</w:ffData>

The text in the val attribute is the name of a glossary document entry containing the status text for this form field, since the type attribute has a value of autoText. end example]

The possible values for this attribute are defined by the ST_FFStatusTextVal simple type (§17.18.27).

[Note: The W3C XML Schema definition of this element’s content model (CT_FFStatusText) 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

StatusText Members

DocumentFormat.OpenXml.Wordprocessing Namespace