Documentation

Class ExportToHTML

Inheritance
System.Object
ExportToHTML
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI.Export
Assembly: TelerikData.dll

Syntax

public class ExportToHTML : IExportGridTo

Constructors

ExportToHTML(RadGridView)

Create instance of exporter class with specified RadGridView to export

Declaration
public ExportToHTML(RadGridView gridToExport)
Parameters
RadGridView gridToExport

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
public bool AutoSizeColumns { get; set; }
Property Value
System.Boolean

ChildViewExportMode

Gets or sets the child view export mode.

Declaration
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
public Encoding Encoding { get; set; }
Property Value
System.Text.Encoding

ExportHierarchy

Set if child rows should be exported.

Declaration
public bool ExportHierarchy { set; }
Property Value
System.Boolean

ExportImages

Gets or sets a value indicating whether to export images.

Declaration
public bool ExportImages { get; set; }
Property Value
System.Boolean

ExportVisualSettings

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

Declaration
public bool ExportVisualSettings { set; }
Property Value
System.Boolean

FileExtension

Set the file extension. Default value is htm.

Declaration
public string FileExtension { set; }
Property Value
System.String

Implements

FitWidthSize

Set the width in milimeters to fit the table in.

Declaration
public int FitWidthSize { set; }
Property Value
System.Int32

Font

Set the html table general Font.

Declaration
public Font Font { set; }
Property Value
System.Drawing.Font

HiddenColumnOption

Set if to export hidden column.

Declaration
public HiddenOption HiddenColumnOption { set; }
Property Value
HiddenOption

Implements

HiddenRowOption

Set if to export hidden rows.

Declaration
public HiddenOption HiddenRowOption { set; }
Property Value
HiddenOption

Implements

PagingExportOption

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

Declaration
public PagingExportOption PagingExportOption { set; }
Property Value
PagingExportOption

The paging export option.

RadGridViewToExport

Set RadGridView that would be exported.

Declaration
public RadGridView RadGridViewToExport { set; }
Property Value
RadGridView

Implements

Scale

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

Declaration
public float Scale { set; }
Property Value
System.Single

ScaleImages

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

Declaration
public bool ScaleImages { get; set; }
Property Value
System.Boolean

SummariesExportOption

Set how to export summary rows.

Declaration
public SummariesOption SummariesExportOption { set; }
Property Value
SummariesOption

Implements

TableBorderThickness

Set html table border thickness. Default value is 0

Declaration
public int TableBorderThickness { set; }
Property Value
System.Int32

TableCaption

Set html table caption.

Declaration
public string TableCaption { set; }
Property Value
System.String

Methods

EscapeSpecialChars(CellElement)

Declaration
protected virtual void EscapeSpecialChars(CellElement htmlCellElement)
Parameters
CellElement htmlCellElement

OnChildViewExporting(ChildViewExportingEventArgs)

Declaration
protected virtual void OnChildViewExporting(ChildViewExportingEventArgs e)
Parameters
ChildViewExportingEventArgs e

OnHTMLCellFormatting(HTMLCellFormattingEventArgs)

Declaration
protected virtual void OnHTMLCellFormatting(HTMLCellFormattingEventArgs e)
Parameters
HTMLCellFormattingEventArgs e

OnHTMLTableCaptionFormatting(HTMLTableCaptionFormattingEventArgs)

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

Declaration
protected virtual void OnHTMLTableCaptionFormatting(HTMLTableCaptionFormattingEventArgs e)
Parameters
HTMLTableCaptionFormattingEventArgs e

RunExport(String)

Creates file in html format.

Declaration
public void RunExport(string fileName)
Parameters
System.String fileName

Export file name
Implements

Events

ChildViewExporting

Occurs when a child view will be exported.

Declaration
public event ChildViewExportingEventHandler ChildViewExporting
Event Type
ChildViewExportingEventHandler

HTMLCellFormatting

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

Declaration
public event HTMLCellFormattingEventHandler HTMLCellFormatting
Event Type
HTMLCellFormattingEventHandler

HTMLTableCaptionFormatting

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

Declaration
public event HTMLTableCaptionFormattingEventHandler HTMLTableCaptionFormatting
Event Type
HTMLTableCaptionFormattingEventHandler

Extension Methods