IgbColumn | Infragistics API Docs

Inheritance

object

ComponentBase

BaseRendererElement

IgbColumn

Classes that extend this class.

Derived Classes

IgbColumnGroup

Implements

IComponent
IHandleEvent
IHandleAfterRender
JsonSerializable
IDisposable

Constructors

constructor

public IgbColumn()

Returns IgbColumn

Properties

IgBlazor

Inherited from: BaseRendererElement

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

IsComponentRooted

Inherited from: BaseRendererElement

public bool IsComponentRooted { get; }

ParentTypeName

Inherited from: BaseRendererElement

protected virtual string ParentTypeName { get; }

UseDirectRender

Inherited from: BaseRendererElement

protected virtual bool UseDirectRender { get; }

ChildContent

Inherited from: BaseRendererElement

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

SupportsVisualChildren

Inherited from: BaseRendererElement

protected virtual bool SupportsVisualChildren { get; }

Name

Inherited from: BaseRendererElement

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

Parent

Inherited from: BaseRendererElement

public object Parent { get; }

MethodTarget

Inherited from: BaseRendererElement

protected virtual string MethodTarget { get; }

CurrParent

Inherited from: BaseRendererElement

protected object CurrParent { get; }

AdditionalTemplateContext

Sets/gets custom properties provided in additional template context.

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

AutosizeHeader

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; }

BodyTemplate

Returns a reference to the bodyTemplate.

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

BodyTemplateScript

Provides a means of setting BodyTemplate in the JavaScript environment.

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

CellClasses

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; }

CellClassesScript

Provides a means of setting CellClasses in the JavaScript environment.

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

CellStyles

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; }

CellStylesScript

Provides a means of setting CellStyles in the JavaScript environment.

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

ColEnd

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; }

ColStart

Column index from which the field is starting.

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

ColumnGroupParent

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

DataType

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

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

DisableHiding

Gets whether the hiding is disabled.

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

DisablePinning

Gets whether the pinning is disabled.

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

DisabledSummaries

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; }

Editable

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

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

EditorOptions

Pass optional properties for the default column editors.

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

ErrorTemplate

Returns a reference to the validation error template.

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

ErrorTemplateScript

Provides a means of setting ErrorTemplate in the JavaScript environment.

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

Field

Sets/gets the field value.

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

FilterCellTemplate

Returns a reference to the filterCellTemplate.

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

FilterCellTemplateScript

Provides a means of setting FilterCellTemplate in the JavaScript environment.

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

Filterable

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

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

FilteringIgnoreCase

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

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

Filters

Gets the column filters.

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

FormatterScript

Provides a means of setting Formatter in the JavaScript environment.

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

GridBaseDirectiveParent

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

Groupable

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

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

HasSummary

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

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

Sets/gets the header value.

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

HeaderClasses

Sets/gets the class selector of the column header.

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

HeaderGroupClasses

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

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

HeaderGroupStyles

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; }

HeaderStyles

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; }

HeaderTemplate

Returns a reference to the header template.

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

HeaderTemplateScript

Provides a means of setting HeaderTemplate in the JavaScript environment.

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

Hidden

Gets whether the column is hidden.

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

HierarchicalGridParent

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

InlineEditorTemplate

Returns a reference to the inline editor template.

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

InlineEditorTemplateScript

Provides a means of setting InlineEditorTemplate in the JavaScript environment.

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

MaxWidth

Sets/gets the maximum width of the column.

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

Merge

Sets/gets whether to merge cells in this column.

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

MinWidth

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

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

ParentColumn

Sets/gets the parent column.

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

Pinned

Gets whether the column is pinned.

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

PinningPosition

Gets the pinning position of the column.

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

PipeArgs

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

Resizable

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

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

RowEnd

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; }

RowIslandParent

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

RowStart

Row index from which the field is starting.

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

Searchable

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

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

Selectable

Returns if the column is selectable.

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

Selected

Returns if the column is selected.

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

SortStrategy

Gets the column sortStrategy.

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

Sortable

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

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

SortingIgnoreCase

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

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

Summaries

Gets the column summaries.

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

SummariesScript

Provides a means of setting Summaries in the JavaScript environment.

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

SummaryFormatterScript

Provides a means of setting SummaryFormatter in the JavaScript environment.

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

SummaryTemplate

Returns a reference to the summaryTemplate.

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

SummaryTemplateScript

Provides a means of setting SummaryTemplate in the JavaScript environment.

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

Title

Sets/gets the title value.

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

Type

