Class PdfExportingOptions

Class which is used to set the exporting options. User can pass the instance of this class as an argument to the ExportToPdf and ExportToPdfGrid methods.

Inheritance
System.Object
PdfExportingOptions
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: Syncfusion.WinForms.DataGridConverter
Assembly: Syncfusion.SfDataGridConverter.WinForms.dll
Syntax
public class PdfExportingOptions

Constructors

PdfExportingOptions()

Declaration
public PdfExportingOptions()

Properties

AutoColumnWidth

Gets or sets a value which indicates whether the column widths are automatically assigned based on its content or not.

Declaration
public bool AutoColumnWidth { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

AutoRowHeight

Gets or sets a value which indicates whether the row heights are automatically assigned based on its content or not.

Declaration
public bool AutoRowHeight { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

Columns

Gets list of columns which includes excluding of ExcludeColumns.

Declaration
public List<string> Columns { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

ExcludeColumns

Gets or sets the value which indicates the columns that needs to be excluded while exporting.

Declaration
public List<string> ExcludeColumns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

ExportAllDetails

Gets or sets a value which indicates whether all DetailsViewDataGrids should be exported even if it is not expanded.

Declaration
public bool ExportAllDetails { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

ExportAllPages

Gets or sets a value which indicates whether all pages should be exported or not.

Declaration
public bool ExportAllPages { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

ExportDetailsView

Gets or sets a value which indicates whether DetailsViewDataGrid should be exported or not.

Declaration
public bool ExportDetailsView { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

ExportFormat

Gets or sets a value which indicates whether the values should be exported with format or not.

Declaration
public bool ExportFormat { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

ExportGroups

Gets or sets a value which indicates whether groups should be exported or not.

Declaration
public bool ExportGroups { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

ExportGroupSummary

Gets or sets a value which indicates whether group summary should be exported or not.

Declaration
public bool ExportGroupSummary { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

ExportMergedCells

Gets or sets a value which indicates whether Merged Cells should be exported or not.

Declaration
public bool ExportMergedCells { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

ExportStackedHeaders

Gets or sets a value which indicates whether stacked headers should be exported or not.

Declaration
public bool ExportStackedHeaders { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

ExportTableSummary

Gets or sets a value which indicates whether table summary should be exported or not.

Declaration
public bool ExportTableSummary { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

ExportUnboundRows

Gets or sets a value which indicates whether the UnBoundRows should be exported or not.

Declaration
public bool ExportUnboundRows { get; set; }
Property Value
Type Description
System.Boolean

FitAllColumnsInOnePage

Gets or sets a value which indicates whether all columns should be fit on a page or not.

Declaration
public bool FitAllColumnsInOnePage { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.

RepeatHeaders

Gets or sets the value which indicates whether the headers can be repeated in each page or not.

Declaration
public bool RepeatHeaders { get; set; }
Property Value
Type Description
System.Boolean

Default value is true.

RowIndex

Gets or sets the row index of SfDataGrid which keeps track of the row index while exporting.

Declaration
public int RowIndex { get; set; }
Property Value
Type Description
System.Int32

Default value is zero.

Events

CellExporting

Occurs while exporting the each cell into Pdf.

Declaration
public event DataGridCellPdfExportingEventHandler CellExporting
Event Type
Type Description
DataGridCellPdfExportingEventHandler

ChildExporting

Occurs while exporting the details view child cell into Pdf.

Declaration
public event DataGridChildPdfExportingEventhandler ChildExporting
Event Type
Type Description
DataGridChildPdfExportingEventhandler

Exporting

Occurs only once while exporting the each cell type into Pdf.

Declaration
public event DataGridPdfExportingEventHandler Exporting
Event Type
Type Description
DataGridPdfExportingEventHandler

HeaderFooterExporting

Occurs while exporting the header and footer into Pdf.

Declaration
public event PdfHeaderFooterEventHandler HeaderFooterExporting
Event Type
Type Description
PdfHeaderFooterEventHandler