Class PdfExportProperties

Represents a class that defines pdf export customization options.

Inheritance

System.Object

PdfExportProperties

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.EJ2.TreeGridExport

Assembly: Syncfusion.EJ2.GridExport.dll

Syntax

public class PdfExportProperties

Constructors

PdfExportProperties()

Declaration

public PdfExportProperties()

Properties

AllowHorizontalOverflow

Gets or sets the horizontal overflow behavior of the exported content.

Declaration

public bool AllowHorizontalOverflow { get; set; }

Property Value

Type	Description
System.Boolean	true if content is allowed to overflow horizontally; otherwise, false. The default value is false.

EnableRepeatHeader

Gets or sets a value indicating whether the PDF header should be repeated on every page.

Declaration

public bool EnableRepeatHeader { get; set; }

Property Value

Type	Description
System.Boolean	true if the PDF header should be repeated on each page; otherwise, false.

Remarks

This property is often used to ensure that important header information remains visible on every page of the exported PDF.

ExportType

Gets or sets a value indicating whether all pages or the current page should be exported.

Declaration

public ExportType ExportType { get; set; }

Property Value

Type	Description
ExportType	One of the ExportType enumeration that specifies which portion of the content is exported. The default mode is AllPages.

Remarks

Use this property to control which portion of the content should be exported. This property allows you to choose whether to export the content of the entire tree grid or just the current page's content.

FileName

Gets or sets the file name for the exported file.

Declaration

public string FileName { get; set; }

Property Value

Type	Description
System.String	The string representing the file name.

IncludeHiddenColumn

Gets or sets a value indicating whether hidden columns should be included in the exported PDF document.

Declaration

public bool IncludeHiddenColumn { get; set; }

Property Value

Type	Description
System.Boolean	true if hidden columns should be included in the export; otherwise, false.

Remarks

Hidden columns are typically excluded from the export to simplify the exported content, but you may want to include them if the hidden columns contain important information for the exported content.