Class
ExportToHTML

Definition

Namespace:Telerik.WinControls.UI.Export

Assembly:TelerikData.dll

Syntax:

cs-api-definition
public class ExportToHTML : IExportGridTo

Inheritance: objectExportToHTML

Implements: IExportGridTo

Constructors

ExportToHTML(RadGridView)

Create instance of exporter class with specified RadGridView to export

Declaration

cs-api-definition
public ExportToHTML(RadGridView gridToExport)

Parameters

gridToExport

RadGridView

RadGridView to export

Properties

AutoSizeColumns

Gets or sets a value indicating whether the columns width should be calculated based on the content of the cells or should be fixed.

Declaration

cs-api-definition
public bool AutoSizeColumns { get; set; }

Property Value

bool

ChildViewExportMode

Gets or sets the child view export mode.

Declaration

cs-api-definition
public ChildViewExportMode ChildViewExportMode { get; set; }

Property Value

ChildViewExportMode

The child view export mode.

Encoding

Gets or sets the encoding used for the exported file. Default encoding is UTF8.

Declaration

cs-api-definition
public Encoding Encoding { get; set; }

Property Value

Encoding

ExportHierarchy

Set if child rows should be exported.

Declaration

cs-api-definition
public bool ExportHierarchy { set; }

Property Value

bool

ExportImages

Gets or sets a value indicating whether to export images.

Declaration

cs-api-definition
public bool ExportImages { get; set; }

Property Value

bool

ExportVisualSettings

Set to export visual settings e.g. background colors, font, alignment, conditional formatting etc. Default value: false.

Declaration

cs-api-definition
public bool ExportVisualSettings { set; }

Property Value

bool

FileExtension

Set the file extension. Default value is htm.

Declaration

cs-api-definition
public string FileExtension { set; }

Property Value

string

Implements IExportGridTo.FileExtension

FitWidthSize

Set the width in milimeters to fit the table in.

Declaration

cs-api-definition
public int FitWidthSize { set; }

Property Value

int

Font

Set the html table general Font.

Declaration

cs-api-definition
public Font Font { set; }

Property Value

Font

HiddenColumnOption

Set if to export hidden column.

Declaration

cs-api-definition
public HiddenOption HiddenColumnOption { set; }

Property Value

HiddenOption

Implements IExportGridTo.HiddenColumnOption

HiddenRowOption

Set if to export hidden rows.

Declaration

cs-api-definition
public HiddenOption HiddenRowOption { set; }

Property Value

HiddenOption

Implements IExportGridTo.HiddenRowOption

PagingExportOption

Sets a value indicating how the export behavies when paging is enabled.

Declaration

cs-api-definition
public PagingExportOption PagingExportOption { set; }

Property Value

PagingExportOption

The paging export option.

RadGridViewToExport

Set RadGridView that would be exported.

Declaration

cs-api-definition
public RadGridView RadGridViewToExport { set; }

Property Value

RadGridView

Implements IExportGridTo.RadGridViewToExport

Scale

Set the table size scaling. Default value is 1. For example, scale of 1.2 means 20% size increase.

Declaration

cs-api-definition
public float Scale { set; }

Property Value

float

ScaleImages

Gets or sets a value indicating whether to scale exported images.

Declaration

cs-api-definition
public bool ScaleImages { get; set; }

Property Value

bool

SummariesExportOption

Set how to export summary rows.

Declaration

cs-api-definition
public SummariesOption SummariesExportOption { set; }

Property Value

SummariesOption

Implements IExportGridTo.SummariesExportOption

TableBorderThickness

Set html table border thickness. Default value is 0

Declaration

cs-api-definition
public int TableBorderThickness { set; }

Property Value

int

TableCaption

Set html table caption.

Declaration

cs-api-definition
public string TableCaption { set; }

Property Value

string

Methods

EscapeSpecialChars(CellElement)

Declaration

cs-api-definition
protected virtual void EscapeSpecialChars(CellElement htmlCellElement)

Parameters

htmlCellElement

CellElement

OnChildViewExporting(ChildViewExportingEventArgs)

Declaration

cs-api-definition
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)

Parameters

e

ChildViewExportingEventArgs

OnHTMLCellFormatting(HTMLCellFormattingEventArgs)

Declaration

cs-api-definition
protected virtual void OnHTMLCellFormatting(HTMLCellFormattingEventArgs e)

Parameters

e

HTMLCellFormattingEventArgs

OnHTMLTableCaptionFormatting(HTMLTableCaptionFormattingEventArgs)

Fires when html table was created and provides access to its caption element

Declaration

cs-api-definition
protected virtual void OnHTMLTableCaptionFormatting(HTMLTableCaptionFormattingEventArgs e)

Parameters

e

HTMLTableCaptionFormattingEventArgs

RunExport(string)

Creates file in html format.

Declaration

cs-api-definition
public void RunExport(string fileName)

Parameters

fileName

string

Export file name

Implements IExportGridTo.RunExport(string)

Events

ChildViewExporting

Occurs when a child view will be exported.

Declaration

cs-api-definition
public event ChildViewExportingEventHandler ChildViewExporting

Event Value

ChildViewExportingEventHandler

HTMLCellFormatting

Fires when an html cell object was created and needs to be formatted.

Declaration

cs-api-definition
public event HTMLCellFormattingEventHandler HTMLCellFormatting

Event Value

HTMLCellFormattingEventHandler

HTMLTableCaptionFormatting

Occurs when html table was created and provides access to its caption element

Declaration

cs-api-definition
public event HTMLTableCaptionFormattingEventHandler HTMLTableCaptionFormatting

Event Value

HTMLTableCaptionFormattingEventHandler