A column in the data grid.
InheritanceSystem.Object
IgbDataGridColumn
ImplementsSystem.IDisposable
Namespace: IgniteUI.Blazor.Controls Assembly: IgniteUI.Blazor.dll Syntaxpublic class IgbDataGridColumn : IgbDefinitionBase, JsonSerializable, IDisposable
Constructors IgbDataGridColumn() Declaration
public IgbDataGridColumn()
Properties ActualColumnOptionsIconAlignment
Gets the actual column options icon alignment for this column.
Declarationpublic ColumnOptionsIconAlignment ActualColumnOptionsIconAlignment { get; set; }
Property Value ActualColumnOptionsIconBehavior
Gets or sets how the column option icon will behave in the column header.
Declarationpublic ColumnOptionsIconBehavior ActualColumnOptionsIconBehavior { get; set; }
Property Value ActualColumnOptionsIconColor
Gets the actual column options icon color for this column.
Declarationpublic string ActualColumnOptionsIconColor { get; set; }
Property Value Type Description System.String ActualDeletedTextColor
Gets the actual text color used for deleted rows.
Declarationpublic string ActualDeletedTextColor { get; set; }
Property Value Type Description System.String ActualEditOpacity
Gets the actual opacity for unsaved edited cell values.
Declarationpublic double ActualEditOpacity { get; set; }
Property Value Type Description System.Double ActualHeaderText
Gets the actual text displayed in the header of the column
Declarationpublic string ActualHeaderText { get; set; }
Property Value Type Description System.String ActualHeaderTextChanged Declaration
public EventCallback<string> ActualHeaderTextChanged { get; set; }
Property Value Type Description Microsoft.AspNetCore.Components.EventCallback<System.String> ActualHeaderTextChangedScript Declaration
public string ActualHeaderTextChangedScript { get; set; }
Property Value Type Description System.String ActualHoverBackground
Gets the actual background color that is used for the cells when they are hovered.
Declarationpublic string ActualHoverBackground { get; set; }
Property Value Type Description System.String ActualIsColumnOptionsEnabled
Gets the actual state of the column options for this column.
Declarationpublic bool ActualIsColumnOptionsEnabled { get; set; }
Property Value Type Description System.Boolean ActualIsColumnOptionsGroupingEnabled
Gets the actual state of grouping menu in the column options for this column.
Declarationpublic bool ActualIsColumnOptionsGroupingEnabled { get; set; }
Property Value Type Description System.Boolean ActualIsColumnOptionsSummariesEnabled
Gets the actual state of summaries menu in the column options for this column.
Declarationpublic bool ActualIsColumnOptionsSummariesEnabled { get; set; }
Property Value Type Description System.Boolean ActualRowHoverTextColor
Gets the actual text color that is used for the cells when they are hovered.
Declarationpublic string ActualRowHoverTextColor { get; set; }
Property Value Type Description System.String ActualSelectedBackground
Gets the actual background color that is used for the cells when they are selected
Declarationpublic string ActualSelectedBackground { get; set; }
Property Value Type Description System.String AnimationSettings
Gets or sets the animation settings to use for this column.
Declarationpublic IgbGridColumnAnimationSettings AnimationSettings { get; set; }
Property Value ColumnOptionsIconAlignment
Gets or sets whether the column options icon is aligned opposite the header text or not.
Declarationpublic ColumnOptionsIconAlignment ColumnOptionsIconAlignment { get; set; }
Property Value ColumnOptionsIconBehavior
Gets or sets how the column option icon will behave in the column header.
Declarationpublic ColumnOptionsIconBehavior ColumnOptionsIconBehavior { get; set; }
Property Value ColumnOptionsIconColor
Gets or sets the column options icon color for this column.
Declarationpublic string ColumnOptionsIconColor { get; set; }
Property Value Type Description System.String DataGridParent Declaration
protected BaseRendererControl DataGridParent { get; set; }
Property Value DeletedTextColor
Gets or sets the text color used for deleted rows.
Declarationpublic string DeletedTextColor { get; set; }
Property Value Type Description System.String EditFontFamily Declaration
public string EditFontFamily { get; set; }
Property Value Type Description System.String EditFontSize Declaration
public double EditFontSize { get; set; }
Property Value Type Description System.Double EditFontStyle Declaration
public string EditFontStyle { get; set; }
Property Value Type Description System.String EditFontWeight Declaration
public string EditFontWeight { get; set; }
Property Value Type Description System.String EditOpacity
Gets or sets the opacity to use for unsaved edited cell values.
Declarationpublic double EditOpacity { get; set; }
Property Value Type Description System.Double Field
Gets or sets the key used for the column binding
Declarationpublic string Field { get; set; }
Property Value Type Description System.String Filter
Gets or sets a filter to apply on the values of this column
Declarationpublic IgbColumnFilterCondition Filter { get; set; }
Property Value FilterComparisonType
Gets or sets whether UI filters are case sensitive or not.
Declarationpublic FilterComparisonType FilterComparisonType { get; set; }
Property Value FilterExpression
Gets or sets a filter to apply to the values of this column.
Declarationpublic IgbFilterExpression FilterExpression { get; set; }
Property Value FilterOperands
Gets a list of the current custom filters for this column.
Declarationpublic IgbGridFilterOperandsCollection FilterOperands { get; protected set; }
Property Value FormatCell Declaration
public Action<IgbFormatCellEventArgs> FormatCell { get; set; }
Property Value FormatCellScript Declaration
public string FormatCellScript { get; set; }
Property Value Type Description System.String Header
Gets or sets the header definition for this column.
Declarationpublic IgbHeader Header { get; set; }
Property Value HeaderText
Gets or sets the text displayed in the header of the column
Declarationpublic string HeaderText { get; set; }
Property Value Type Description System.String IsAutoGenerated
Gets whether this column was auto generated.
Declarationpublic bool IsAutoGenerated { get; set; }
Property Value Type Description System.Boolean IsColumnOptionsEnabled
Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to.
Declarationpublic bool IsColumnOptionsEnabled { get; set; }
Property Value Type Description System.Boolean IsColumnOptionsGroupingEnabled
Gets or sets whether to show the grouping option in the column options menu for this column.
Declarationpublic bool IsColumnOptionsGroupingEnabled { get; set; }
Property Value Type Description System.Boolean IsColumnOptionsSummariesEnabled
Gets or sets whether to show the summaries option in the column options menu for this column.
Declarationpublic bool IsColumnOptionsSummariesEnabled { get; set; }
Property Value Type Description System.Boolean IsEditable
Gets or sets if the column is editable.
Declarationpublic bool IsEditable { get; set; }
Property Value Type Description System.Boolean IsFilteringEnabled
Gets or sets whether filtering is enabled for this column.
Declarationpublic bool IsFilteringEnabled { get; set; }
Property Value Type Description System.Boolean IsFromMarkup
Gets whether this column was projected from markup/templates and is constrained.
Declarationpublic bool IsFromMarkup { get; set; }
Property Value Type Description System.Boolean IsHidden
Gets or sets whether or not a column is hidden from the grid
Declarationpublic bool IsHidden { get; set; }
Property Value Type Description System.Boolean IsResizingEnabled
Gets or sets whether resizing is enabled for this column.
Declarationpublic bool IsResizingEnabled { get; set; }
Property Value Type Description System.Boolean MergedCellEvaluationCriteria
Gets or sets how cells are evaluated for merging.
Declarationpublic MergedCellEvaluationCriteria MergedCellEvaluationCriteria { get; set; }
Property Value MergedCellMode
Gets or sets if and how cell merging is performed for this field.
Declarationpublic MergedCellMode MergedCellMode { get; set; }
Property Value MergedCellPaddingBottom
Gets or sets the amount of bottom padding to use for the cell content of this column.
Declarationpublic int MergedCellPaddingBottom { get; set; }
Property Value Type Description System.Int32 MergedCellPaddingLeft
Gets or sets the amount of left padding to use for the cell content for this column.
Declarationpublic int MergedCellPaddingLeft { get; set; }
Property Value Type Description System.Int32 MergedCellPaddingRight
Gets or sets the amount of right padding to use for the cell content of this column.
Declarationpublic int MergedCellPaddingRight { get; set; }
Property Value Type Description System.Int32 MergedCellPaddingTop
Gets or sets the amount of top padding to use for the cell content for this column.
Declarationpublic int MergedCellPaddingTop { get; set; }
Property Value Type Description System.Int32 MergedCellVerticalAlignment
Gets or sets the vertical alignment to use for the merged cell content.
Declarationpublic CellContentVerticalAlignment MergedCellVerticalAlignment { get; set; }
Property Value MinWidth
Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set.
Declarationpublic double MinWidth { get; set; }
Property Value Type Description System.Double PaddingBottom
Gets or sets the amount of bottom padding to use for the cell content of this column.
Declarationpublic int PaddingBottom { get; set; }
Property Value Type Description System.Int32 PaddingLeft
Gets or sets the amount of left padding to use for the cell content for this column.
Declarationpublic int PaddingLeft { get; set; }
Property Value Type Description System.Int32 PaddingRight
Gets or sets the amount of right padding to use for the cell content of this column.
Declarationpublic int PaddingRight { get; set; }
Property Value Type Description System.Int32 PaddingTop
Gets or sets the amount of top padding to use for the cell content for this column.
Declarationpublic int PaddingTop { get; set; }
Property Value Type Description System.Int32 Pinned
Gets or sets the current fixed position for this column.
Declarationpublic PinnedPositions Pinned { get; set; }
Property Value RowHoverBackground
Gets or sets the background color to use for the cells when the row is hovered.
Declarationpublic string RowHoverBackground { get; set; }
Property Value Type Description System.String RowHoverTextColor
Gets or sets the text color to use for the cells when the row is hovered.
Declarationpublic string RowHoverTextColor { get; set; }
Property Value Type Description System.String SelectedBackground
Gets or sets the background color to use for the cells when they are selected
Declarationpublic string SelectedBackground { get; set; }
Property Value Type Description System.String ShouldRemoveWhenHidden
Gets or sets if a column should be removed from the grid when it is fully hidden
Declarationpublic bool ShouldRemoveWhenHidden { get; set; }
Property Value Type Description System.Boolean SortDirection
Gets the current sort direction (None, Ascending, Descending) for this column.
Declarationpublic ColumnSortDirection SortDirection { get; set; }
Property Value Type Declaration
public override string Type { get; }
Property Value Type Description System.String Overrides Width
Gets or sets the width to use for this column.
Declarationpublic IgbColumnWidth Width { get; set; }
Property Value Methods ApplyCustomFilter(String, Int32, Object) Declaration
public virtual void ApplyCustomFilter(string filterID, int index, object value)
Parameters Type Name Description System.String filterID System.Int32 index System.Object value ApplyCustomFilterAsync(String, Int32, Object) Declaration
public virtual Task ApplyCustomFilterAsync(string filterID, int index, object value)
Parameters Type Name Description System.String filterID System.Int32 index System.Object value Returns Type Description System.Threading.Tasks.Task Dispose() Declaration FindByName(String) Declaration
public override object FindByName(string name)
Parameters Type Name Description System.String name Returns Type Description System.Object Overrides 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 GetCurrentActualHeaderText() Declaration
public string GetCurrentActualHeaderText()
Returns Type Description System.String GetCurrentActualHeaderTextAsync() Declaration
public Task<string> GetCurrentActualHeaderTextAsync()
Returns Type Description System.Threading.Tasks.Task<System.String> GetNamedHeaderValue(String) Declaration
public object GetNamedHeaderValue(string valueName)
Parameters Type Name Description System.String valueName Returns Type Description System.Object GetNamedHeaderValueAsync(String)
Gets the value of a named header value for this column by name.
Declarationpublic Task<object> GetNamedHeaderValueAsync(string valueName)
Parameters Type Name Description System.String valueName
Name of the named header value to retrieve.
Returns Type Description System.Threading.Tasks.Task<System.Object> GetUniqueKey() Declarationpublic string GetUniqueKey()
Returns Type Description System.String GetUniqueKeyAsync()
Get the unique key used to identify this column.
Declarationpublic Task<string> GetUniqueKeyAsync()
Returns Type Description System.Threading.Tasks.Task<System.String> HasNamedHeaderValue(String) Declaration
public bool HasNamedHeaderValue(string valueName)
Parameters Type Name Description System.String valueName Returns Type Description System.Boolean HasNamedHeaderValueAsync(String)
Returns if there is a named header value with a given name.
Declarationpublic Task<bool> HasNamedHeaderValueAsync(string valueName)
Parameters Type Name Description System.String valueName
The named value to check for.
Returns Type Description System.Threading.Tasks.Task<System.Boolean> HasNamedHeaderValues() Declarationpublic bool HasNamedHeaderValues()
Returns Type Description System.Boolean HasNamedHeaderValuesAsync()
Returns if the column has named header values.
Declarationpublic Task<bool> HasNamedHeaderValuesAsync()
Returns Type Description System.Threading.Tasks.Task<System.Boolean> OnInitializedAsync() Declaration
protected override Task OnInitializedAsync()
Returns Type Description System.Threading.Tasks.Task RemoveNamedHeaderValue(String) Declaration
public void RemoveNamedHeaderValue(string valueName)
Parameters Type Name Description System.String valueName RemoveNamedHeaderValueAsync(String)
Removes a named header value with the given name from the named header values for this column.
Declarationpublic Task RemoveNamedHeaderValueAsync(string valueName)
Parameters Type Name Description System.String valueName
The named header value to remove.
Returns Type Description System.Threading.Tasks.Task SetNamedHeaderValue(String, CellPropertyAnimationType, Object) Declarationpublic void SetNamedHeaderValue(string valueName, CellPropertyAnimationType animationType, object value)
Parameters SetNamedHeaderValueAsync(String, CellPropertyAnimationType, Object) Declaration
public Task SetNamedHeaderValueAsync(string valueName, CellPropertyAnimationType animationType, object value)
Parameters 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 Implements
System.IDisposable
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4