AlwaysShowPlaceholderText Class

Use Custom XML Element Names as Default Placeholder Text.When the object is serialized out as xml, its qualified name is w:alwaysShowPlaceholderText.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.AlwaysShowPlaceholderText

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

Syntax

'Declaration
Public Class AlwaysShowPlaceholderText _
    Inherits OnOffType
'Usage
Dim instance As AlwaysShowPlaceholderText

public class AlwaysShowPlaceholderText : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.4 alwaysShowPlaceholderText (Use Custom XML Element Names as Default Placeholder Text)

This element specifies that each custom XML element specified using the customXml element within this document shall always show some form of in-document placeholder text presentation when it contains no run content. If the placeholder element (§17.5.2.25) is present in the custom XML element's properties, then this is the placeholder text displayed and this effect has no effect. If the placeholder element is omitted, then the application shall use the name of the element to generate default placeholder text in its place.

If this element is omitted, then custom XML markup which does not contain a placeholder element within its properties shall not display any placeholder text.

[Example: Consider the following WordprocessingML fragment from the document settings:

<w:alwaysShowPlaceholderText w:val="true" />

The alwaysShowPlaceholderText element has a value of true, which specifies that placeholder text must be generated using the element's name if no placeholder text is present. If two custom XML elements are defined as follows:

<w:customXml w:name="spec" … >
<w:customXmlPr>
<w:placeholder w:val="Type the name of the specification." />
</w:customXmlPr>
</w:customXml>
…
<w:customXml w:name="spec" … >
</w:customXml>

The first custom XML element has placeholder text, and the second doesn't, so if this element is omitted, these two elements might be displayed as follows:

Notice that the second custom XML element has no placeholder text, and therefore is not displayed. However, when this element is present, then the application should generate default placeholder text in its place:

The application generated default placeholder text from the element name, resulting in a value of [spec] in the document. end example]

Parent Elements
settings (§17.15.1.78)

This element’s content model is defined by the common boolean property definition in §17.17.4.

© 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

AlwaysShowPlaceholderText Members

DocumentFormat.OpenXml.Wordprocessing Namespace