Namespace EasyXLS

Class ExcelFooter

System.Object

EasyXLS.ExcelFooter

public class ExcelFooter
extends System.Object

This class stores the footer information extends text, position (left, center, or right), font name, font size, underline, strikethrough, superscript, subscript, page number, the number of pages, date and time, file name.

Constructor Summary

Constructors

Constructor	Description
ExcelFooter()	Defines an instance of the footer.
ExcelFooter(System.String text, System.String position)	Defines an instance of the footer having the specified text and position.
ExcelFooter(System.String text, System.String position, System.String fontName, int fontSize, bool isBold, bool isItalic)	Defines an instance of the footer having the specified text, position and font settings.

Method Summary

Modifier and Type	Method	Description
ExcelFooter	Clone()	Creates and returns a copy of this object.
System.String	getFooterString()	Returns the footer expression.
System.String	getPosition()	Returns the position of the footer.
void	InsertBold()	Sets the bold style for the values that will follow the insertion.
void	InsertDate()	Appends the date to footer expression.
void	InsertDoubleUnderline()	Sets the double underline style for the values that will follow the insertion.
void	InsertEnter()	Appends the enter character to footer expression.
void	InsertFile()	Appends the file name to footer expression.
void	InsertFont(System.String fontType)	Sets the font type for the values that will follow the font insertion.
void	InsertFontSize(int fontSize)	Sets the font size for the values that will follow the font size insertion.
void	InsertItalic()	Sets the italic style for the values that will follow the insertion.
void	InsertPage()	Appends the page number to footer expression.
void	InsertPages()	Appends the total number of pages to footer expression.
void	InsertSingleUnderline()	Sets the single underline style for the values that will follow the insertion.
void	InsertStrikethrough()	Sets the strikethrough style for the values that will follow the insertion.
void	InsertSubscript()	Sets the subscript style for the values that will follow the insertion.
void	InsertSuperscript()	Sets the superscript style for the values that will follow the insertion.
void	InsertTab()	Appends the tab character to footer expression.
void	InsertTime()	Appends the date time to footer expression.
void	InsertValue(System.String value)	Appends a string to footer expression.
void	RemoveBold()	Removes the bold style for the values that will follow the insertion.
void	RemoveDoubleUnderline()	Removes the double underline style for the values that will follow the insertion.
void	RemoveItalic()	Removes the italic style for the values that will follow the insertion.
void	RemoveSingleUnderline()	Removes the single underline style for the values that will follow the insertion.
void	RemoveStrikethrough()	Removes the strikethrough style for the values that will follow the insertion.
void	RemoveSubscript()	Removes the subscript style for the values that will follow the insertion.
void	RemoveSuperscript()	Removes the superscript style for the values that will follow the insertion.
void	Reset()	Clears the footer expression.
void	setFooterString(System.String text)	Sets the footer expression.
void	setPosition(System.String position)	Sets the position of the footer.

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExcelFooter

public ExcelFooter()

Defines an instance of the footer.

ExcelFooter

public ExcelFooter(System.String text,
 System.String position)

Defines an instance of the footer having the specified text and position.

Parameters:

text - the text from the footer

position - the position of the footer. Possible values are available in Footer class.

ExcelFooter

public ExcelFooter(System.String text,
 System.String position,
 System.String fontName,
 int fontSize,
 bool isBold,
 bool isItalic)

Defines an instance of the footer having the specified text, position and font settings.

Parameters:

text - the text from the footer

position - the position of the footer. Possible values are available in Footer class.

fontName - the font name of the footer

fontSize - the font size of the footer

isBold - the bold option of the footer

isItalic - the italic option of footer

Method Details

getFooterString

public System.String getFooterString()

Returns the footer expression.

Returns:

the footer expression

See Also:

• setFooterString(System.String)

setFooterString

public void setFooterString(System.String text)

Sets the footer expression.

Parameters:

text - the footer expression

See Also:

• getFooterString()

getPosition

public System.String getPosition()

Returns the position of the footer. Possible values are available in Footer class.

Returns:

the position of the footer

See Also:

• setPosition(System.String)

setPosition

public void setPosition(System.String position)

Sets the position of the footer. Possible values are available in Footer class.

Parameters:

position - the footer expression

See Also:

• getPosition()

InsertValue

public void InsertValue(System.String value)

Appends a string to footer expression.

Parameters:

value - the value to be inserted

InsertFont

public void InsertFont(System.String fontType)

Sets the font type for the values that will follow the font insertion.

Parameters:

fontType - the font type

InsertFontSize

public void InsertFontSize(int fontSize)

Sets the font size for the values that will follow the font size insertion.

Parameters:

fontSize - the font size

InsertSingleUnderline

public void InsertSingleUnderline()

Sets the single underline style for the values that will follow the insertion.

See Also:

• RemoveSingleUnderline()

RemoveSingleUnderline

public void RemoveSingleUnderline()

Removes the single underline style for the values that will follow the insertion.

See Also:

• InsertSingleUnderline()

InsertDoubleUnderline

public void InsertDoubleUnderline()

Sets the double underline style for the values that will follow the insertion.

See Also:

• RemoveDoubleUnderline()

RemoveDoubleUnderline

public void RemoveDoubleUnderline()

Removes the double underline style for the values that will follow the insertion.

See Also:

• InsertDoubleUnderline()

InsertStrikethrough

public void InsertStrikethrough()

Sets the strikethrough style for the values that will follow the insertion.

See Also:

• RemoveStrikethrough()

RemoveStrikethrough

public void RemoveStrikethrough()

Removes the strikethrough style for the values that will follow the insertion.

See Also:

• InsertStrikethrough()

InsertSuperscript

public void InsertSuperscript()

Sets the superscript style for the values that will follow the insertion.

See Also:

• RemoveSuperscript()

RemoveSuperscript

public void RemoveSuperscript()

Removes the superscript style for the values that will follow the insertion.

See Also:

• InsertSuperscript()

InsertSubscript

public void InsertSubscript()

Sets the subscript style for the values that will follow the insertion.

See Also:

• RemoveSubscript()

RemoveSubscript

public void RemoveSubscript()

Removes the subscript style for the values that will follow the insertion.

See Also:

• InsertSubscript()

InsertBold

public void InsertBold()

Sets the bold style for the values that will follow the insertion.

See Also:

• RemoveBold()

RemoveBold

public void RemoveBold()

Removes the bold style for the values that will follow the insertion.

See Also:

• InsertBold()

InsertItalic

public void InsertItalic()

Sets the italic style for the values that will follow the insertion.

See Also:

• RemoveItalic()

RemoveItalic

public void RemoveItalic()

Removes the italic style for the values that will follow the insertion.

See Also:

• InsertItalic()

InsertPage

public void InsertPage()

Appends the page number to footer expression.

InsertPages

public void InsertPages()

Appends the total number of pages to footer expression.

InsertDate

public void InsertDate()

Appends the date to footer expression.

InsertTime

public void InsertTime()

Appends the date time to footer expression.

InsertFile

public void InsertFile()

Appends the file name to footer expression.

InsertTab

public void InsertTab()

Appends the tab character to footer expression.

InsertEnter

public void InsertEnter()

Appends the enter character to footer expression.

Reset

public void Reset()

Clears the footer expression.

Clone

public ExcelFooter Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.