public override string Type { get; }

VisibleWhenCollapsed

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

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

Width

Gets the width of the column.

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

Accessors

_name

Inherited from: BaseRendererElement

protected string _name

eventCallbacksCache

Inherited from: BaseRendererElement

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

_cachedSerializedContent

Inherited from: BaseRendererElement

protected string _cachedSerializedContent

Methods

BuildRenderTree(RenderTreeBuilder)

Inherited from: BaseRendererElement

protected override void BuildRenderTree(RenderTreeBuilder builder)

Parameters

builder: RenderTreeBuilder

Returns any

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[])

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[])

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[])

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[])

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

IsPropDirty(string)

Inherited from: BaseRendererElement

protected bool IsPropDirty(string propertyName)

Parameters

propertyName: string

Returns any

Serialize(SerializationContext, string)

Inherited from: BaseRendererElement

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

Parameters

context: SerializationContext
propertyName: string

Returns any

Serialize()

Inherited from: BaseRendererElement

public string Serialize()

Returns any

EnsureValid()

Inherited from: BaseRendererElement

protected void EnsureValid()

Returns any

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)

Inherited from: BaseRendererElement

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

Parameters

grouping: string
json: string

Returns any

Autosize(bool)

public void Autosize(bool byHeaderOnly = false)

Parameters

byHeaderOnly: bool

Returns any

AutosizeAsync(bool)

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

Dispose()

public void Dispose()

Returns any

EnsureModulesLoaded()

protected override void EnsureModulesLoaded()

Returns any

FindByName(string)

public override object FindByName(string name)

Parameters

name: string

Returns any

FromEventJson(BaseRendererControl, Dictionary<string, object>)

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

Parameters

control: BaseRendererControl
args: Dictionary

Returns any

GetChildColumns()

public IgbColumn[] GetChildColumns()

Returns any

GetChildColumnsAsync()

public Task<IgbColumn[]> GetChildColumnsAsync()

Returns any

GetColumnLayoutChild()

public bool GetColumnLayoutChild()

Returns any

GetColumnLayoutChildAsync()

public Task<bool> GetColumnLayoutChildAsync()

Returns any

GetFilteringExpressionsTree()

public IgbFilteringExpressionsTree GetFilteringExpressionsTree()

Returns any

GetFilteringExpressionsTreeAsync()

public Task<IgbFilteringExpressionsTree> GetFilteringExpressionsTreeAsync()

Returns any

GetIndex()

public double GetIndex()

Returns any

GetIndexAsync()

public Task<double> GetIndexAsync()

Returns any

GetLevel()

public double GetLevel()

Returns any

GetLevelAsync()

public Task<double> GetLevelAsync()

Returns any

GetTopLevelParent()

public IgbColumn GetTopLevelParent()

Returns any

GetTopLevelParentAsync()

public Task<IgbColumn> GetTopLevelParentAsync()

Returns any

GetVisibleIndex()

public double GetVisibleIndex()

Returns any

GetVisibleIndexAsync()

public Task<double> GetVisibleIndexAsync()

Returns any

Move(double)

public void Move(double index)

Parameters

index: double

Returns any

MoveAsync(double)

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

OnInitializedAsync()

protected override Task OnInitializedAsync()

Returns any

Pin(double, ColumnPinningPosition?)

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

Parameters

index: double
pinningPosition: ColumnPinningPosition?

Returns any

PinAsync(double, ColumnPinningPosition?)

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

Parameters

index: double
pinningPosition: ColumnPinningPosition?

Returns any

SetNativeElement(object)

public void SetNativeElement(object element)

Parameters

element: object

Returns any

SetNativeElementAsync(object)

public Task SetNativeElementAsync(object element)

Parameters

element: object

Returns any

ToEventJson(BaseRendererControl, Dictionary<string, object>)

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

Parameters

control: BaseRendererControl
args: Dictionary

Returns any

Unpin(double)

public bool Unpin(double index = -1)

Parameters

index: double

Returns any

UnpinAsync(double)

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

Events

ExpandedChange

[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> ExpandedChange { get; set; }

HiddenChange

[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> HiddenChange { get; set; }

PinnedChange

[Parameter]
public EventCallback<IgbComponentBoolValueChangedEventArgs> PinnedChange { get; set; }

WidthChange

[Parameter]
public EventCallback<IgbComponentValueChangedEventArgs> WidthChange { get; set; }

ExpandedChangeScript

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

HiddenChangeScript

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

PinnedChangeScript

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

WidthChangeScript

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