Ignite UI for Angular Column Group

Inheritance

Classes that extend this class.

Derived Classes
Implements
  • IComponent
  • IHandleEvent
  • IHandleAfterRender
  • JsonSerializable
  • IDisposable

constructor

public IgbColumnGroup()

Returns IgbColumnGroup

Inherited from: IgbColumn

[CascadingParameter(Name = "GridBaseDirectiveParent")]
protected BaseRendererControl GridBaseDirectiveParent { get; set; }

Inherited from: IgbColumn

[CascadingParameter(Name = "RowIslandParent")]
protected BaseRendererElement RowIslandParent { get; set; }

Inherited from: IgbColumn

[CascadingParameter(Name = "HierarchicalGridParent")]
protected BaseRendererControl HierarchicalGridParent { get; set; }

Inherited from: IgbColumn

[CascadingParameter(Name = "ColumnGroupParent")]
protected BaseRendererElement ColumnGroupParent { get; set; }

Inherited from: IgbColumn

Sets/gets the field value.

[Parameter]
public string Field { get; set; }

Inherited from: IgbColumn

Sets/gets whether to merge cells in this column.

[Parameter]
public bool Merge { get; set; }

Inherited from: IgbColumn

Sets/gets the header value.

[Parameter]
public string Header { get; set; }

Inherited from: IgbColumn

Sets/gets the title value.

