Class GridWordConverterBase

Implements the basic functionalities for exporting the GridControl to word.

Inheritance

System.Object

GridWordConverterBase

GridWordConverter

GroupingGridWordConverter

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.GridHelperClasses

Assembly: Syncfusion.GridHelperClasses.Windows.dll

Syntax

public class GridWordConverterBase

Remarks

It has support for header and footer.

Constructors

GridWordConverterBase()

Initializes a new instance of the GridWordConverterBase class.

Declaration

public GridWordConverterBase()

GridWordConverterBase(Boolean, Boolean)

Initializes a new instance of the GridWordConverterBase class.

Declaration

public GridWordConverterBase(bool showHeader, bool showFooter)

Parameters

Type	Name	Description
System.Boolean	showHeader	Indicates true if Header should be shown; Default is false.
System.Boolean	showFooter	Indicates true if Footer should be shown; Default is false.

Properties

ShowFooter

Gets or sets a value indicating whether footer should be added.

Declaration

public bool ShowFooter { get; set; }

Property Value

Type
System.Boolean

ShowHeader

Gets or sets a value indicating whether header should be added.

Declaration

public bool ShowHeader { get; set; }

Property Value

Type	Description
System.Boolean	True if header is added otherwise false.

Methods

DrawHeaderFooter(WordDocument, Boolean, Boolean)

Draws the Header and Footer.

Declaration

protected void DrawHeaderFooter(WordDocument wordDocument, bool top, bool bottom)

Parameters

Type	Name	Description
WordDocument	wordDocument	The word document.
System.Boolean	top	Indicates true if Header should be added.
System.Boolean	bottom	Indicates true if Footer should be added.

OnDrawFooter(DocHeaderFooterEventArgs)

Raises the DrawFooter event.

Declaration

protected virtual void OnDrawFooter(DocHeaderFooterEventArgs e)

Parameters

Type	Name	Description
DocHeaderFooterEventArgs	e	A DocHeaderFooterEventArgs that contains the event data.

OnDrawHeader(DocHeaderFooterEventArgs)

Raises the DrawHeader event.

Declaration

protected virtual void OnDrawHeader(DocHeaderFooterEventArgs e)

Parameters

Type	Name	Description
DocHeaderFooterEventArgs	e	A DocHeaderFooterEventArgs that contains the event data.

Events

DrawFooter

Lets the user draw a Footer for the PDF Document

Declaration

public event GridWordConverterBase.DrawDocHeaderFooterEventHandler DrawFooter

Event Type

Type
GridWordConverterBase.DrawDocHeaderFooterEventHandler

DrawHeader

Lets the user draw a header for the PDF Document

Declaration

public event GridWordConverterBase.DrawDocHeaderFooterEventHandler DrawHeader

Event Type

Type
GridWordConverterBase.DrawDocHeaderFooterEventHandler