C1GridControl Class

Control used to display, select and edit tabular information.

Inheritance

object

C1GridControl

FlexGrid

Implements

INotifyPropertyChanged

Namespace: C1.WPF.Grid

Assembly: C1.WPF.GridControl.dll

Syntax

[StyleTypedProperty(Property = "ScrollTipStyle", StyleTargetType = typeof(ToolTip))]
public class C1GridControl : C1View, INotifyPropertyChanged

<StyleTypedProperty(Property:="ScrollTipStyle", StyleTargetType:=GetType(ToolTip))>
Public Class C1GridControl
    Inherits C1View
    Implements INotifyPropertyChanged

Constructors

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

Fields

Name	Description
CellPaddingProperty	Identifies the CellPadding dependency property.
CellStyleProperty	Identifies the CellStyle dependency property.
CursorStyleProperty	Identifies the CursorStyle 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.
IsAnimatedProperty	Identifies the IsAnimated dependency property.
KeyActionEnterProperty	Identifies the KeyActionEnter dependency property.
KeyActionTabProperty	Identifies the KeyActionTab dependency property.
LostFocusEditModeProperty	Identifies the LostFocusEditMode dependency property.
MouseOverBrushProperty	Identifies the MouseOverBrush dependency property.
ScrollModeProperty	Identifies the ScrollMode dependency property.
ScrollTipStyleProperty	Identifies the ScrollTipStyle dependency property.
SelectionAdornerBorderBrushProperty	Identifies the SelectionAdornerBorderBrush dependency property.
SelectionAdornerBrushProperty	Identifies the SelectionAdornerBrush 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.

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.
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.
CellPadding	Gets or sets the cell padding.
CellStyle	Gets or sets the Style of the normal cells.
CursorRange	Gets the GridControlRange that corresponds to the cursor cell.
CursorStyle	Gets or sets the Style of the cursor cell.
EditorRange	Gets the GridControlRange that corresponds to the cell currently being edited.
ExtentHeight	Returns the vertical size of the extent.
ExtentWidth	Returns the horizontal size of the extent.
FrozenLinesBrush	Gets or sets the Brush 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.
GridLinesBrush	Gets or sets the Brush 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.
IsAnimated	Gets or sets whether the control is animated during navigation.
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.
LostFocusEditMode	Gets or sets the behavior that occurs when the control loses focus while editing.
MouseOverBrush	Gets or sets the Brush that is used to highlight cells when the mouse is over.
ScrollMode	Gets or sets the scroll mode.
ScrollPosition	Gets or sets the scroll position.
ScrollTipStyle	Gets or set the style of the tooltip
SelectedRanges	Gets or sets the currently selected ranges.
Selection	Gets or sets the current selection.
SelectionAdornerBorderBrush	Gets or sets the Brush of the selection adorner border.
SelectionAdornerBrush	Gets or sets the Brush of the selection adorner.
SelectionStyle	Gets or sets the Style of the selected cells.
ShowMarquee	Gets or sets a value that indicates whether the grid shows an Excel-style marquee around the current selection.
UpdateAnimation	Gets an object containing the animation settings that will be applied when updating cells.
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
ChangeView(double?, double?, double?, bool)	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.
GetCellStyle()	Gets the style that is applied to the cells.
GetCellView(GridControlRange)	Gets the cell at the specified `range`.
GetCursorStyle()	Gets the style that is applied to the cell when the cursor is in it.
GetPageImages(GridControlRange, GridScaleMode, Size, int)	Gets a list of elements that represent parts of the grid fit for rendering into pages of a document.
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.
GetSnapHorizontalOffset(double, bool)	Calculates the horizontal offset so the grid snaps to the columns.
GetSnapVerticalOffset(double, bool)	Calculates the vertical offset so the grid snaps to the rows.
GetZoom(GridScaleMode, Size)	Calculates the zoom factor to use based on scale mode, and page size.
InvalidateCellStyle()	Flags the ActualCellStyle to be created again.
InvalidateCursorStyle()	Flags the ActualCursorStyle to be created again.
InvalidateSelectionStyle()	Flags the ActualSelectionStyle to be created again.
IsMouseOverRange(GridControlRange)	Gets or sets whether the cell in the specified range has the mouse over.
LoadDesignTimeData()	Loads dummy design time content visible in Storyboard and Android designer
OnApplyTemplate()
OnBackgroundChanged()
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.
OnKeyDown(KeyEventArgs)
OnPrepareCellForEdit(GridControlEditEventArgs)	Raises the PrepareCellForEdit event.
OnPreviewKeyDown(KeyEventArgs)
OnPreviewLostKeyboardFocus(object, KeyboardFocusChangedEventArgs)	Called when the control is about to lose keyboard focus (preview phase).
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.
OnTextInput(TextCompositionEventArgs)
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.
UpdateMouseOver(GridControlRange)	Updates the mouse-over state of the specified `range`.

Events

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