New to Telerik UI for WinForms? Start a free 30-day trial

Definition

Namespace:Telerik.WinControls.UI.Export

Assembly:TelerikData.dll

Syntax:

C#
public class ExportToHTML : IExportGridTo

Inheritance: objectExportToHTML

Implements: IExportGridTo

Constructors

Create instance of exporter class with specified RadGridView to export

C#
public ExportToHTML(RadGridView gridToExport)
Parameters:gridToExportRadGridView

RadGridView to export

Properties

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

C#
public bool AutoSizeColumns { get; set; }

Gets or sets the child view export mode.

C#
public ChildViewExportMode ChildViewExportMode { get; set; }
Property Value:

The child view export mode.

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

C#
public Encoding Encoding { get; set; }

Set if child rows should be exported.

C#
public bool ExportHierarchy { set; }

Gets or sets a value indicating whether to export images.

C#
public bool ExportImages { get; set; }

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

C#
public bool ExportVisualSettings { set; }

Set the file extension. Default value is htm.

C#
public string FileExtension { set; }

Implements: IExportGridTo.FileExtension

Set the width in milimeters to fit the table in.

C#
public int FitWidthSize { set; }

Set the html table general Font.

C#
public Font Font { set; }

Set if to export hidden column.

C#
public HiddenOption HiddenColumnOption { set; }

Implements: IExportGridTo.HiddenColumnOption

Set if to export hidden rows.

C#
public HiddenOption HiddenRowOption { set; }

Implements: IExportGridTo.HiddenRowOption

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

C#
public PagingExportOption PagingExportOption { set; }
Property Value:

The paging export option.

Set RadGridView that would be exported.

C#
public RadGridView RadGridViewToExport { set; }

Implements: IExportGridTo.RadGridViewToExport

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

C#
public float Scale { set; }

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

C#
public bool ScaleImages { get; set; }

Set how to export summary rows.

C#
public SummariesOption SummariesExportOption { set; }

Implements: IExportGridTo.SummariesExportOption

Set html table border thickness. Default value is 0

C#
public int TableBorderThickness { set; }

Set html table caption.

C#
public string TableCaption { set; }

Methods

C#
protected virtual void EscapeSpecialChars(CellElement htmlCellElement)
Parameters:htmlCellElementCellElement
C#
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)
Parameters:eChildViewExportingEventArgs
C#
protected virtual void OnHTMLCellFormatting(HTMLCellFormattingEventArgs e)
Parameters:eHTMLCellFormattingEventArgs

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

C#
protected virtual void OnHTMLTableCaptionFormatting(HTMLTableCaptionFormattingEventArgs e)
Parameters:eHTMLTableCaptionFormattingEventArgs

Creates file in html format.

C#
public void RunExport(string fileName)
Parameters:fileNamestring

Export file name

Implements: IExportGridTo.RunExport(string)

Events

Occurs when a child view will be exported.

C#
public event ChildViewExportingEventHandler ChildViewExporting

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

C#
public event HTMLCellFormattingEventHandler HTMLCellFormatting

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

C#
public event HTMLTableCaptionFormattingEventHandler HTMLTableCaptionFormatting