menu

Blazor

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

    Show / Hide Table of Contents

    Class CaptionTemplateContext

    Class that defines template context detail of CaptionTemplate. CaptionTemplate

    Inheritance
    System.Object
    CaptionTemplateContext
    Namespace: Syncfusion.Blazor.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class CaptionTemplateContext : Object

    Constructors

    CaptionTemplateContext()

    Declaration
    public CaptionTemplateContext()

    Properties

    Count

    Gets count value which specified the number of records in the group.

    Declaration
    public int Count { get; }
    Property Value
    Type
    System.Int32

    Field

    Gets the current group field name.

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

    ForeignKey

    Gets corresponding grouped foreign key value.

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

    ForeignKeyValue

    Gets the current foreign key value name.

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

    GroupAggregates

    Retrieves the aggregate data context for a grouped column.

    Declaration
    public AggregateTemplateContext GroupAggregates { get; }
    Property Value
    Type Description
    AggregateTemplateContext

    An instance of AggregateTemplateContext containing the aggregate values for the grouped column. This object typically includes calculated aggregates such as sum, average, and other values.

    Remarks

    The GroupAggregates property provides access to aggregate information, including field names and corresponding aggregate values, which are useful when columns are grouped. It supports the retrieval of aggregate values for display within the group caption template. Note that these values are available only when the aggregated columns are positioned first. The GroupAggregates property contains values only if the first column has an associated group aggregate.If columns are dynamically hidden, shown, or reordered, and the new first column has a group aggregate, the GroupAggregates context will update to reflect this change. It's important to note that GroupAggregates holds values only when the first column contains an aggregate value.

    GroupGuid

    Gets the group GUID.

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

    HeaderText

    Gets header text of the grouped column.

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

    Key

    Gets grouped data key value.

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

    Level

    Gets depth or level in which the group caption is present.

    Declaration
    public int Level { get; }
    Property Value
    Type
    System.Int32
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved