Share via


Shading Class

Defines the Shading Class.When the object is serialized out as xml, its qualified name is w:shd.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.Shading

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

Syntax

'Declaration
Public Class Shading _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As Shading
public class Shading : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

17.3.1.31 shd (Paragraph Shading)

This element specifies the shading applied to the contents of the paragraph.

This shading consists of three components:

  • Background Color

  • (optional) Pattern

  • (optional) Pattern Color

The resulting shading is applied by setting the background color behind the paragraph, then applying the pattern color using the mask supplied by the pattern over that background.

If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e. that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then no paragraph shading shall be applied.

[Example: Consider a paragraph which must have a background consisting of a theme color accent3 with a theme color accent6 overlaid using a 20% fill pattern. This requirement is specified using the following WordprocessingML:

<w:pPr>
  <w:shd w:val="pct20" w:themeColor="accent6" w:themeFill="accent3" /> 
</w:pPr>

The resulting paragraph uses the background color accent3 under the foreground pattern color accent6 as specified by the pct20 pattern mask. end example]

Parent Elements

pPr (§17.3.1.26); pPr (§17.3.1.25); pPr (§17.7.5.2); pPr (§17.7.6.1); pPr (§17.9.23); pPr (§17.7.8.2)

This element’s content model is defined by the common shading properties definition in §17.3.5.

[ISO/IEC 29500-1 1st Edition]

17.3.2.32 shd (Run Shading)

Like paragraph shading, this element specifies the shading applied to the contents of the run.

This shading consists of three components:

  • Background Color

  • (optional) Pattern

  • (optional) Pattern Color

The resulting shading is applied by setting the background color behind the paragraph, then applying the pattern color using the mask supplied by the pattern over that background.

If this element is not present, the default value is to leave the formatting applied at previous level in the style hierarchy. If this element is never applied in the style hierarchy, then run shading shall not be applied to the contents of this run.

[Example: Consider a run which must have a background consisting of a theme color accent6 with a theme color text2 overlaid using a 20% fill pattern. This requirement is specified using the following WordprocessingML:

<w:pPr>
  <w:shd w:val="pct20" w:themeColor="text2" w:themeFill="accent6" /> 
</w:pPr>

The resulting run uses the background color accent6 under the foreground pattern color text2 as specified by the pct20 pattern mask. end example]

Parent Elements

rPr (§17.3.1.29); rPr (§17.3.1.30); rPr (§17.5.2.28); rPr (§17.9.25); rPr (§17.7.9.1); rPr (§17.7.5.4); rPr (§17.3.2.28); rPr (§17.5.2.27); rPr (§17.7.6.2); rPr (§17.3.2.27)

This element’s content model is defined by the common shading properties definition in §17.3.5.

[ISO/IEC 29500-1 1st Edition]

17.4.31 shd (Table Shading Exception)

This element specifies the shading which shall be applied to all cells in the current row as part of a set of table-level property exceptions. Similarly to paragraph shading, this shading shall be applied to the contents of the tab up to the table borders, regardless of the presence of text - unlike cell shading, table shading shall include any cell padding. This property shall be superseded by any cell-level shading on any cell in this row (§17.4.33).

This shading consists of three components:

  • Background Color

  • (optional) Pattern

  • (optional) Pattern Color

The resulting shading is applied by setting the background color behind the paragraph, then applying the pattern color using the mask supplied by the pattern over that background.

If this element is omitted, then the cell shading shall be determined by the table-level cell shading settings (§17.4.32) for the current table.

[Example: Consider a table in which the final two rows have a set of table-level property exceptions giving them theme color shading in the background2 theme color, as follows:

This table-level shading exception would be specified using the following WordprocessingML:

<w:tblPrEx>
  <w:jc w:val="left" /> 
  <w:shd w:val="clear" w:color="auto" w:fill="EEECE1" w:themeFill="background2" /> 
</w:tblPrEx>

The shd element specifies cell shading with a clear pattern using a background theme color of background2. end example]

Parent Elements

tblPrEx (§17.4.61); tblPrEx (§17.4.62)

This element’s content model is defined by the common shading properties definition in §17.3.5.

[ISO/IEC 29500-1 1st Edition]

17.4.32 shd (Table Shading)

This element specifies the shading which shall be applied to the extents the current table. Similarly to paragraph shading, this shading shall be applied to the contents of the tab up to the table borders, regardless of the presence of text - unlike cell shading, table shading shall include any cell padding. This property shall be superseded by any cell-level shading via any table-level property exceptions (§17.4.31); or on any cell in this row (§17.4.33).

This shading consists of three components:

  • Background Color

  • (optional) Pattern

  • (optional) Pattern Color

The resulting shading is applied by setting the background color behind the paragraph, then applying the pattern color using the mask supplied by the pattern over that background.

If this element is omitted, then the cells within this table shall have the shading specified by the associated table style. If no cell shading is specified in the style hierarchy, then the cells in this table shall not have any cell shading (i.e. they shall be transparent).

[Example: Consider a table in which the first cell in the first row has cell-level red shading, as follows:

R1C1

R1C2

R2C1

R2C2

This table level cell shading would be specified using the following WordprocessingML:

<w:tbl>
<w:tblPr>
<w:shd w:val="clear" w:color="auto" w:fill="FF0000"/>
…
</w:tblPr>
…
</w:tbl>

The shd element specifies cell shading with a clear pattern using a background color of FF0000 (red). end example]

Parent Elements

tblPr (§17.4.60); tblPr (§17.4.59); tblPr (§17.7.6.4); tblPr (§17.7.6.3)

This element’s content model is defined by the common shading properties definition in §17.3.5.

[ISO/IEC 29500-1 1st Edition]

17.4.33 shd (Table Cell Shading)

This element specifies the shading which shall be applied to the extents of the current table cell. Similarly to paragraph shading, this shading shall be applied to the contents of the cell up to the cell borders, regardless of the presence of text.

This shading consists of three components:

  • Background Color

  • (optional) Pattern

  • (optional) Pattern Color

The resulting shading is applied by setting the background color behind the paragraph, then applying the pattern color using the mask supplied by the pattern over that background.

If this element is omitted, then the cell shading shall be determined by the table-level or table-level exception cell shading settings (§17.4.31;§17.4.32) for the current table.

[Example: Consider a table in which the first cell in the first row has cell-level red shading, as follows:

R1C1

R1C2

R2C1

R2C2

This cell shading would be specified using the following WordprocessingML:

<w:tc>
<w:tcPr>
<w:shd w:val="clear" w:color="auto" w:fill="FF0000" />
</w:tcPr>
</w:tc>

The shd element specifies cell shading with a clear pattern using a background color of FF0000 (red). end example]

Parent Elements

tcPr (§17.7.6.8); tcPr (§17.7.6.9); tcPr (§17.4.70); tcPr (§17.4.71)

This element’s content model is defined by the common shading properties definition in §17.3.5.

© 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

Shading Members

DocumentFormat.OpenXml.Wordprocessing Namespace