DisplayBackgroundShape Class

Display Background Objects When Displaying Document.When the object is serialized out as xml, its qualified name is w:displayBackgroundShape.

Inheritance Hierarchy

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

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

Syntax

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

public class DisplayBackgroundShape : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

17.15.1.26 displayBackgroundShape (Display Background Objects When Displaying Document)

This element specifies whether the images and colors defined in the document's background using the background element (§17.2.1) shall be displayed when the document is displayed in print layout view as specified in the view element (§17.15.1.92).

If this element is omitted, then background shapes shall not be displayed when the document is displayed in print layout view.

[Example: Consider a WordprocessingML document that has a turquoise background specified for all pages and is being displayed in page layout view, as follows:

If the document's background should not be displayed, that requirement would be specified using the following WordprocessingML in the document settings:

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

The resulting document would display the background in page layout view:

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

DisplayBackgroundShape Members

DocumentFormat.OpenXml.Wordprocessing Namespace