menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridPdfExportExtension - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridPdfExportExtension

    Class which exports the GridModel to PDF

    Inheritance
    System.Object
    GridPdfExportExtension
    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.Windows.Controls.Grid.Converter
    Assembly: Syncfusion.GridConverter.Wpf.dll
    Syntax
    public static class GridPdfExportExtension

    Methods

    ExportToPdf(GridModel, GridRangeInfo, ExportToPdfOptions)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfGrid ExportToPdf(this GridModel gridModel, GridRangeInfo range, ExportToPdfOptions exportingOptions)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    ExportToPdfOptions exportingOptions

    ExportToPdfOptions holds the Pdf Exporting Options

    Returns
    Type Description
    PdfGrid

    PdfGrid

    ExportToPdfDocument(GridModel, GridRangeInfo, ExportToPdfOptions)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfDocument ExportToPdfDocument(this GridModel gridModel, GridRangeInfo range, ExportToPdfOptions exportingOptions)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    ExportToPdfOptions exportingOptions

    ExportToPdfOptions holds the Pdf Exporting Options

    Returns
    Type Description
    PdfDocument

    PdfGridDocument

    ExportToPdfGrid(GridModel, GridRangeInfo)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfGrid ExportToPdfGrid(this GridModel gridModel, GridRangeInfo range)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    Returns
    Type Description
    PdfGrid

    PdfGrid

    ExportToPdfGrid(GridModel, GridRangeInfo, GridCellExportToPdfHandler)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfGrid ExportToPdfGrid(this GridModel gridModel, GridRangeInfo range, GridCellExportToPdfHandler pdfExportHandler)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    GridCellExportToPdfHandler pdfExportHandler

    Delegate Event handler which fires for every cell before exporting.

    Returns
    Type Description
    PdfGrid

    PdfGrid

    ExportToPdfGridDocument(GridModel, GridRangeInfo)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfDocument ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfGridDocument(GridModel, GridRangeInfo, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfDocument ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, DrawPdfHeaderFooterEventHandler drawPdfHeader, DrawPdfHeaderFooterEventHandler drawPdfFooter)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    DrawPdfHeaderFooterEventHandler drawPdfHeader

    Event Handler which fires before drawing the header.

    DrawPdfHeaderFooterEventHandler drawPdfFooter

    Event Handler which fires before drawing the footer.

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfGridDocument(GridModel, GridRangeInfo, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler, String)

    Exports the GridModel to Pdf.

    Declaration
    public static void ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, DrawPdfHeaderFooterEventHandler drawPdfHeader, DrawPdfHeaderFooterEventHandler drawPdfFooter, string fileName)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    DrawPdfHeaderFooterEventHandler drawPdfHeader

    Event Handler which fires before drawing the header.

    DrawPdfHeaderFooterEventHandler drawPdfFooter

    Event Handler which fires before drawing the footer.

    System.String fileName

    Name of the Pdf file to be saved after exporting.

    ExportToPdfGridDocument(GridModel, GridRangeInfo, GridCellExportToPdfHandler)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfDocument ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, GridCellExportToPdfHandler pdfExportHandler)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    GridCellExportToPdfHandler pdfExportHandler

    Delegate Event handler which fires for every cell before exporting.

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfGridDocument(GridModel, GridRangeInfo, GridCellExportToPdfHandler, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler)

    Exports the GridModel to Pdf.

    Declaration
    public static PdfDocument ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, GridCellExportToPdfHandler pdfExportHandler, DrawPdfHeaderFooterEventHandler drawPdfHeader, DrawPdfHeaderFooterEventHandler drawPdfFooter)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    GridCellExportToPdfHandler pdfExportHandler

    Delegate Event handler which fires for every cell before exporting.

    DrawPdfHeaderFooterEventHandler drawPdfHeader

    Event Handler which fires before drawing the header.

    DrawPdfHeaderFooterEventHandler drawPdfFooter

    Event Handler which fires before drawing the footer.

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfGridDocument(GridModel, GridRangeInfo, GridCellExportToPdfHandler, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler, String)

    Exports the GridModel to Pdf.

    Declaration
    public static void ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, GridCellExportToPdfHandler pdfExportHandler, DrawPdfHeaderFooterEventHandler drawPdfHeader, DrawPdfHeaderFooterEventHandler drawPdfFooter, string fileName)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    GridCellExportToPdfHandler pdfExportHandler

    Delegate Event handler which fires for every cell before exporting.

    DrawPdfHeaderFooterEventHandler drawPdfHeader

    Event Handler which fires before drawing the header.

    DrawPdfHeaderFooterEventHandler drawPdfFooter

    Event Handler which fires before drawing the footer.

    System.String fileName

    Name of the Pdf file to be saved after exporting.

    ExportToPdfGridDocument(GridModel, GridRangeInfo, GridCellExportToPdfHandler, String)

    Exports the GridModel to Pdf.

    Declaration
    public static void ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, GridCellExportToPdfHandler pdfExportHandler, string fileName)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    GridCellExportToPdfHandler pdfExportHandler

    Delegate Event handler which fires for every cell before exporting.

    System.String fileName

    Name of the Pdf file to be saved after exporting.

    ExportToPdfGridDocument(GridModel, GridRangeInfo, String)

    Exports the GridModel to Pdf.

    Declaration
    public static void ExportToPdfGridDocument(this GridModel gridModel, GridRangeInfo range, string fileName)
    Parameters
    Type Name Description
    GridModel gridModel

    GridModel Grid Model

    GridRangeInfo range

    GridRangeInfo The Range to be exported to Pdf

    System.String fileName

    Name of the Pdf file to be saved after exporting.

    ExportToPdfLightTable(GridModel, GridRangeInfo)

    Exports the Grid to PdfLightTable

    Declaration
    public static PdfLightTable ExportToPdfLightTable(this GridModel grid, GridRangeInfo range)
    Parameters
    Type Name Description
    GridModel grid

    GridModel

    GridRangeInfo range

    Specifies the range to be exported to pdf. GridRangeInfo

    Returns
    Type Description
    PdfLightTable

    PdfLightTable

    ExportToPdfLightTableDocument(GridModel, GridRangeInfo)

    Exports the Grid to PdfLightTable

    Declaration
    public static PdfDocument ExportToPdfLightTableDocument(this GridModel grid, GridRangeInfo range)
    Parameters
    Type Name Description
    GridModel grid

    GridModel

    GridRangeInfo range

    Specifies the range to be exported to pdf. GridRangeInfo

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfLightTableDocument(GridModel, GridRangeInfo, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler)

    Exports the Grid to PdfLightTable

    Declaration
    public static PdfDocument ExportToPdfLightTableDocument(this GridModel grid, GridRangeInfo range, DrawPdfHeaderFooterEventHandler headerHandler, DrawPdfHeaderFooterEventHandler footerHandler)
    Parameters
    Type Name Description
    GridModel grid

    GridModel

    GridRangeInfo range

    Specifies the range to be exported to pdf. GridRangeInfo

    DrawPdfHeaderFooterEventHandler headerHandler

    Delegate event handler of type DrawPdfHeaderFooterEventHandler, which fires before drawing header.

    DrawPdfHeaderFooterEventHandler footerHandler

    Delegate event handler of type DrawPdfHeaderFooterEventHandler, which fires before drawing footer.

    Returns
    Type Description
    PdfDocument

    PdfDocument

    ExportToPdfLightTableDocument(GridModel, GridRangeInfo, DrawPdfHeaderFooterEventHandler, DrawPdfHeaderFooterEventHandler, String)

    Exports the Grid to PdfLightTable

    Declaration
    public static void ExportToPdfLightTableDocument(this GridModel grid, GridRangeInfo range, DrawPdfHeaderFooterEventHandler headerHandler, DrawPdfHeaderFooterEventHandler footerHandler, string filename)
    Parameters
    Type Name Description
    GridModel grid

    GridModel

    GridRangeInfo range

    Specifies the range to be exported to pdf. GridRangeInfo

    DrawPdfHeaderFooterEventHandler headerHandler

    Delegate event handler of type DrawPdfHeaderFooterEventHandler, which fires before drawing header.

    DrawPdfHeaderFooterEventHandler footerHandler

    Delegate event handler of type DrawPdfHeaderFooterEventHandler, which fires before drawing footer.

    System.String filename

    FileName, which used to save the pdfdocument after exporting.

    ExportToPdfLightTableDocument(GridModel, GridRangeInfo, String)

    Exports the Grid to PdfLightTable

    Declaration
    public static void ExportToPdfLightTableDocument(this GridModel grid, GridRangeInfo range, string filename)
    Parameters
    Type Name Description
    GridModel grid

    GridModel

    GridRangeInfo range

    Specifies the range to be exported to pdf. GridRangeInfo

    System.String filename

    FileName, which used to save the pdfdocument after exporting.

    Events

    DrawPdfFooter

    Declaration
    public static event DrawPdfHeaderFooterEventHandler DrawPdfFooter
    Event Type
    Type
    DrawPdfHeaderFooterEventHandler

    DrawPdfHeader

    Declaration
    public static event DrawPdfHeaderFooterEventHandler DrawPdfHeader
    Event Type
    Type
    DrawPdfHeaderFooterEventHandler
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved