BackgroundProperties class

Office 2013 and later

Defines the BackgroundProperties Class.This class is only available in Office2013. When the object is serialized out as xml, its qualified name is a15:backgroundPr.

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Office2013.Drawing.BackgroundProperties

Namespace:  DocumentFormat.OpenXml.Office2013.Drawing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

C#
VB
C++
Copy
No code example is currently available or this language may not be supported.

2.3.48 backgroundPr

Target namespace: http://schemas.microsoft.com/office/drawing/2012/main

A CT_BackgroundPr element<107> that specifies the properties of the background of the document.

An extension list child element of:CT_NonVisualDrawingProps(cNvPr) as specified in [ISO/IEC-29500-1] section 19.3.1.12.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this element.

<xsd:element name="backgroundPr" type="CT_BackgroundPr"/>

See section 5.14 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

2.5.86 CT_BackgroundPr

Target namespace: http://schemas.microsoft.com/office/drawing/2012/main

Referenced by: backgroundPr

This complex type describes the visual properties of the background of a WordprocessingML document.<147>

Attributes:

bwMode: An ST_BlackWhiteMode ([ISO/IEC-29500-1] section 20.1.10.10) attribute that specifies in what types of colors the background should be rendered.

bwPure: An ST_BlackWhiteMode ([ISO/IEC-29500-1] section 20.1.10.10) attribute that specifies how the background should be rendered using pure black and white color.

This is subordinate to bwMode. If bwmMode is "auto" then the value for bwNormal or bwPure is used depending on what the output format is. An application may define for itself what, if any, difference there is between normal black and white and pure black and white.

bwNormal: An ST_BlackWhiteMode ([ISO/IEC-29500-1] section 20.1.10.10) attribute that specifies how the background should be rendered using normal black and white color.

This is subordinate to bwMode. If bwMode is set to "auto" then the value for bwNormal or bwPure is used depending on what the output format is. An application may define for itself what, if any, difference there is between normal black and white and pure black and white.

targetScreenSize: An ST_TargetScreenSz attribute that specifies the target resolution used for documents with a gradient or picture-filled background.

The following W3C XML Schema ([XMLSCHEMA1] section 2.1) fragment specifies the contents of this complex type.

<xsd:complexType name="CT_BackgroundPr">

<xsd:attribute name="bwMode" type="a:ST_BlackWhiteMode"/>

<xsd:attribute name="bwPure" type="a:ST_BlackWhiteMode"/>

<xsd:attribute name="bwNormal" type="a:ST_BlackWhiteMode"/>

<xsd:attribute name="targetScreenSize" type="ST_TargetScreenSz"/>

</xsd:complexType>

See section 5.14 for the full W3C XML Schema ([XMLSCHEMA1] section 2.1).

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: