Share via


EvenHeader Class

Even Page Header.When the object is serialized out as xml, its qualified name is x:evenHeader.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.OpenXmlLeafTextElement
        DocumentFormat.OpenXml.Spreadsheet.XstringType
          DocumentFormat.OpenXml.Spreadsheet.EvenHeader

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

Syntax

'Declaration
Public Class EvenHeader _
    Inherits XstringType
'Usage
Dim instance As EvenHeader
public class EvenHeader : XstringType

Remarks

[ISO/IEC 29500-1 1st Edition]

18.3.1.39 evenHeader (Even Page Header)

Even page header value. Corresponds to even printed pages. [Example: Even page(s) in the sheet can not be printed if the print area is specified to be a range such that it falls outside an even page's scope. end example]

If no even header is specified, then odd header value is assumed for even page headers.

Header/Footer Formatting Syntax

There are a number of formatting codes that can be written inline with the actual header / footer text, which affect the formatting in the header or footer.

[Example:

This example shows the text "Center Bold Header" on the first line (center section), and the date on the second line (center section).

<headerFooter>
<oddHeader>&amp;CCenter &amp;"-,Bold"Bold
&amp;"-,Regular"Header_x000A_&amp;D</oddHeader>
</headerFooter>

end example]

General Rules:

There is no required order in which these codes need to appear.

The first occurrence of the following codes turns the formatting ON, the second occurrence turns it OFF again:

  • strikethrough

  • superscript

  • subscript

Superscript and subscript cannot both be ON at same time. Whichever comes first wins and the other is ignored, while the first is ON.

&L - code for "left section" (there are three header / footer locations, "left", "center", and "right"). When two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the order of appearance, and placed into the left section.

&P - code for "current page #"

&N - code for "total pages"

&font size - code for "text font size", where font size is a font size in points.

&K - code for "text font color"

RGB Color is specified as RRGGBB

Theme Color is specified as TTSNN where TT is the theme color Id, S is either "+" or "-" of the tint/shade value, NN is the tint/shade value.

&S - code for "text strikethrough" on / off

&X - code for "text super script" on / off

&Y - code for "text subscript" on / off

&C - code for "center section". When two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the order of appearance, and placed into the center section.

&D - code for "date"

&T - code for "time"

&G - code for "picture as background"

&U - code for "text single underline"

&E - code for "double underline"

&R - code for "right section". When two or more occurrences of this section marker exist, the contents from all markers are concatenated, in the order of appearance, and placed into the right section.

&Z - code for "this workbook's file path"

&F - code for "this workbook's file name"

&A - code for "sheet tab name"

&+ - code for add to page #.

&- - code for subtract from page #.

&"font name,font type" - code for "text font name" and "text font type", where font name and font type are strings specifying the name and type of the font, separated by a comma. When a hyphen appears in font name, it means "none specified". Both of font name and font type can be localized values.

&"-,Bold" - code for "bold font style"

&B - also means "bold font style".

&"-,Regular" - code for "regular font style"

&"-,Italic" - code for "italic font style"

&I - also means "italic font style"

&"-,Bold Italic" code for "bold italic font style"

&O - code for "outline style"

&H - code for "shadow style"

The possible values for this element are defined by the ST_Xstring simple type (§22.9.2.19).

Parent Elements

headerFooter (§18.3.1.46)

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

EvenHeader Members

DocumentFormat.OpenXml.Spreadsheet Namespace