Class PdfAggregateEventArgs

Provides information about an PdfAggregateTemplateInfo event.

Inheritance

object

PdfAggregateEventArgs

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 PdfAggregateEventArgs

Constructors

PdfAggregateEventArgs()

Declaration

public PdfAggregateEventArgs()

Properties

AggregateType

Gets the type of aggregate cell being rendered during Pdf export, enabling customization based on the specific aggregate type.

Declaration

public AggregateTemplateType AggregateType { get; }

Property Value

Type	Description
AggregateTemplateType	The aggregate template type, as defined in AggregateTemplateType.

Remarks

This event applies to all aggregate cells, including GroupCaption, GroupFooter, and Footer. This property enables differentiation of these types for customized rendering.

Examples

The following example shows how to use the AggregateType property to apply custom logic to specific aggregate types in the PdfAggregateTemplateInfo event.

    ...

@code {
    public void PdfAggregateTemplateInfoHandler(Syncfusion.Blazor.Grids.PdfAggregateEventArgs args)
    {
        if (args.AggregateType == AggregateTemplateType.Footer)
        {
            // Custom logic for footer template
        }
    }
}

Cell

Gets the Syncfusion.PdfExport.PdfGridCell object that represents the current cell.

Declaration

public PdfGridCell? Cell { get; set; }

Property Value

Type	Description
PdfGridCell	A PdfGridCell object that represents the current cell.

Column

Gets the aggregate column of the current cell.

Declaration

public GridAggregateColumn? Column { get; }

Property Value

Type	Description
GridAggregateColumn	A GridAggregateColumn object that represents the aggregate column of the current cell.

GroupKey

Gets the key value of the current grouped record, allowing customization of aggregate values for group caption and group footer template cells when exporting data to Pdf.

Declaration

public string? GroupKey { get; }

Property Value

Type	Description
string	A string that represents the key value of the current grouped record. By default, it is an empty string.

Remarks

The GroupKey contains a value only when rendering group caption and group footer template cells in Pdf. Otherwise, it retains its default value, which is an empty string.

Examples

The following example demonstrates how to use the GroupKey to calculate a custom aggregate in the PdfAggregateTemplateInfo event. ........ @code { public void PdfAggregateTemplateInfoHandler(Syncfusion.Blazor.Grids.PdfAggregateEventArgsargs) { args.Cell.Value = Orders .Where(o => o.CustomerID == args.GroupKey) .Sum(o => o.Freight); } }

Style

Gets the Syncfusion.PdfExport.PdfGridCellStyle object that represents the style of the current cell.

Declaration

public PdfGridCellStyle? Style { get; set; }

Property Value

Type	Description
PdfGridCellStyle	A PdfGridCellStyle object that represents the style of the current cell.

Value

Gets the value of the current aggregate cell.

Declaration

public object? Value { get; set; }

Property Value

Type	Description
object	An object that represents the value of the current aggregate cell.