HelpText Class
Associated Help Text.When the object is serialized out as xml, its qualified name is w:helpText.
Inheritance Hierarchy
System.Object
DocumentFormat.OpenXml.OpenXmlElement
DocumentFormat.OpenXml.OpenXmlLeafElement
DocumentFormat.OpenXml.Wordprocessing.HelpText
Namespace: DocumentFormat.OpenXml.Wordprocessing
Assembly: DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)
Syntax
'Declaration
Public Class HelpText _
Inherits OpenXmlLeafElement
'Usage
Dim instance As HelpText
public class HelpText : OpenXmlLeafElement
Remarks
[ISO/IEC 29500-1 1st Edition]
17.16.16 helpText (Associated Help Text)
This element specifies optional help text which shall be associated with the parent form field. The method or user interface by which this help text can be surfaced is not defined by ISO/IEC 29500.
If this element is omitted, then no help 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:helpText w:type="text" w:val="Example help text." /> <w:ddList> … </w:ddList> </w:ffData> </w:fldSimple>
The helpText element specifies the help text for the parent form field - in this case, literal help text consisting of the string Example help text.end example]
Parent Elements |
|---|
ffData (§17.16.17) |
Attributes |
Description |
|---|---|
type (Help Text Type) |
Specifies the type of help 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:helpText w:type="text" w:val="Example help text." /> </w:ffData> The type attribute has a value of text, which specifies that the text in the val attribute is the literal help 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 (Help Text Value) |
Specifies the help text for the current form field. Based on the value of the type attribute, the contents of this field shall be interpreted as follows:
[Example: Consider the following WordprocessingML fragment for a form field: <w:ffData> <w:helpText w:type="autoText" w:val="HelpText" /> </w:ffData> The text in the val attribute is the name of a glossary document entry containing the help 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_FFHelpTextVal simple type (§17.18.25). |
[Note: The W3C XML Schema definition of this element’s content model (CT_FFHelpText) 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.