Class PdfExportPropertiesBase

Represents the PDF export customization options for the PDF document.

Inheritance

object

PdfExportPropertiesBase

GanttPdfExportProperties

PdfExportProperties

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.Grids.dll

Syntax

public class PdfExportPropertiesBase

Constructors

PdfExportPropertiesBase()

Declaration

public PdfExportPropertiesBase()

Properties

FileName

Gets or sets the file name of the exported Pdf.

Declaration

public string? FileName { get; set; }

Property Value

Type	Description
string	A string representing the file name of the exported Pdf. The default file name is Export.pdf

Footer

Gets or sets the instance of PdfFooter which has footer configuration for the Pdf export.

Declaration

public PdfFooter? Footer { get; set; }

Property Value

Type	Description
PdfFooter	An instance of PdfFooter.

Remarks

PdfFooter class provides the footer configuration, like footer height, position and other configuration

Header

Gets or sets the header configuration for the Pdf export.

Declaration

public PdfHeader? Header { get; set; }

Property Value

Type	Description
PdfHeader	An instance of PdfHeader.

Remarks

PdfHeader class provides the header configuration, like header height, position and other configuration

IncludeHiddenColumn

Gets or sets whether to show the hidden columns in exported Pdf.

Declaration

public bool IncludeHiddenColumn { get; set; }

Property Value

Type	Description
bool	true to include hidden columns in the Pdf export; otherwise, false.

Remarks

Setting this property to true will include hidden columns in the generated Pdf document.

IncludeTemplateColumn

Gets or sets whether to show the template columns in exported Pdf.

Declaration

public bool IncludeTemplateColumn { get; set; }

Property Value

Type	Description
bool	true to include template columns in the Pdf export; otherwise, false.

Remarks

Setting this property to true will include template columns in the generated Pdf document.

PageOrientation

Gets or sets the page orientation of the exported Pdf.

Declaration

public PageOrientation PageOrientation { get; set; }

Property Value

Type	Description
PageOrientation	One of the PageOrientation enumeration that represents the page orientation of the exported Pdf. The default mode is PageOrientation.Portrait

Remarks

The page orientation determines whether the pages in the Pdf will be in portrait or landscape mode.

PageSize

Gets or sets the page size of the exported Pdf.

Declaration

public PdfPageSize PageSize { get; set; }

Property Value

Type	Description
PdfPageSize	One of the PdfPageSize enumeration that represents the page size of the exported Pdf. The default page size is PdfPageSize.Letter

Remarks

The page size specifies the dimensions of the pages in the Pdf document.