Show / Hide Table of Contents

Class IgbColumnSummaryDescription

Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection.

Inheritance
System.Object
BaseRendererElement
IgbColumnSummaryDescription
Implements
JsonSerializable
Inherited Members
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 IgbColumnSummaryDescription : BaseRendererElement, JsonSerializable

Constructors

IgbColumnSummaryDescription()

Declaration
public IgbColumnSummaryDescription()

Properties

CalculatorDisplayName

Gets or sets the name to use when displaying the calculator name.

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

DisplayFormat

Gets or sets the display format for the summary when in list display mode.

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 name for the summary.

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

Field

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

FormatText

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

FormatTextScript

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

MaxFractionDigits

Gets or sets the maximum fraction digits. If a format is specificied this value is ignored.

Declaration
public int MaxFractionDigits { get; set; }
Property Value
Type Description
System.Int32

Operand

Declaration
public DataSourceSummaryOperand Operand { get; set; }
Property Value
Type Description
DataSourceSummaryOperand

ProvideCalculator

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

ProvideCalculatorScript

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

ShouldDisplay

Gets or sets whether the summary value should be displayed.

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

Type

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

ValueFormat

Gets or sets the format string for the summary 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
BaseRendererElement.EnsureModulesLoaded()

FindByName(String)

Declaration
public override object FindByName(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Object
Overrides
BaseRendererElement.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
BaseRendererElement.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
BaseRendererElement.ToEventJson(BaseRendererControl, Dictionary<String, Object>)

Implements

JsonSerializable