Class HFEngine

Engine for parsing and creation of header/footer strings.

Inheritance
System.Object
CommonWrapper
RichTextString
HFEngine
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class HFEngine : RichTextString, ICloneParent, IHFEngine, IRichTextString, IParentApplication, IOptimizedUpdate

Constructors

HFEngine(IApplication, Object)

Initializes new instance of the RichTextString.

Declaration
public HFEngine(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the RichTextString.
System.Object parent

Parent object for the RichTextString.

Methods

AddFont(IFont)

Adds font to the inner fonts array.

Declaration
protected override int AddFont(IFont fontToAdd)
Parameters
Type Name Description
IFont fontToAdd

Font to add.
Returns
Type Description
System.Int32

Index of the added font.
Overrides

Clear()

Clears string and formatting.

Declaration
public override void Clear()
Overrides

EndUpdate()

This method is called after each change in rich text string.

Declaration
public override void EndUpdate()
Overrides

FindFont(String, String)

Searches for required font.

Declaration
public ENUMLOGFONTEX FindFont(string strFontName, string strFontStyle)
Parameters
Type Name Description
System.String strFontName

Font name to look for.
System.String strFontStyle

Font style.
Returns
Type
ENUMLOGFONTEX

GetFontByIndex(Int32)

Returns font by its index.

Declaration
protected override FontImpl GetFontByIndex(int iFontIndex)
Parameters
Type Name Description
System.Int32 iFontIndex

Font index.
Returns
Type Description
FontImpl

Font that corresponds to the specified index.
Overrides

GetHeaderFooterString()

Returns string in format that is supported by Excel header/footer.

Declaration
public string GetHeaderFooterString()
Returns
Type Description
System.String

String in format that is supported by Excel header/footer.

Parse(String)

Parses text of header/footer part.

Declaration
public void Parse(string strText)
Parameters
Type Name Description
System.String strText

Text of header/footer part.

Implements