Class
ExportToPDF

Definition

Namespace:Telerik.WinControls.UI.Export

Assembly:TelerikData.dll

Syntax:

cs-api-definition
public class ExportToPDF : IExportGridTo

Inheritance: objectExportToPDF

Implements: IExportGridTo

Constructors

ExportToPDF(RadGridView)

Declaration

cs-api-definition
public ExportToPDF(RadGridView gridToExport)

Parameters

gridToExport

RadGridView

Properties

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

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 pdf.

Declaration

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

Property Value

string

Implements IExportGridTo.FileExtension

FitToPageWidth

Set table to fit to pdf page width

Declaration

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

Property Value

bool

Font

Set the table Font.

Declaration

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

Property Value

Font

HiddenColumnOption

Set how to export hidden column.

Declaration

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

Property Value

HiddenOption

Implements IExportGridTo.HiddenColumnOption

HiddenRowOption

Set how to export hidden rows.

Declaration

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

Property Value

HiddenOption

Implements IExportGridTo.HiddenRowOption

PageTitle

Set pdf page title.

Declaration

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

Property Value

string

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.

PdfExportSettings

Get or set pdf export settings class

Declaration

cs-api-definition
public ExportSettings.PDF PdfExportSettings { get; set; }

Property Value

ExportSettings.PDF

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.2f means 20% size increase.

Declaration

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

Property Value

float

SummariesExportOption

Set how to export summary rows.

Declaration

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

Property Value

SummariesOption

Implements IExportGridTo.SummariesExportOption

TableBorderThickness

Set pdf table border thickness. Default value is 0

Declaration

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

Property Value

int

Methods

RunExport(string)

Creates PDF file

Declaration

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

Parameters

fileName

string

Export file name

Implements IExportGridTo.RunExport(string)

RunExportCall(string)

Declaration

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

Parameters

fileName

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. Note that pdf export firstly renders as html and this allows to apply custom format to any cell.

Declaration

cs-api-definition
public event HTMLCellFormattingEventHandler HTMLCellFormatting

Event Value

HTMLCellFormattingEventHandler