[]
        
(Showing Draft Content)

C1.Blazor.Grid.GridColumn

GridColumn Class

Represents a grid column.

Namespace: C1.Blazor.Grid
Assembly: C1.Blazor.Grid.dll
Syntax
public class GridColumn : GridRowCol, IComponent, IHandleAfterRender, INotifyPropertyChanged, INotifyPropertyChanging, IHandleEvent, IDisposable

Constructors

Name Description
GridColumn()

Initializes a new instance of the GridColumn class.

GridColumn(PropertyInfo)

Initializes a new instance of the GridColumn class.

Properties

Name Description
ActualHeader

Gets the header that will be shown in the column header. if Header is not specified the Binding property will be used.

ActualWidth

Gets the actual width of the column in pixels.

Aggregate

Gets or sets the type of aggregate to include in group headers.

AggregateFunctions

Gets the collection of aggregate functions.

AllowDragging

Gets or sets a value indicating whether this column can be dragged.

AllowFiltering

Gets or sets a value that indicates whether the user can filter by this column.

AllowGrouping

Gets or sets a value that indicates whether the user can group by this column.

AllowMerging

Gets or sets a value that indicates whether cells in this column can be merged.

AllowResizing

Gets or sets a value indicating whether this column can be resized.

AllowSorting

Gets or sets a value that indicates whether the user can sort this column by tapping the column header.

Background

Gets or sets the C1Color used to paint the background of cells in this column.

Binding

Gets or sets the binding.

CellFactory

Gets the cell-factory.

CellTemplate
ColumnName

Gets or sets a value used as an identifier for the column.

Columns

Gets the columns collection containing this column.

DataMap

Gets or sets the DataMap used to convert raw values into display values for the column.

DataType

Gets the type of the data bound to this column.

FilterLoading

Occurs when the filter of a column is being loaded.

FilterMemberPath

Gets or sets the path used to filter this column.

Foreground

Gets or sets the C1Color used to paint the foreground of cells in this column.

Format

Gets or sets the format applied to the displayed data.

Grid

Gets the grid containing this column.

GridColumnAggregateFunctions
GroupMemberPath

Gets or sets the path used to group this column.

Header

Gets or sets text shown in the header of this column.

HeaderBackground

Gets or sets the C1Color used to paint the background of header cells in this column.

HeaderForeground

Gets or sets the C1Color used to paint the foreground of header cells in this column.

HeaderHorizontalAlignment

Gets or sets the horizontal alignment of the header.

HorizontalAlignment

Gets or sets the horizontal alignment.

InputType

Gets or sets the type of keyboard shown when the cell is in edit-mode.

IsReadOnly

Gets or sets a value indicating whether this column is read only. If the grid is set to be read-only this property will be ignored.

IsVisible

Gets or sets a value indicating whether the column is visible and not collapsed.

MaxWidth

Gets or sets the maximum width of the column.

MinWidth

Gets or sets the minimum width of the column.

OptionsLoading

Occurs when the options of a column are being loaded.

OptionsMenuVisibility

Gets or sets the visibility of the options menu.

PropertyInfo

Gets or sets a PropertyInfo object used for binding the column to items in the data source.

SortDirection

Gets the sort direction when the underlying collection is sorted by the same field as this column's SortMemberPath or Binding.

SortMemberPath

Gets or sets the path used to sort when the column header of this column is tapped.

ValueConverter

Gets or sets an IValueConverter associated with this column's Binding.

Width

Gets or sets the width of the column.

WordWrap

Gets or sets a value indicating whether cells in the column wrap their content.

Methods

Name Description
AllowEditing(GridRow)

Returns true when the cell in the intersection of the specified row and this column can be edited.

BuildRenderTree(RenderTreeBuilder)
CreateBindingFunction(Type, string)

Creates a compiled function to access the property specified by the bindingPath of the itemType.

Dispose()
GetCellContentRenderFragment(GridCellType, GridRow)
GetCellCssClasses(GridCellType, GridRow, C1Thickness)

Gets the CSS classes that will be applied to the cell.

GetCellDisplayValue<T>(GridCellType, GridRow)

Gets the value to display corresponding to the cell in the intersection of the specified row and this column.

GetCellEditorFragment(GridRow, Action<ComponentBase>)

Creates the cell editor fragment.

GetCellText(GridCellType, GridRow)

Gets the text corresponding to the cell in the intersection of the specified row and this column.

GetCellValue(GridCellType, GridRow)

Gets the raw value corresponding to the cell in the intersection of the specified row and this column.

GetCellValue(object)

Gets the value from data item corresponding to this column.

GetEditorValue(GridRow, ComponentBase)

Gets the editor value.

GetMergedRange(GridCellType, GridCellRange, GridRow)

Gets a GridCellRange that specifies the merged extent of a cell.

IsOptionsMenuVisible()

Gets whether the options menu is visible.

OnEditEnded(GridCellRange, GridRow, ComponentBase, bool)

Called before the cell ends editing.

OnInitialized()
PrepareCellStyle(GridCellType, GridRow, C1Style, C1Thickness)

Gets the style that will be applied to the cell.

PrepareOptionsMenu(List<C1MenuItem>, Action, out Task<C1DataFilter>)

Called when the options menu is about to be shown.

Refresh()

Refresh all the cells in the column.

Refresh(GridRowColType, int)

Refresh the cells in the column.

SetCellValue(GridCellType, GridRow, object)

Sets the value corresponding to the cell in the intersection of the specified row and this column.

SetCellValue(object, object)

Sets the specified value to dataItem property related to this column.