Show / Hide Table of Contents

Class IgbColumnGroupDescription

Represents an element in the current grouping applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection.

Inheritance
System.Object
BaseRendererElement
IgbColumnSortDescription
IgbColumnGroupDescription
Implements
JsonSerializable
Inherited Members
IgbColumnSortDescription.Field
IgbColumnSortDescription.SortDirection
BaseRendererElement._name
BaseRendererElement.eventCallbacksCache
BaseRendererElement._cachedSerializedContent
BaseRendererElement.BuildRenderTree(RenderTreeBuilder)
BaseRendererElement.OnElementNameChanged(BaseRendererElement, String, String)
BaseRendererElement.InvokeMethod(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodSync(String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelper(String, String, Object[], String[], ElementReference[])
BaseRendererElement.InvokeMethodHelperSync(String, String, Object[], String[], ElementReference[])
BaseRendererElement.IsPropDirty(String)
BaseRendererElement.Serialize(SerializationContext, String)
BaseRendererElement.Serialize()
BaseRendererElement.EnsureValid()
BaseRendererElement.SetResourceStringAsync(String, String, String)
BaseRendererElement.SetResourceStringAsync(String, String)
BaseRendererElement.CompareEventCallbacks<T>(T, T, Dictionary<Type, Dictionary<String, FieldInfo>>)
BaseRendererElement.IgBlazor
BaseRendererElement.IsComponentRooted
BaseRendererElement.ParentTypeName
BaseRendererElement.UseDirectRender
BaseRendererElement.ChildContent
BaseRendererElement.SupportsVisualChildren
BaseRendererElement.Name
BaseRendererElement.Parent
BaseRendererElement.MethodTarget
BaseRendererElement.CurrParent
Namespace: IgniteUI.Blazor.Controls
Assembly: IgniteUI.Blazor.dll
Syntax
public class IgbColumnGroupDescription : IgbColumnSortDescription, JsonSerializable

Constructors

IgbColumnGroupDescription()

Declaration
public IgbColumnGroupDescription()

Properties

DisplayFormat

Gets or sets the display format for the group text in the group header.

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

DisplayFormatSpecifiers

Gets or sets the format specifiers to use with the DisplayFormat string.

Declaration
public IgbFormatSpecifierCollection DisplayFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

DisplayName

Gets or sets the display text for the group name.

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

FormatText

Declaration
public EventCallback<IgbFormatGroupTextEventArgs> FormatText { get; set; }
Property Value
Type Description
Microsoft.AspNetCore.Components.EventCallback<IgbFormatGroupTextEventArgs>

FormatTextScript

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

Type

Declaration
public override string Type { get; }
Property Value
Type Description
System.String
Overrides
IgbColumnSortDescription.Type

ValueFormat

Gets or sets the format string for the group value.

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

ValueFormatSpecifiers

Gets or sets the format specifiers to use with the ValueFormat string.

Declaration
public IgbFormatSpecifierCollection ValueFormatSpecifiers { get; set; }
Property Value
Type Description
IgbFormatSpecifierCollection

Methods

EnsureModulesLoaded()

Declaration
protected override void EnsureModulesLoaded()
Overrides
IgbColumnSortDescription.EnsureModulesLoaded()

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides
IgbColumnSortDescription.FindByName(String)

FromEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides
IgbColumnSortDescription.FromEventJson(BaseRendererControl, Dictionary<String, Object>)

ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Declaration
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)
Parameters
Type Name Description
BaseRendererControl control
System.Collections.Generic.Dictionary<System.String, System.Object> args
Overrides
IgbColumnSortDescription.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Implements

JsonSerializable