Background Class

Background Formatting.When the object is serialized out as xml, its qualified name is dgm:bg.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.Diagrams.Background

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

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(EffectDag))> _
<ChildElementInfoAttribute(GetType(GroupFill))> _
<ChildElementInfoAttribute(GetType(NoFill))> _
<ChildElementInfoAttribute(GetType(SolidFill))> _
<ChildElementInfoAttribute(GetType(GradientFill))> _
<ChildElementInfoAttribute(GetType(BlipFill))> _
<ChildElementInfoAttribute(GetType(PatternFill))> _
<ChildElementInfoAttribute(GetType(EffectList))> _
Public Class Background _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Background

[ChildElementInfoAttribute(typeof(EffectDag))]
[ChildElementInfoAttribute(typeof(GroupFill))]
[ChildElementInfoAttribute(typeof(NoFill))]
[ChildElementInfoAttribute(typeof(SolidFill))]
[ChildElementInfoAttribute(typeof(GradientFill))]
[ChildElementInfoAttribute(typeof(BlipFill))]
[ChildElementInfoAttribute(typeof(PatternFill))]
[ChildElementInfoAttribute(typeof(EffectList))]
public class Background : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

• DocumentFormat.OpenXml.Drawing.NoFill <a:noFill>

• DocumentFormat.OpenXml.Drawing.SolidFill <a:solidFill>

• DocumentFormat.OpenXml.Drawing.GradientFill <a:gradFill>

• DocumentFormat.OpenXml.Drawing.BlipFill <a:blipFill>

• DocumentFormat.OpenXml.Drawing.PatternFill <a:pattFill>

• DocumentFormat.OpenXml.Drawing.GroupFill <a:grpFill>

• DocumentFormat.OpenXml.Drawing.EffectList <a:effectLst>

• DocumentFormat.OpenXml.Drawing.EffectDag <a:effectDag>

[ISO/IEC 29500-1 1st Edition]

21.4.3.1 bg (Background Formatting)

This element defines formatting that can be applied to the background shape of the entire diagram. The background shape can hold formatting options just as a normal shape can hold within DrawingML.

[Example: Consider the following example of a bg in DiagramML:

<bg>
     <solidFill>
          <schemeClr val="tx1"/>
     </solidFill>
     <effectLst>
          <glow rad="152400">
               <schemeClr val="accent1">
                    <alpha val="75000"/>
               </schemeClr>
          </glow>
     </effectLst>
</bg>

In this example we see a solid fill applied to the background of the diagram along with a glow. end example]

[Note: The W3C XML Schema definition of this element’s content model (CT_BackgroundFormatting) is located in §A.4.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

Background Members

DocumentFormat.OpenXml.Drawing.Diagrams Namespace