C1GridControl Class

Control used to display, select and edit tabular information.

Inheritance

object

ComponentBase

C1View

C1GridControl

FlexGrid

Implements

INotifyPropertyChanged

Namespace: C1.Blazor.Grid

Assembly: C1.Blazor.GridControl.dll

Syntax

public class C1GridControl : C1View, IComponent, IHandleAfterRender, IDependencyObject, IHandleEvent, IDisposable, INotifyPropertyChanged

Public Class C1GridControl
    Inherits C1View
    Implements IComponent, IHandleAfterRender, IDependencyObject, IHandleEvent, IDisposable, INotifyPropertyChanged

Constructors

Name	Description
C1GridControl()	Initializes a new instance of the C1GridControl class.

Fields

Name	Description
CellStyleProperty	Identifies the CellStyle dependency property.
CursorStyleProperty	Identifies the CursorStyle dependency property.
EditorStyleProperty	Identifies the EditorStyle dependency property.
FrozenLinesBrushProperty	Identifies the FrozenLinesBrush dependency property.
GridLinesBrushProperty	Identifies the GridLinesBrush dependency property.
GridLinesVisibilityProperty	Identifies the GridLinesVisibility dependency property.
GridLinesWidthProperty	Identifies the GridLinesWidth dependency property.
HorizontalScrollBarVisibilityProperty	Identifies the HorizontalScrollBarVisibility dependency property.
KeyActionEnterProperty	Identifies the KeyActionEnter dependency property.
KeyActionTabProperty	Identifies the KeyActionTab dependency property.
MouseOverBrushProperty	Identifies the MouseOverBrush dependency property.
SelectionAdornerBorderBrushProperty	Identifies the SelectionAdornerBorderBrush dependency property.
SelectionAdornerBrushProperty	Identifies the SelectionAdornerBrush dependency property.
SelectionAdornerStyleProperty	Identifies the SelectionAdornerStyle dependency property.
SelectionStyleProperty	Identifies the SelectionStyle dependency property.
ShowMarqueeProperty	Identifies the ShowMarquee dependency property.
VerticalScrollBarVisibilityProperty	Identifies the VerticalScrollBarVisibility dependency property.
ZoomModeProperty	Identifies the ZoomMode dependency property.
_id	The grid's unique id. Allows to resolve ambiguous cases, such as using a css query to find the cell at the composition of the nested grids.

Properties

Name	Description
ActiveEditor	Gets the cell editor that is currently active.
ActualCellStyle	Gets the actual style that will be applied to cells.
ActualCursorStyle	Gets the actual style that will be applied to the cell when the cursor is in it.
ActualEditorStyle	Gets the actual style that will be applied to the editor.
ActualSelectionStyle	Gets the actual style that will be applied to cells when they are selected.
Adapter	Gets or sets the adapter that provides the grid with the cells and editors, dimensions of columns and rows, freezing dragging and resizing capabilities.
CellStyle	Gets or sets the C1Style of the normal cells.
CursorRange	Gets the GridControlRange that corresponds to the cursor cell.
CursorStyle	Gets or sets the C1Style of the cursor cell.
EditorRange	Gets the GridControlRange that corresponds to the cell currently being edited.
EditorStyle	Gets or sets the style applied to the editor.
ExtentHeight	Returns the vertical size of the extent.
ExtentWidth	Returns the horizontal size of the extent.
FrozenLinesBrush	Gets or sets the C1Color that is used to paint the lines between frozen and scrollable areas of the grid.
FullEdit	Gets a value indicating whether the grid is in full edit mode.
GotFocus	Event callback that will be invoked when control gets focus.
GridLinesBrush	Gets or sets the C1Color that is used to paint the lines between cells.
GridLinesVisibility	Gets or sets a value that indicates which grid lines separating inner cells are shown.
GridLinesWidth	Gets or sets the width of the lines between cells.
HorizontalScrollBarVisibility	Gets or sets the horizontal scroll bar visibility.
IsVirtualizationEnabled	Gets or sets whether the ui will be virtualized. Default `true`.
KeyActionEnter	Gets or sets the action to perform when the Enter key is pressed.
KeyActionTab	Gets or sets the action to perform when the Tab key is pressed.
LostFocus	Event callback that will be invoked when control loses focus.
MouseOverBrush	Gets or sets the C1Color that is used to highlight cells when the mouse is over.
ScrollPosition	Gets or sets the scroll position.
SelectedRanges	Gets or sets the currently selected ranges.
Selection	Gets or sets the current selection.
SelectionAdornerBorderBrush	Gets or sets the C1Color of the selection adorner border.
SelectionAdornerBrush	Gets or sets the C1Color of the selection adorner.
SelectionAdornerStyle	Gets or sets the style applied to the selection adorners.
SelectionStyle	Gets or sets the C1Style of the selected cells.
ShowMarquee	Gets or sets a value that indicates whether the grid shows an Excel-style marquee around the current selection.
VerticalScrollBarVisibility	Gets or sets the vertical scroll bar visibility.
ViewRange	Gets a GridControlRange value that indicates the range of cells currently visible on the grid.
Viewport	Gets the current viewport in cell's coordinates.
ZoomMode	Gets or sets the zoom mode.

