DrawingHeaderFooter Class

  • Article

Defines the DrawingHeaderFooter Class.This class is only available in Office2010.When the object is serialized out as xml, its qualified name is x:drawingHF.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Spreadsheet.DrawingHeaderFooter

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

Syntax

'Declaration
<OfficeAvailabilityAttribute(FileFormatVersions.Office2010)> _
Public Class DrawingHeaderFooter _
    Inherits OpenXmlLeafElement
'Usage
Dim instance As DrawingHeaderFooter

[OfficeAvailabilityAttribute(FileFormatVersions.Office2010)]
public class DrawingHeaderFooter : OpenXmlLeafElement

Remarks

[ISO/IEC 29500-1 1st Edition]

18.3.1.37 drawingHF (Drawing Reference in Header Footer)

This element specifies the usage of drawing objects rendered in the header / footer of the sheet. It specifies an explicit relationship to the part containing the DrawingML shapes used in the header / footer. It also indicates where in the header / footer each shape belongs. One drawing object can appear in each of the left side, center and right side of the header and footer.

[Example: This example shows a worksheet with graphics in the header. The DrawingML part referred to by rId2 contains at least two objects. The object with ID 6 is shown in the left side of the header on the first page only. The object with ID 7 is shown in the left side of the header for the other pages.

<worksheet … >
  …
  <headerFooter differentFirst="1" … >
    …
  </headerFooter>
  <drawingHF r:id="rId2" lho="7" lhf="6"/>
</worksheet>

end example]

Parent Elements

chartsheet (§18.3.1.12); dialogsheet (§18.3.1.34); worksheet (§18.3.1.99)

Attributes

Description

cfe (Center Footer for Even Pages)

Specifies the DrawingML shape to be used for the center of the footer on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … cfe="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

cff (Center Footer for First Page)

Specifies the DrawingML shape to be used for the center of the footer on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … cff="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

cfo (Center Footer for Odd Pages)

Specifies the DrawingML shape to be used for the center of the footer on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the center of the footer on both odd and even pages.

[Example:

<drawingHF … cfo="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

che (Center Header for Even Pages)

Specifies the DrawingML shape to be used for the center of the header on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … che="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

chf (Center Header for First Page)

Specifies the DrawingML shape to be used for the center of the header on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … chf="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

cho (Center Header for Odd Pages)

Specifies the DrawingML shape to be used for the center of the header on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the center of the header on both odd and even pages.

[Example:

<drawingHF … cho="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

id (Relationship ID for Embedded Control Properties)

Namespace: .../officeDocument/2006/relationships

Specifies the relationship ID for the relationship to the DrawingML part that contains the drawing objects used in the header and footer. This DrawingML part is a separate part within the package.

[Example:

<drawingHF r:id="rId2" lho="7" lhf="6"/>

The id attribute in the relationship reference namespace specifies that the relationship with relationship ID rId5 must contain the drawing objects used in the header and footer. end example]

The possible values for this attribute are defined by the ST_RelationshipId simple type (§22.8.2.1).

lfe (Left Footer for Even Pages)

Specifies the DrawingML shape to be used for the left side of the footer on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … lfe="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

lff (Left Footer for First Page)

Specifies the DrawingML shape to be used for the left side of the footer on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … lff="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

lfo (Left Footer for Odd Pages)

Specifies the DrawingML shape to be used for the left side of the footer on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the left side of the footer on both odd and even pages.

[Example:

<drawingHF … lfo="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

lhe (Left Header for Even Pages)

Specifies the DrawingML shape to be used for the left side of the header on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … lhe="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

lhf (Left Header for First Page)

Specifies the DrawingML shape to be used for the left side of the header on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … lhf="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

lho (Left Header for Odd Pages)

Specifies the DrawingML shape to be used for the left side of the header on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the left side of the header on both odd and even pages.

[Example:

<drawingHF … lho="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rfe (Right Footer for Even Pages)

Specifies the DrawingML shape to be used for the right side of the footer on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … rfe="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rff (Right Footer for First Page)

Specifies the DrawingML shape to be used for the right side of the footer on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … rff="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rfo (Right Footer for Odd Pages)

Specifies the DrawingML shape to be used for the right side of the footer on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the right side of the footer on both odd and even pages.

[Example:

<drawingHF … rfo="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rhe (Right Header for Even Pages)

Specifies the DrawingML shape to be used for the right side of the header on even pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … rhe="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rhf (Right Header for First Page)

Specifies the DrawingML shape to be used for the right side of the header on the first page if the differentFirst attribute of the corresponding headerFooter element (§18.3.1.46) is true.

[Example:

<drawingHF … rhf="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

rho (Right Header for Odd Pages)

Specifies the DrawingML shape to be used for the right side of the header on odd pages if the differentOddEven attribute of the corresponding headerFooter element (§18.3.1.46) is true. If the differentOddEven attribute is false, this attribute specifies the DrawingML shape to be used for the right side of the header on both odd and even pages.

[Example:

<drawingHF … rho="5"/>

end example]

The possible values for this attribute are defined by the W3C XML Schema unsignedInt datatype.

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

DrawingHeaderFooter Members

DocumentFormat.OpenXml.Spreadsheet Namespace