Show / Hide Table of Contents

Class ExcelHeaderFooterTextItem

An ExcelHeaderFooterTextItem object used for the ExcelHeaderFooterTextCollection

Inheritance
object
ExcelHeaderFooterTextItem
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: OfficeOpenXml.Style.HeaderFooterTextFormat
Assembly: EPPlus.dll
Syntax
public class ExcelHeaderFooterTextItem

Constructors

ExcelHeaderFooterTextItem()

Creates an empty ExcelHeaderFooterTextItem object.

Declaration
public ExcelHeaderFooterTextItem()

ExcelHeaderFooterTextItem(string)

Creates an ExcelHeaderFooterTextItem object with a text.

Declaration
public ExcelHeaderFooterTextItem(string text)
Parameters
Type Name Description
string text

The objects text

Fields

FormatCode

The text format code. Used for inserting dates, page numbers and more.

Declaration
public ExcelHeaderFooterFormattingCodes FormatCode
Field Value
Type Description
ExcelHeaderFooterFormattingCodes

PageNumberSuffix

Suffix for page number.

Declaration
public string PageNumberSuffix
Field Value
Type Description
string

Properties

Bold

If text is bold.

Declaration
public bool Bold { get; set; }
Property Value
Type Description
bool

Color

Color of text.

Declaration
public Color Color { get; set; }
Property Value
Type Description
Color

DoubleUnderline

If text is double underlined.

Declaration
public bool DoubleUnderline { get; set; }
Property Value
Type Description
bool

FontName

The text font name.

Declaration
public string FontName { get; set; }
Property Value
Type Description
string

FontSize

The text size.

Declaration
public int? FontSize { get; set; }
Property Value
Type Description
int?

Italic

If text is italic.

Declaration
public bool Italic { get; set; }
Property Value
Type Description
bool

Outline

If text is outlined.

Declaration
public bool Outline { get; set; }
Property Value
Type Description
bool

Shadow

If text has a shadow.

Declaration
public bool Shadow { get; set; }
Property Value
Type Description
bool

Striketrough

If text has a strikethrough.

Declaration
public bool Striketrough { get; set; }
Property Value
Type Description
bool

SubScript

If text is subscript.

Declaration
public bool SubScript { get; set; }
Property Value
Type Description
bool

SuperScript

If text is superscript.

Declaration
public bool SuperScript { get; set; }
Property Value
Type Description
bool

Text

The text.

Declaration
public string Text { get; set; }
Property Value
Type Description
string

Theme

The text theme.

Declaration
public eThemeSchemeColor? Theme { get; set; }
Property Value
Type Description
eThemeSchemeColor?

Tint

Tint of the text theme.

Declaration
public double? Tint { get; set; }
Property Value
Type Description
double?

Underline

If text is underlined.

Declaration
public bool Underline { get; set; }
Property Value
Type Description
bool

Methods

GetThemeOrColorAsString()

Get the theme or color as a string in format &KTTSNNN for theme and &KRRGGBB for color.

Declaration
public string GetThemeOrColorAsString()
Returns
Type Description
string
In this article
Back to top Generated by DocFX