Click or drag to resize
GridViewPdfExport Class
GridViewPdfExport is an exporting API, allowing to export RadGridView to PDF format, utilizing the Document Processing Libraries.
Inheritance Hierarchy
SystemObject
  Telerik.WinControls.ExportGridViewPdfExport

Namespace: Telerik.WinControls.Export
Assembly: Telerik.WinControls.GridView (in Telerik.WinControls.GridView.dll) Version: 2018.1.220.40 (2018.1.220.40)
Syntax
public class GridViewPdfExport

The GridViewPdfExport type exposes the following members.

Constructors
  NameDescription
Public methodGridViewPdfExport
Initializes a new instance of the GridViewPdfExport class.
Top
Properties
  NameDescription
Public propertyChildViewExportMode
Gets or sets the child view export mode.
Public propertyExportGroupedColumns
Gets or sets a value indicating whether grouped columns should be exported. Default value is true.
Public propertyExportHeaderRowOnEachPage
Gets or sets a value indicating whether the header row should be exported on each page. Default value is true.
Public propertyExportHierarchy
Gets or sets if child rows should be exported.
Public propertyExportSettings
Gets or sets export settings.
Public propertyExportViewDefinition
Gets or sets a value indicating whether to export view definition.
Public propertyExportVisualSettings
Gets or sets a value indicating whether the visual settings should be exported.
Public propertyFileExtension
Gets or sets the file extension of the exported file.
Public propertyFitToPageWidth
Gets or sets a value indicating whether the content of page should fit into the page width. Default value is true.
Public propertyFooterFont
Gets or sets the font of the page footer.
Public propertyFooterHeight
Gets or sets the footer height.
Public propertyHeaderFont
Gets or sets the font of the page header.
Public propertyHeaderHeight
Gets or sets the header height.
Public propertyHiddenColumnOption
Gets or sets a value indicating how hidden columns are exported.
Public propertyHiddenRowOption
Gets or sets a value indicating how hidden rows are exported.
Public propertyLeftFooter
Gets or sets the text that will be exported near the bottom left corner of the page.
Public propertyLeftHeader
Gets or sets the text that will be exported near the upper left corner of the page.
Public propertyLogo
Gets or sets the header/footer logo.
Public propertyLogoAlignment
Gets or sets the alignment of logo image in header/footer.
Public propertyLogoLayout
Gets or sets the way the logo is drawn.
Public propertyMiddleFooter
Gets or sets the text that will be exported at the bottom center of the page.
Public propertyMiddleHeader
Gets or sets the text that will be exported at the top center of the page.
Public propertyPageMargins
Gets or Sets the margins of pages that will be exported in millimeters.
Public propertyPageSize
Gets or sets the page size in millimeters for the exported file. Default size is 210x297mm(A4 portrait).
Public propertyPagingExportOption
Gets or sets a value indicating how the export behaves when paging is enabled.
Public propertyRadGridViewToExport
Gets or sets the RadGridView to export.
Public propertyReverseFooterOnEvenPages
[true] if the LeftFooter and RightFooter should be reversed on even pages, [false] otherwise.
Public propertyReverseHeaderOnEvenPages
[true] if the LeftHeader and RightHeader should be reversed on even pages, [false] otherwise.
Public propertyRightFooter
Gets or sets the text that will be exported near the bottom right corner of the page.
Public propertyRightHeader
Gets or sets the text that will be exported near the upper right corner of the page.
Public propertyRowIndent
Gets or sets the indent of group and hierarchy rows.
Public propertyScale
Gets or sets the document scaling. Default value is 1. For example, scale of 1.2f means 20% size increase.
Public propertyShowHeaderAndFooter
Gets or sets a value indicating whether header and footer should be exported.
Public propertySummariesExportOption
Gets or sets a value indicating how summary rows are exported.
Top
Methods
  NameDescription
Public methodCancelExport
Cancels current export operation.
Public methodCancelExportAsync
Cancels an asynchronous export operation.
Protected methodDrawFooter
Exports the footer part of the page.
Protected methodDrawHeader
Exports the header part of the page.
Protected methodGetRowSize
Gets the row size using the provided row layout.
Protected methodOnAsyncExportCompleted
Raises the [E:AsyncExportCompleted] event.
Protected methodOnAsyncExportProgressChanged
Raises the [E:AsyncExportProgressChanged] event.
Protected methodOnCellFormatting
Raises the [E:CellFormatting] event.
Protected methodOnCellPaint
Raises the [E:CellPaint] event.
Protected methodOnChildViewExporting
Raises the [E:ChildViewExporting] event.
Protected methodOnFooterExported
Raises the [E:FooterExported] event.
Protected methodOnHeaderExported
Raises the [E:HeaderExported] event.
Protected methodOnPdfExported
Raises the [E:PDFExported] event.
Protected methodParseHeaderFooterString
Parses a given string for special words.
Public methodRunExport(Stream, IPdfExportRenderer)
Starts an export operation.
Public methodRunExport(String, IPdfExportRenderer)
Starts an export operation.
Public methodRunExportAsync(Stream, IPdfExportRenderer)
Starts an export operation that runs in a background thread.
Public methodRunExportAsync(String, IPdfExportRenderer)
Starts an export operation that runs in a background thread.
Top
Events
  NameDescription
Public eventAsyncExportCompleted
Occurs when an async export operation is completed.
Public eventAsyncExportProgressChanged
Occurs when the progress of an async export operation changes.
Public eventCellFormatting
Occurs for every cell that is being exported.
Public eventCellPaint
Occurs when a cell is drawn.
Public eventChildViewExporting
Occurs when a child view will be exported.
Public eventFooterExported
Occurs when the footer is exported.
Public eventHeaderExported
Occurs when the header is exported.
Public eventPdfExported
Occurs when the export process completes.
Top
Fields
  NameDescription
Public fieldStatic memberDateExportedString
Date when the exporting was started.
Public fieldStatic memberDatePrintedString Obsolete.
Obsolete. Use DateExportedString instead.
Public fieldStatic memberLogoString
Allows to add logo to the header or footer.
Public fieldStatic memberPageNumberString
Number of the current page
Public fieldStatic memberTimeExportedString
Time when the printing was started.
Public fieldStatic memberTimePrintedString Obsolete.
Obsolete. Use DateExportedString instead.
Public fieldStatic memberTotalPagesString
Total number of pages
Public fieldStatic memberUserNameExportedString
Username associated with the current thread (the current Windows login))
Public fieldStatic memberUserNamePrintedString Obsolete.
Obsolete. Use UserNameExportedString instead.
Top
See Also