[Parameter]
public string Title { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column is sortable. Default value is false.

[Parameter]
public bool Sortable { get; set; }

Inherited from: IgbColumn

Returns if the column is selectable.

[Parameter]
public bool Selectable { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column is groupable. Default value is false.

[Parameter]
public bool Groupable { get; set; }

Inherited from: IgbColumn

Gets whether the column is editable. Default value is false.

[Parameter]
public bool Editable { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column is filterable. Default value is true.

[Parameter]
public bool Filterable { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column is resizable. Default value is false.

[Parameter]
public bool Resizable { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column header is included in autosize logic. Useful when template for a column header is sized based on parent, for example a default div. Default value is false.

[Parameter]
public bool AutosizeHeader { get; set; }

Inherited from: IgbColumn

Gets a value indicating whether the summary for the column is enabled.

[Parameter]
public bool HasSummary { get; set; }

Inherited from: IgbColumn

Gets whether the column is hidden.

[Parameter]
public bool Hidden { get; set; }

Inherited from: IgbColumn

Returns if the column is selected.

[Parameter]
public bool Selected { get; set; }

Inherited from: IgbColumn

Gets whether the hiding is disabled.

[Parameter]
public bool DisableHiding { get; set; }

Inherited from: IgbColumn

Gets whether the pinning is disabled.

[Parameter]
public bool DisablePinning { get; set; }

Inherited from: IgbColumn

Gets the width of the column.

[Parameter]
public string Width { get; set; }

Inherited from: IgbColumn

Sets/gets the maximum width of the column.

[Parameter]
public string MaxWidth { get; set; }

Inherited from: IgbColumn

Sets/gets the class selector of the column header.

[Parameter]
public string HeaderClasses { get; set; }

Inherited from: IgbColumn

Sets conditional style properties on the column header. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

[Parameter]
public object HeaderStyles { get; set; }

Inherited from: IgbColumn

Sets/gets the class selector of the column group header.

[Parameter]
public string HeaderGroupClasses { get; set; }

Inherited from: IgbColumn

Sets conditional style properties on the column header group wrapper. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated.

[Parameter]
public object HeaderGroupStyles { get; set; }

Inherited from: IgbColumn

Sets a conditional class selector of the column cells. Accepts an object literal, containing key-value pairs, where the key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean, like so:

[Parameter]
public object CellClasses { get; set; }

Inherited from: IgbColumn

Provides a means of setting CellClasses in the JavaScript environment.

[Parameter]
public string CellClassesScript { get; set; }

Inherited from: IgbColumn

Sets conditional style properties on the column cells. Similar to ngStyle it accepts an object literal where the keys are the style properties and the value is the expression to be evaluated. As with cellClasses it accepts a callback function.

[Parameter]
public object CellStyles { get; set; }

Inherited from: IgbColumn

Provides a means of setting CellStyles in the JavaScript environment.

[Parameter]
public string CellStylesScript { get; set; }

Inherited from: IgbColumn

Provides a means of setting Formatter in the JavaScript environment.

[Parameter]
public string FormatterScript { get; set; }

Inherited from: IgbColumn

Provides a means of setting SummaryFormatter in the JavaScript environment.

[Parameter]
public string SummaryFormatterScript { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column filtering should be case sensitive. Default value is true.

[Parameter]
public bool FilteringIgnoreCase { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column sorting should be case sensitive. Default value is true.

[Parameter]
public bool SortingIgnoreCase { get; set; }

Inherited from: IgbColumn

Sets/gets whether the column is searchable. Default value is true.

[Parameter]
public bool Searchable { get; set; }

Inherited from: IgbColumn

Sets/gets the data type of the column values. Default value is string.

[Parameter]
public GridColumnDataType DataType { get; set; }

Inherited from: IgbColumn

Row index where the current field should end. The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field

[Parameter]
public double RowEnd { get; set; }

Inherited from: IgbColumn

Column index where the current field should end. The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field

[Parameter]
public double ColEnd { get; set; }

Inherited from: IgbColumn

Row index from which the field is starting.

[Parameter]
public double RowStart { get; set; }

Inherited from: IgbColumn

Column index from which the field is starting.

[Parameter]
public double ColStart { get; set; }

Inherited from: IgbColumn

Sets/gets custom properties provided in additional template context.

[Parameter]
public object AdditionalTemplateContext { get; set; }

Inherited from: IgbColumn

Sets/gets the minimum width of the column. Default value is 88;

[Parameter]
public string MinWidth { get; set; }

Inherited from: IgbColumn

Gets the pinning position of the column.

[Parameter]
public ColumnPinningPosition PinningPosition { get; set; }

Inherited from: IgbColumn

Gets whether the column is pinned.

[Parameter]
public bool Pinned { get; set; }

Inherited from: IgbColumn

Gets the column summaries.

[Parameter]
public object Summaries { get; set; }

Inherited from: IgbColumn

Provides a means of setting Summaries in the JavaScript environment.

[Parameter]
public string SummariesScript { get; set; }

Inherited from: IgbColumn

Sets/gets the summary operands to exclude from display. Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc.

[Parameter]
public string[] DisabledSummaries { get; set; }

Inherited from: IgbColumn

Gets the column filters.

[Parameter]
public IgbFilteringOperand Filters { get; set; }

Inherited from: IgbColumn

Gets the column sortStrategy.

[Parameter]
public IgbSortingStrategy SortStrategy { get; set; }

Inherited from: IgbColumn

Returns a reference to the summaryTemplate.

[Parameter]
public RenderFragment<IgbSummaryTemplateContext> SummaryTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting SummaryTemplate in the JavaScript environment.

[Parameter]
public string SummaryTemplateScript { get; set; }

Inherited from: IgbColumn

Returns a reference to the bodyTemplate.

[Parameter]
public RenderFragment<IgbCellTemplateContext> BodyTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting BodyTemplate in the JavaScript environment.

[Parameter]
public string BodyTemplateScript { get; set; }

Inherited from: IgbColumn

Returns a reference to the header template.

[Parameter]
public RenderFragment<IgbColumnTemplateContext> HeaderTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting HeaderTemplate in the JavaScript environment.

[Parameter]
public string HeaderTemplateScript { get; set; }

Inherited from: IgbColumn

Returns a reference to the inline editor template.

[Parameter]
public RenderFragment<IgbCellTemplateContext> InlineEditorTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting InlineEditorTemplate in the JavaScript environment.

[Parameter]
public string InlineEditorTemplateScript { get; set; }

Inherited from: IgbColumn

Returns a reference to the validation error template.

[Parameter]
public RenderFragment<IgbCellTemplateContext> ErrorTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting ErrorTemplate in the JavaScript environment.

[Parameter]
public string ErrorTemplateScript { get; set; }

Inherited from: IgbColumn

Returns a reference to the filterCellTemplate.

[Parameter]
public RenderFragment<IgbColumnTemplateContext> FilterCellTemplate { get; set; }

Inherited from: IgbColumn

Provides a means of setting FilterCellTemplate in the JavaScript environment.

[Parameter]
public string FilterCellTemplateScript { get; set; }

Inherited from: IgbColumn

Indicates whether the column will be visible when its parent is collapsed.

[Parameter]
public bool VisibleWhenCollapsed { get; set; }

Inherited from: IgbColumn

[Parameter]
public IgbColumnPipeArgs PipeArgs { get; set; }

Inherited from: IgbColumn

Pass optional properties for the default column editors.

[Parameter]
public IgbColumnEditorOptions EditorOptions { get; set; }

Inherited from: IgbColumn

Sets/gets the parent column.

[Parameter]
[WCWidgetMemberName("Parent")]
public object ParentColumn { get; set; }

Inherited from: BaseRendererElement

[Inject]
protected IIgniteUIBlazor IgBlazor { get; set; }

Inherited from: BaseRendererElement

public bool IsComponentRooted { get; }

Inherited from: BaseRendererElement

protected virtual bool UseDirectRender { get; }

Inherited from: BaseRendererElement

[Parameter]
public RenderFragment ChildContent { get; set; }

Inherited from: BaseRendererElement

protected virtual bool SupportsVisualChildren { get; }

Inherited from: BaseRendererElement

[Parameter]
public string Name { get; set; }

Inherited from: BaseRendererElement

public object Parent { get; }

Inherited from: BaseRendererElement

protected virtual string MethodTarget { get; }

Inherited from: BaseRendererElement

protected object CurrParent { get; }
public IgbColumnCollection ActualChildren { get; }
public IgbColumnCollection Children { get; protected set; }

Set if the column group is collapsible. Default value is false

[Parameter]
public bool Collapsible { get; set; }

Allows you to define a custom template for expand/collapse indicator

[Parameter]
public RenderFragment<IgbColumnTemplateContext> CollapsibleIndicatorTemplate { get; set; }

Provides a means of setting CollapsibleIndicatorTemplate in the JavaScript environment.

[Parameter]
public string CollapsibleIndicatorTemplateScript { get; set; }
public IgbColumnCollection ContentChildren { get; }

Set whether the group is expanded or collapsed initially. Applied only if the collapsible property is set to true Default value is true

[Parameter]
public bool Expanded { get; set; }
protected override string ParentTypeName { get; }
public override string Type { get; }

Inherited from: BaseRendererElement

protected string _name

Inherited from: BaseRendererElement

protected Dictionary<Type, Dictionary<string, FieldInfo>> eventCallbacksCache

Inherited from: BaseRendererElement

protected string _cachedSerializedContent

Inherited from: IgbColumn

public void Dispose()

Returns any

Inherited from: IgbColumn

protected override Task OnInitializedAsync()

Returns any

Inherited from: IgbColumn

public Task<double> GetIndexAsync()

Returns any

Inherited from: IgbColumn

public double GetIndex()

Returns any

Inherited from: IgbColumn

public Task<double> GetVisibleIndexAsync()

Returns any

Inherited from: IgbColumn

public double GetVisibleIndex()

Returns any

Inherited from: IgbColumn

public Task<bool> GetColumnLayoutChildAsync()

Returns any

Inherited from: IgbColumn

public bool GetColumnLayoutChild()

Returns any

Inherited from: IgbColumn

public Task<IgbColumn[]> GetChildColumnsAsync()

Returns any

Inherited from: IgbColumn

public IgbColumn[] GetChildColumns()

Returns any

Inherited from: IgbColumn

public Task<double> GetLevelAsync()

Returns any

Inherited from: IgbColumn

public double GetLevel()

Returns any

Inherited from: IgbColumn

public Task<IgbFilteringExpressionsTree> GetFilteringExpressionsTreeAsync()

Returns any

Inherited from: IgbColumn

public IgbFilteringExpressionsTree GetFilteringExpressionsTree()

Returns any

Inherited from: IgbColumn

public Task<IgbColumn> GetTopLevelParentAsync()

Returns any

Inherited from: IgbColumn

public IgbColumn GetTopLevelParent()

Returns any

Inherited from: IgbColumn

public Task SetNativeElementAsync(object element)

Parameters

  • element: object

Returns any

Inherited from: IgbColumn

public void SetNativeElement(object element)

Parameters

  • element: object

Returns any

PinAsync(double, ColumnPinningPosition?)

Section titled "PinAsync(double, ColumnPinningPosition?)"

Inherited from: IgbColumn

public Task<bool> PinAsync(double index = -1, ColumnPinningPosition? pinningPosition = null)

Parameters

  • index: double
  • pinningPosition: ColumnPinningPosition?

Returns any

Pin(double, ColumnPinningPosition?)

Section titled "Pin(double, ColumnPinningPosition?)"

Inherited from: IgbColumn

public bool Pin(double index = -1, ColumnPinningPosition? pinningPosition = null)

Parameters

  • index: double
  • pinningPosition: ColumnPinningPosition?

Returns any

Inherited from: IgbColumn

Unpins the column and place it at the provided index in the unpinned area. Defaults to index 0 if not provided, or to the initial index in the unpinned area. Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. Column cannot be unpinned if: Is already unpinned index argument is out of range

public Task<bool> UnpinAsync(double index = -1)

Parameters

  • index: double

Returns any

Inherited from: IgbColumn

public bool Unpin(double index = -1)

Parameters

  • index: double

Returns any

Inherited from: IgbColumn

Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed.

public Task MoveAsync(double index)

Parameters

  • index: double

Returns any

Inherited from: IgbColumn

public void Move(double index)

Parameters

  • index: double

Returns any

Inherited from: IgbColumn

Autosize the column to the longest currently visible cell value, including the header cell. byHeaderOnly Set if column should be autosized based only on the header content.

public Task AutosizeAsync(bool byHeaderOnly = false)

Parameters

  • byHeaderOnly: bool

Returns any

Inherited from: IgbColumn

public void Autosize(bool byHeaderOnly = false)

Parameters

  • byHeaderOnly: bool

Returns any

Inherited from: BaseRendererElement

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

  • builder: RenderTreeBuilder

Returns any

OnElementNameChanged(BaseRendererElement, string, string)

Section titled "OnElementNameChanged(BaseRendererElement, string, string)"

Inherited from: BaseRendererElement

protected void OnElementNameChanged(BaseRendererElement element, string oldName, string newName)

Parameters

  • element: BaseRendererElement
  • oldName: string
  • newName: string

Returns any

InvokeMethod(string, object[], string[], ElementReference[])

Section titled "InvokeMethod(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethod(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodSync(string, object[], string[], ElementReference[])

Section titled "InvokeMethodSync(string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodSync(string methodName, object[] arguments, string[] types, ElementReference[] nativeElements = null)

Parameters

  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelper(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelper(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected Task<object> InvokeMethodHelper(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])

Section titled "InvokeMethodHelperSync(string, string, object[], string[], ElementReference[])"

Inherited from: BaseRendererElement

protected object InvokeMethodHelperSync(string target, string methodName, object[] arguments, string[] types, ElementReference[] nativeElements)

Parameters

  • target: string
  • methodName: string
  • arguments: object[]
  • types: string[]
  • nativeElements: ElementReference[]

Returns any

Inherited from: BaseRendererElement

protected bool IsPropDirty(string propertyName)

Parameters

  • propertyName: string

Returns any

Serialize(SerializationContext, string)

Section titled "Serialize(SerializationContext, string)"

Inherited from: BaseRendererElement

public void Serialize(SerializationContext context, string propertyName = null)

Parameters

  • context: SerializationContext
  • propertyName: string

Returns any

Inherited from: BaseRendererElement

public string Serialize()

Returns any

Inherited from: BaseRendererElement

protected void EnsureValid()

Returns any

SetResourceStringAsync(string, string, string)

Section titled "SetResourceStringAsync(string, string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string id, string value)

Parameters

  • grouping: string
  • id: string
  • value: string

Returns any

SetResourceStringAsync(string, string)

Section titled "SetResourceStringAsync(string, string)"

Inherited from: BaseRendererElement

protected Task<object> SetResourceStringAsync(string grouping, string json)

Parameters

  • grouping: string
  • json: string

Returns any

protected override void EnsureModulesLoaded()

Returns any

public override object FindByName(string name)

Parameters

  • name: string

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "FromEventJson(BaseRendererControl, Dictionary<string, object>)"
protected override void FromEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

Section titled "ToEventJson(BaseRendererControl, Dictionary<string, object>)"
protected override void ToEventJson(BaseRendererControl control, Dictionary<string, object> args)

Parameters

  • control: BaseRendererControl
  • args: Dictionary

Returns any

[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> HiddenChange { get; set; }
[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> ExpandedChange { get; set; }
[Parameter]
public EventCallback<IgbComponentValueChangedEventArgs> WidthChange { get; set; }
[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> PinnedChange { get; set; }
[Parameter]
public string HiddenChangeScript { get; set; }
[Parameter]
public string ExpandedChangeScript { get; set; }
[Parameter]
public string WidthChangeScript { get; set; }
[Parameter]
public string PinnedChangeScript { get; set; }