Xamarin.Forms

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridCellLayoutEventArgs

    Show / Hide Table of Contents

    Class GridCellLayoutEventArgs

    Represents the abstract class of the GridCellLayoutEventArgs.

    Inheritance
    System.Object
    GridCellLayoutEventArgs
    PdfGridBeginCellLayoutEventArgs
    PdfGridEndCellLayoutEventArgs
    Namespace: Syncfusion.Pdf.Grid
    Assembly: Syncfusion.Pdf.Portable.dll
    Syntax
    public abstract class GridCellLayoutEventArgs : EventArgs
    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)
      End If
    End Sub

    Properties

    Bounds

    Gets the bounds of the cell.

    Declaration
    public RectangleF Bounds { get; }
    Property Value
    Type Description
    RectangleF
    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)
      End If
    End Sub

    CellIndex

    Gets the index of the cell.

    Declaration
    public int CellIndex { get; }
    Property Value
    Type Description
    System.Int32
    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
      //Get the cell index.
      int index = args.CellIndex;
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)
      End If
      'Get the cell index.
      Dim index As Integer = args.CellIndex
    End Sub

    Graphics

    Gets the graphics, on which the cell should be drawn.

    Declaration
    public PdfGraphics Graphics { get; }
    Property Value
    Type Description
    PdfGraphics
    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)
      End If
    End Sub

    IsHeaderRow

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

    RowIndex

    Gets the index of the row.

    Declaration
    public int RowIndex { get; }
    Property Value
    Type Description
    System.Int32
    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)
      End If
    End Sub

    Value

    Gets the value.

    Declaration
    public string Value { get; }
    Property Value
    Type Description
    System.String
    Remarks

    The value might be null or an empty string, which means that either no text were acquired or all text was on the previous page.

    Examples
    // Creates a new document
    PdfDocument doc = new PdfDocument();
    RectangleF rect = new RectangleF(0, 0, 500, 50);
    //Create DataTable for source
    DataTable dataTable = new DataTable("myTable");
    dataTable.Columns.Add("ID1");
    dataTable.Columns[0].Caption = "id";
    dataTable.Columns.Add("ID2");
    object[] values = new object[] { "Roll Number", "Student Name" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Cris" };
    dataTable.Rows.Add(values);
    values = new object[] { "011", "Clay" };
    dataTable.Rows.Add(values);
    PdfPage page = doc.Pages.Add();
    PdfPageTemplateElement top = new PdfPageTemplateElement(rect);
    PdfGrid table = new PdfGrid();
    // Subscribe the cell layout event 
    table.BeginCellLayout += new PdfGridBeginCellLayoutEventHandler(table_BeginCellLayout);
    table.DataSource = dataTable;
    table.Style.CellPadding = 16;
    // Draws the table in page
    table.Draw(page.Graphics);
    doc.Save("Tables.pdf");
    // Cell layout event handler
    void table_BeginCellLayout(object sender, PdfGridBeginCellLayoutEventArgs args)
    {
    //Get the cell value.
    string text = args.Value;
      if (args.RowIndex == 1)
      {
        args.Graphics.DrawRectangle(new PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds);
      }
    }       
    ' Creates a new document
    Dim doc As PdfDocument = New PdfDocument()
    Dim rect As RectangleF = New RectangleF(0, 0, 500, 50)
    'Create DataTable for source
    Dim dataTable As DataTable = New DataTable("myTable")
    dataTable.Columns.Add("ID1")
    dataTable.Columns(0).Caption = "id"
    dataTable.Columns.Add("ID2")
    Dim values() As Object = New Object() { "Roll Number", "Student Name" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Cris" }
    dataTable.Rows.Add(values)
    values = New Object() { "011", "Clay" }
    dataTable.Rows.Add(values)
    Dim page As PdfPage = doc.Pages.Add()
    Dim top As PdfPageTemplateElement = New PdfPageTemplateElement(rect)
    Dim table As PdfGrid = New PdfGrid()
    ' Subscribe the cell layout event 
    AddHandler table.BeginCellLayout, AddressOf table_BeginCellLayout
    table.DataSource = dataTable
    table.Style.CellPadding = 16
    ' Draws the table in page
    table.Draw(page.Graphics)
    doc.Save("Tables.pdf")
    ' Cell layout event handler
    Private Sub table_BeginCellLayout(ByVal sender As Object, ByVal args As PdfGridBeginCellLayoutEventArgs)
      'Get value
      Dim text As String = args.Value
      If args.RowIndex = 1 Then
         args.Graphics.DrawRectangle(New PdfPen(PdfBrushes.Red, 2), PdfBrushes.White,args.Bounds)        ///      
      End If
    End Sub
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved