Class IgbColumn

Inheritance

System.Object

BaseRendererElement

IgbColumn

IgbColumnGroup

Implements

JsonSerializable

System.IDisposable

Inherited Members

BaseRendererElement._name

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.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 IgbColumn : BaseRendererElement, JsonSerializable, IDisposable

Constructors

IgbColumn()

Declaration

public IgbColumn()

Properties

AdditionalTemplateContext

Declaration

public object AdditionalTemplateContext { get; set; }

Property Value

Type	Description
System.Object

AutosizeHeader

Declaration

public bool AutosizeHeader { get; set; }

Property Value

Type	Description
System.Boolean

BodyTemplate

Returns a reference to the bodyTemplate.

let bodyTemplate = this.column.bodyTemplate;

@memberof IgxColumnComponent

Declaration

public RenderFragment<IgbCellTemplateContext> BodyTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbCellTemplateContext>

BodyTemplateScript

Provides a means of setting BodyTemplate in the JavaScript environment.

Declaration

public string BodyTemplateScript { get; set; }

Property Value

Type	Description
System.String

CellClasses

Declaration

public object CellClasses { get; set; }

Property Value

Type	Description
System.Object

CellClassesScript

Provides a means of setting CellClasses in the JavaScript environment.

Declaration

public string CellClassesScript { get; set; }

Property Value

Type	Description
System.String

CellStyles

Declaration

public object CellStyles { get; set; }

Property Value

Type	Description
System.Object

CellStylesScript

Provides a means of setting CellStyles in the JavaScript environment.

Declaration

public string CellStylesScript { get; set; }

Property Value

Type	Description
System.String

ColEnd

Declaration

public double ColEnd { get; set; }

Property Value

Type	Description
System.Double

ColStart

Declaration

public double ColStart { get; set; }

Property Value

Type	Description
System.Double

ColumnGroupParent

Declaration

protected BaseRendererElement ColumnGroupParent { get; set; }

Property Value

Type	Description
BaseRendererElement

DataType

Declaration

public GridColumnDataType DataType { get; set; }

Property Value

Type	Description
GridColumnDataType

DisableHiding

Gets whether the hiding is disabled.

let isHidingDisabled =  this.column.disableHiding;

@memberof IgxColumnComponent

Declaration

public bool DisableHiding { get; set; }

Property Value

Type	Description
System.Boolean

DisablePinning

Gets whether the pinning is disabled.

let isPinningDisabled =  this.column.disablePinning;

@memberof IgxColumnComponent

Declaration

public bool DisablePinning { get; set; }

Property Value

Type	Description
System.Boolean

Editable

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

let isEditable = this.column.editable;

@memberof IgxColumnComponent

Declaration

public bool Editable { get; set; }

Property Value

Type	Description
System.Boolean

EditorOptions

Declaration

public IgbColumnEditorOptions EditorOptions { get; set; }

Property Value

Type	Description
IgbColumnEditorOptions

ErrorTemplate

Returns a reference to the validation error template.

let errorTemplate = this.column.errorTemplate;

Declaration

public RenderFragment<IgbCellTemplateContext> ErrorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbCellTemplateContext>

ErrorTemplateScript

Provides a means of setting ErrorTemplate in the JavaScript environment.

Declaration

public string ErrorTemplateScript { get; set; }

Property Value

Type	Description
System.String

Field

Declaration

public string Field { get; set; }

Property Value

Type	Description
System.String

Filterable

Declaration

public bool Filterable { get; set; }

Property Value

Type	Description
System.Boolean

FilterCellTemplate

Returns a reference to the filterCellTemplate.

let filterCellTemplate = this.column.filterCellTemplate;

@memberof IgxColumnComponent

Declaration

public RenderFragment<IgbColumnTemplateContext> FilterCellTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbColumnTemplateContext>

FilterCellTemplateScript

Provides a means of setting FilterCellTemplate in the JavaScript environment.

Declaration

public string FilterCellTemplateScript { get; set; }

Property Value

Type	Description
System.String

FilteringIgnoreCase

Declaration

public bool FilteringIgnoreCase { get; set; }

Property Value

Type	Description
System.Boolean

Filters

Gets the column filters.

let columnFilters = this.column.filters&apos;

@memberof IgxColumnComponent

Declaration

public IgbFilteringOperand Filters { get; set; }

Property Value

Type	Description
IgbFilteringOperand

FormatterScript

Declaration

public string FormatterScript { get; set; }

Property Value

Type	Description
System.String

GridBaseDirectiveParent

Declaration

protected BaseRendererControl GridBaseDirectiveParent { get; set; }

Property Value

Type	Description
BaseRendererControl

Groupable

Declaration

public bool Groupable { get; set; }

Property Value

Type	Description
System.Boolean

HasSummary

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

let hasSummary = this.column.hasSummary;

@memberof IgxColumnComponent

Declaration

public bool HasSummary { get; set; }

Property Value

Type	Description
System.Boolean

Header

Declaration

public string Header { get; set; }

Property Value

Type	Description
System.String

HeaderClasses

Declaration

public string HeaderClasses { get; set; }

Property Value

Type	Description
System.String

HeaderGroupClasses

Declaration

public string HeaderGroupClasses { get; set; }

Property Value

Type	Description
System.String

HeaderGroupStyles

Declaration

public object HeaderGroupStyles { get; set; }

Property Value

Type	Description
System.Object

HeaderStyles

Declaration

public object HeaderStyles { get; set; }

Property Value

Type	Description
System.Object

HeaderTemplate

Returns a reference to the header template.

let headerTemplate = this.column.headerTemplate;

@memberof IgxColumnComponent

Declaration

public RenderFragment<IgbColumnTemplateContext> HeaderTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbColumnTemplateContext>

HeaderTemplateScript

Provides a means of setting HeaderTemplate in the JavaScript environment.

Declaration

public string HeaderTemplateScript { get; set; }

Property Value

Type	Description
System.String

Hidden

Gets whether the column is hidden.

let isHidden = this.column.hidden;

@memberof IgxColumnComponent

Declaration

public bool Hidden { get; set; }

Property Value

Type	Description
System.Boolean

HierarchicalGridParent

Declaration

protected BaseRendererControl HierarchicalGridParent { get; set; }

Property Value

Type	Description
BaseRendererControl

InlineEditorTemplate

Returns a reference to the inline editor template.

let inlineEditorTemplate = this.column.inlineEditorTemplate;

@memberof IgxColumnComponent

Declaration

public RenderFragment<IgbCellTemplateContext> InlineEditorTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbCellTemplateContext>

InlineEditorTemplateScript

Provides a means of setting InlineEditorTemplate in the JavaScript environment.

Declaration

public string InlineEditorTemplateScript { get; set; }

Property Value

Type	Description
System.String

MaxWidth

Declaration

public string MaxWidth { get; set; }

Property Value

Type	Description
System.String

MinWidth

Declaration

public string MinWidth { get; set; }

Property Value

Type	Description
System.String

ParentColumn

Sets/gets the parent column.

let parentColumn = this.column.parent;

this.column.parent = higherLevelColumn;

@memberof IgxColumnComponent

Declaration

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

Property Value

Type	Description
System.Object

Pinned

Gets whether the column is pinned.

let isPinned = this.column.pinned;

@memberof IgxColumnComponent

Declaration

public bool Pinned { get; set; }

Property Value

Type	Description
System.Boolean

PipeArgs

Declaration

public IgbColumnPipeArgs PipeArgs { get; set; }

Property Value

Type	Description
IgbColumnPipeArgs

Resizable

Declaration

public bool Resizable { get; set; }

Property Value

Type	Description
System.Boolean

RowEnd

Declaration

public double RowEnd { get; set; }

Property Value

Type	Description
System.Double

RowIslandParent

Declaration

protected BaseRendererElement RowIslandParent { get; set; }

Property Value

Type	Description
BaseRendererElement

RowStart

Declaration

public double RowStart { get; set; }

Property Value

Type	Description
System.Double

Searchable

Declaration

public bool Searchable { get; set; }

Property Value

Type	Description
System.Boolean

Selectable

Returns if the column is selectable.

let columnSelectable = this.column.selectable;

@memberof IgxColumnComponent

Declaration

public bool Selectable { get; set; }

Property Value

Type	Description
System.Boolean

Selected

Returns if the column is selected.

let isSelected = this.column.selected;

@memberof IgxColumnComponent

Declaration

public bool Selected { get; set; }

Property Value

Type	Description
System.Boolean

Sortable

Declaration

public bool Sortable { get; set; }

Property Value

Type	Description
System.Boolean

SortingIgnoreCase

Declaration

public bool SortingIgnoreCase { get; set; }

Property Value

Type	Description
System.Boolean

SortStrategy

Gets the column sortStrategy.

let sortStrategy = this.column.sortStrategy

@memberof IgxColumnComponent

Declaration

public IgbSortingStrategy SortStrategy { get; set; }

Property Value

Type	Description
IgbSortingStrategy

Summaries

Gets the column summaries.

let columnSummaries = this.column.summaries;

@memberof IgxColumnComponent

Declaration

public object Summaries { get; set; }

Property Value

Type	Description
System.Object

SummariesScript

Declaration

public string SummariesScript { get; set; }

Property Value

Type	Description
System.String

SummaryFormatterScript

Declaration

public string SummaryFormatterScript { get; set; }

Property Value

Type	Description
System.String

SummaryTemplate

Returns a reference to the summaryTemplate.

let summaryTemplate = this.column.summaryTemplate;

@memberof IgxColumnComponent

Declaration

public RenderFragment<IgbSummaryTemplateContext> SummaryTemplate { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment<IgbSummaryTemplateContext>

SummaryTemplateScript

Provides a means of setting SummaryTemplate in the JavaScript environment.

Declaration

public string SummaryTemplateScript { get; set; }

Property Value

Type	Description
System.String

Title

Declaration

public string Title { get; set; }

Property Value

Type	Description
System.String

Type

Declaration

public override string Type { get; }

Property Value

Type	Description
System.String

Overrides

BaseRendererElement.Type

VisibleWhenCollapsed

Declaration

public bool VisibleWhenCollapsed { get; set; }

Property Value

Type	Description
System.Boolean

Width

Gets the width of the column.

let columnWidth = this.column.width;

@memberof IgxColumnComponent

Declaration

public string Width { get; set; }

Property Value

Type	Description
System.String

Methods

Autosize(Boolean)

Declaration

public void Autosize(bool byHeaderOnly = false)

Parameters

Type	Name	Description
System.Boolean	byHeaderOnly

AutosizeAsync(Boolean)

Autosize the column to the longest currently visible cell value, including the header cell.

@ViewChild(&apos;grid&apos;) grid: IgxGridComponent;
let column = this.grid.columnList.filter(c => c.field === &apos;ID&apos;)[0];
column.autosize();

@memberof IgxColumnComponent byHeaderOnly Set if column should be autosized based only on the header content.

Declaration

public Task AutosizeAsync(bool byHeaderOnly = false)

Parameters

Type	Name	Description
System.Boolean	byHeaderOnly	Set if column should be autosized based only on the header content.

Returns

Type	Description
System.Threading.Tasks.Task

Dispose()

Declaration

public void Dispose()

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

GetChildColumns()

Declaration

public IgbColumn[] GetChildColumns()

Returns

Type	Description
IgbColumn[]

GetChildColumnsAsync()

Declaration

public Task<IgbColumn[]> GetChildColumnsAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbColumn[]>

GetColumnLayoutChild()

Declaration

public bool GetColumnLayoutChild()

Returns

Type	Description
System.Boolean

GetColumnLayoutChildAsync()

Declaration

public Task<bool> GetColumnLayoutChildAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

GetFilteringExpressionsTree()

Declaration

public IgbFilteringExpressionsTree GetFilteringExpressionsTree()

Returns

Type	Description
IgbFilteringExpressionsTree

GetFilteringExpressionsTreeAsync()

Declaration

public Task<IgbFilteringExpressionsTree> GetFilteringExpressionsTreeAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbFilteringExpressionsTree>

GetIndex()

Declaration

public double GetIndex()

Returns

Type	Description
System.Double

GetIndexAsync()

Declaration

public Task<double> GetIndexAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

GetLevel()

Declaration

public double GetLevel()

Returns

Type	Description
System.Double

GetLevelAsync()

Declaration

public Task<double> GetLevelAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

GetTopLevelParent()

Declaration

public IgbColumn GetTopLevelParent()

Returns

Type	Description
IgbColumn

GetTopLevelParentAsync()

Declaration

public Task<IgbColumn> GetTopLevelParentAsync()

Returns

Type	Description
System.Threading.Tasks.Task<IgbColumn>

GetVisibleIndex()

Declaration

public double GetVisibleIndex()

Returns

Type	Description
System.Double

GetVisibleIndexAsync()

Declaration

public Task<double> GetVisibleIndexAsync()

Returns

Type	Description
System.Threading.Tasks.Task<System.Double>

Move(Double)

Declaration

public void Move(double index)

Parameters

Type	Name	Description
System.Double	index

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. @example

column.move(index);

@memberof IgxColumnComponent

Declaration

public Task MoveAsync(double index)

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Threading.Tasks.Task

OnInitializedAsync()

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
System.Threading.Tasks.Task

Pin(Double)

Declaration

public bool Pin(double index = -1)

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Boolean

PinAsync(Double)

Pins the column at the provided index in the pinned area. Defaults to index 0 if not provided, or to the initial index in the pinned area. Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. Column cannot be pinned if:

Is already pinned
index argument is out of range
The pinned area exceeds 80% of the grid width

let success = this.column.pin();

@memberof IgxColumnComponent

Declaration

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

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

SetNativeElement(Object)

Declaration

public void SetNativeElement(object element)

Parameters

Type	Name	Description
System.Object	element

SetNativeElementAsync(Object)

Declaration

public Task SetNativeElementAsync(object element)

Parameters

Type	Name	Description
System.Object	element

Returns

Type	Description
System.Threading.Tasks.Task

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

Unpin(Double)

Declaration

public bool Unpin(double index = -1)

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Boolean

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

let success = this.column.unpin();

@memberof IgxColumnComponent

Declaration

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

Parameters

Type	Name	Description
System.Double	index

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>

Implements

JsonSerializable

System.IDisposable