Methods

Name	Description
BuildRenderTree(RenderTreeBuilder)
ChangeView(double?, double?)	Changes the scroll and zoom of the grid to the specified part of the viewport.
ChangeViewAsync(double?, double?)	Changes the scroll and zoom of the grid to the specified part of the viewport.
Dispose(bool)
FinishEditing(bool)	Commits or cancels any pending edits and exits edit mode.
FinishEditing(bool, bool)	Commits or cancels any pending edits and exits edit mode.
FocusAsync()	Sets the focus in the control.
GetCellStyle()	Gets the style that is applied to the cells.
GetCursorStyle()	Gets the style that is applied to the cell when the cursor is in it.
GetEditorStyle()	Gets the style that is applied to editor.
GetSelectedState(GridControlRange)	Gets a GridSelectedState value that indicates the selected state of the cells in a specified range.
GetSelectedTimes(GridControlRange)	Gets the number of times this range is selected. state of the cells in a specified range.
GetSelectionStyle()	Gets the style that is applied to the cells when they are selected.
InitializeAsync()	This method is called when the component is initialized.
InvalidateCellStyle()	Flags the ActualCellStyle to be created again.
InvalidateCursorStyle()	Flags the ActualCursorStyle to be created again.
InvalidateEditorStyle()	Flags the ActualEditorStyle to be created again.
InvalidateSelectionStyle()	Flags the ActualSelectionStyle to be created again.
LoadDesignTimeData()	Loads dummy design time content visible in Storyboard and Android designer
OnAfterRender(bool)
OnBeginningEdit(GridControlEditEventArgs)	Raises the BeginningEdit event.
OnCellDoubleTapped(GridControlTapEventArgs)	Called when a cell is double tapped.
OnCellEditEnded(GridControlEditEventArgs)	Called when the edit of a cell ended.
OnCellEditEnding(GridControlEditEventArgs)	Raises the CellEditEnding event.
OnCellLongPressed(GridControlTapEventArgs)	Called when a cell is being held.
OnCellTapped(GridControlTapEventArgs)	Called when a cell is tapped.
OnCursorChanged(GridControlRangeEventArgs)	Called after the cursor changed.
OnCursorChanging(GridControlRangeEventArgs)	Called before the cursor changed.
OnPrepareCellForEdit(GridControlEditEventArgs)	Raises the PrepareCellForEdit event.
OnPropertyChanged(string)	Called when a property is changed.
OnScrollPositionChanged(EventArgs)	Called when the scroll position changed.
OnSelectionChanged(GridControlSelectionEventArgs)	Called after the selection changed.
OnSelectionChanging(GridControlSelectionEventArgs)	Called before the selection changed.
Refresh(GridControlRange, bool)	Refreshes the specified `range` of cells asynchronously.
ScrollIntoView(GridControlRange, double, bool)	Scrolls the grid to bring a specified range into view.
Select(GridControlRange, bool, bool)	Selects a given cell and optionally scrolls it into view.
Select(IEnumerable<GridControlRange>, bool, bool)	Selects a collection of cells and optionally scrolls it into view.
SelectAll()	Selects all the cells.
SetCursor(GridControlRange, bool)	Sets the cursor of the grid to the specified row and column.
StartEditing(GridControlRange, bool, bool, bool)	Starts editing a specific cell.
UnselectAll()	Unselects all the cells.

Events

Name	Description
PropertyChanged	Occurs when a property changed.
ScrollPositionChanged	Occurs when scroll position changed.