WPF

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridControlBase

    Show / Hide Table of Contents

    Class GridControlBase

    Implements a grid control that displays a grid model.

    Inheritance
    System.Object
    VisualContainer
    ScrollControl
    ScrollAxisControl
    VirtualizingCellsControl
    GridControlBase
    GridCellNestedGridEditor
    GridControl
    GridDataControlBaseImpl
    GridDataGroupDropAreaGridImpl
    GridListControlImpl
    PivotGridControlBase
    OlapGridBase
    Implements
    IScrollBarProvider
    System.Windows.Controls.Primitives.IScrollInfo
    System.IDisposable
    IGridPrintPaginator
    Inherited Members
    VirtualizingCellsControl.floatcellran
    VirtualizingCellsControl.CellsControlProperty
    VirtualizingCellsControl.CellUIElementProperty
    VirtualizingCellsControl.ArrangeCellArgsProperty
    VirtualizingCellsControl.CellRowColumnIndexProperty
    VirtualizingCellsControl.RenderCellInfoProperty
    VirtualizingCellsControl.CellRendererProperty
    VirtualizingCellsControl.ShowGridLinesProperty
    VirtualizingCellsControl.GetCellsControl(DependencyObject)
    VirtualizingCellsControl.GetCellRendererParentControl(DependencyObject)
    VirtualizingCellsControl.SetCellsControl(DependencyObject, VirtualizingCellsControl)
    VirtualizingCellsControl.GetCellUIElement(DependencyObject)
    VirtualizingCellsControl.SetCellUIElement(DependencyObject, UIElement)
    VirtualizingCellsControl.GetArrangeCellArgs(DependencyObject)
    VirtualizingCellsControl.SetArrangeCellArgs(DependencyObject, ArrangeCellArgs)
    VirtualizingCellsControl.GetCellRowColumnIndex(DependencyObject)
    VirtualizingCellsControl.SetCellRowColumnIndex(DependencyObject, RowColumnIndex)
    VirtualizingCellsControl.GetRenderCellInfo(DependencyObject)
    VirtualizingCellsControl.SetRenderCellInfo(DependencyObject, IRenderCellInfo)
    VirtualizingCellsControl.SetCellRenderer(DependencyObject, ICellRenderer)
    VirtualizingCellsControl.GetHasFocusWithin(UIElement)
    VirtualizingCellsControl.OnShowGridLinesChanged(DependencyPropertyChangedEventArgs)
    VirtualizingCellsControl.CreateScrollControlChildFrame()
    VirtualizingCellsControl.SetFrameProperties(VisualContainer, ScrollControlChildFrame)
    VirtualizingCellsControl.ShouldCellsControlHandleKeyDownScrolling(KeyEventArgs)
    VirtualizingCellsControl.ScrollInDirection(KeyEventArgs)
    VirtualizingCellsControl.RenderBackgrounds(DrawingContext)
    VirtualizingCellsControl.RenderCell(DrawingContext, RenderCellArgs)
    VirtualizingCellsControl.OnRenderCellBackground(DrawingContext, VisibleCoveredCellInfo, RenderCellArgs)
    VirtualizingCellsControl.OnRenderCellBackground(DrawingContext, VisibleOverlappingCellInfo, RenderCellArgs)
    VirtualizingCellsControl.OnRenderCellBackground(DrawingContext, RenderCellArgs)
    VirtualizingCellsControl.InvalidateCellBackground(Int32, Int32)
    VirtualizingCellsControl.InvalidateCellBackground(Int32, Int32, Boolean)
    VirtualizingCellsControl.InvalidateCellBorder(RowColumnIndex)
    VirtualizingCellsControl.InvalidateCellBorder(Int32, Int32)
    VirtualizingCellsControl.InvalidateCellBackground(RowColumnIndex)
    VirtualizingCellsControl.InvalidateCellRenderStyleBackground(RowColumnIndex)
    VirtualizingCellsControl.RenderCoveredCells(DrawingContext)
    VirtualizingCellsControl.RenderOverlappingCells(DrawingContext)
    VirtualizingCellsControl.CanDrawHorizontalLineFirst()
    VirtualizingCellsControl.PushClip(DrawingContext, Rect)
    VirtualizingCellsControl.PushClip(DrawingContext, Rect, Rect)
    VirtualizingCellsControl.OnRenderBorder(DrawingContext, Rect, Rect, CellBorderSide, Pen)
    VirtualizingCellsControl.OnScrollLayoutChanged()
    VirtualizingCellsControl.OnInvalidated(Boolean)
    VirtualizingCellsControl.SetCellLayoutDirty()
    VirtualizingCellsControl.ArrangeCombinedCellBackgrounds(Size)
    VirtualizingCellsControl.GetCoveredCell(Int32, Int32)
    VirtualizingCellsControl.GetCoveredCell(RowColumnIndex)
    VirtualizingCellsControl.ArrangeCoveredCells(Size)
    VirtualizingCellsControl.ReArrangeCoveredCells(VirtualizingCellsControl)
    VirtualizingCellsControl.GetVisibleCoveredCell(VisibleLineInfo, VisibleLineInfo)
    VirtualizingCellsControl.GetOverlappingCell(Int32, Int32)
    VirtualizingCellsControl.GetOverlappingCell(RowColumnIndex)
    VirtualizingCellsControl.ArrangeOverlappingCells(Size)
    VirtualizingCellsControl.GetVisibleOverlappingCell(VisibleLineInfo, VisibleLineInfo)
    VirtualizingCellsControl.GetCellSpanBackgrounds(Int32, Int32)
    VirtualizingCellsControl.GetCellSpanBackgrounds(RowColumnIndex)
    VirtualizingCellsControl.ArrangeCellSpanBackgrounds(Size)
    VirtualizingCellsControl.CellSpanToRect(ScrollAxisRegion, ScrollAxisRegion, CellSpanInfo)
    VirtualizingCellsControl.CellSpanToClippedVisibleRect(CellSpanInfo)
    VirtualizingCellsControl.InvalidateCells()
    VirtualizingCellsControl.InvalidateCell(CellSpanInfoBase, Boolean)
    VirtualizingCellsControl.GetCellUIElements(RowColumnIndex)
    VirtualizingCellsControl.GetCellUIElements(Int32, Int32)
    VirtualizingCellsControl.OnArrangeCell(ArrangeCellArgs)
    VirtualizingCellsControl.PrepareCellUIElements(ArrangeCellArgs, List<UIElement>, ScrollControlChildFrame)
    VirtualizingCellsControl.ArrangeCellBorders(Size)
    VirtualizingCellsControl.CanCombineCellBorder(IRenderCellInfo, IRenderCellInfo, Pen, Pen, CellBorderSide)
    VirtualizingCellsControl.GetCellBorder(IRenderCellInfo, CellBorderSide)
    VirtualizingCellsControl.GetVisibleRowAndColumn(RowColumnIndex, VisibleLineInfo, VisibleLineInfo)
    VirtualizingCellsControl.DelayedCreateCellUIElements(RowColumnIndex)
    VirtualizingCellsControl.RefreshCellUIElementsContent(RowColumnIndex)
    VirtualizingCellsControl.EraseRenderedCell(RowColumnIndex, Rect)
    VirtualizingCellsControl.PointToCellRowColumnIndex(MouseEventArgs, Boolean)
    VirtualizingCellsControl.PointToCellRowColumnIndex(Point, Boolean)
    VirtualizingCellsControl.AdjustCoveredCellRowColumnIndex(RowColumnIndex)
    VirtualizingCellsControl.ClearVisualsCacheWhenUnloaded
    VirtualizingCellsControl.AllowBorderRounding
    VirtualizingCellsControl.EnableFrameArrangement
    VirtualizingCellsControl.ShowGridLines
    VirtualizingCellsControl.CoveredCellsProvider
    VirtualizingCellsControl.OverlappingCellsProvider
    VirtualizingCellsControl.CellSpanBackgroundsProvider
    VirtualizingCellsControl.MouseControllerDispatcher
    VirtualizingCellsControl.EnableRenderCellDrawingVisuals
    VirtualizingCellsControl.RenderedCellVisuals
    VirtualizingCellsControl.IsInOnRender
    VirtualizingCellsControl.IndividualCellBackgroundsToDraw
    VirtualizingCellsControl.UseGuidelineSetToRenderBorder
    VirtualizingCellsControl.UseGuidelineSetToRenderBackground
    VirtualizingCellsControl.ArrangedCellUIElements
    VirtualizingCellsControl.IsInArrageCell
    ScrollAxisControl.CreateScrollAxis(Orientation, Boolean, IScrollBar, ILineSizeHost)
    ScrollAxisControl.LineDown()
    ScrollAxisControl.LineUp()
    ScrollAxisControl.PageDown()
    ScrollAxisControl.PageUp()
    ScrollAxisControl.LineRight()
    ScrollAxisControl.LineLeft()
    ScrollAxisControl.PageLeft()
    ScrollAxisControl.PageRight()
    ScrollAxisControl.ScrollToTop()
    ScrollAxisControl.ScrollToLeftEnd()
    ScrollAxisControl.ScrollToBottom()
    ScrollAxisControl.ScrollToRightEnd()
    ScrollAxisControl.OnMouseWheel(MouseWheelEventArgs)
    ScrollAxisControl.OnRenderSizeChanged(SizeChangedInfo)
    ScrollAxisControl.UpdateAxis(Size)
    ScrollAxisControl.PointToCellRowColumnIndex(MouseEventArgs)
    ScrollAxisControl.PointToCellRowColumnIndexOutsideCells(Point, Boolean)
    ScrollAxisControl.PointToCellRowColumnIndex(Point)
    ScrollAxisControl.GetClipRect(ScrollAxisRegion, ScrollAxisRegion)
    ScrollAxisControl.IsRowVisible(Int32)
    ScrollAxisControl.IsColumnVisible(Int32)
    ScrollAxisControl.IsCellVisible(RowColumnIndex)
    ScrollAxisControl.ScrollRows
    ScrollAxisControl.ScrollColumns
    ScrollAxisControl.HorizontalPixelScroll
    ScrollAxisControl.VerticalPixelScroll
    ScrollAxisControl.AllowPixelScrollPadding
    ScrollAxisControl.TopRowIndex
    ScrollAxisControl.LeftColumnIndex
    ScrollAxisControl.RowHeightsProvider
    ScrollAxisControl.ColumnWidthsProvider
    ScrollControl.ZoomScaleProperty
    ScrollControl.ScrollControlMouseMoveEvent
    ScrollControl.ScrollControlMouseUpEvent
    ScrollControl.ScrollControlMouseDownEvent
    ScrollControl.ScrollControlPreviewMouseMoveEvent
    ScrollControl.ScrollControlPreviewMouseUpEvent
    ScrollControl.ScrollControlPreviewMouseDownEvent
    ScrollControl.OnLoaded(RoutedEventArgs)
    ScrollControl.HitTestCore(PointHitTestParameters)
    ScrollControl.ArrangeOverride(Size)
    ScrollControl.InvalidateVisual()
    ScrollControl.InvalidateVisual(Boolean)
    ScrollControl.OnTopLeftFrameExtentChanged()
    ScrollControl.OnBottomRightFrameExtentChanged()
    ScrollControl.GetChildFrame(Boolean, Boolean, Boolean, Boolean, VisualContainer)
    ScrollControl.GetVisualChild(Int32)
    ScrollControl.OnVScrollBarValueChanging(Object, ValueChangingEventArgs)
    ScrollControl.OnVScrollBarValueChanged(Object, EventArgs)
    ScrollControl.OnHScrollBarValueChanging(Object, ValueChangingEventArgs)
    ScrollControl.OnHScrollBarValueChanged(Object, EventArgs)
    ScrollControl.MouseWheelUp()
    ScrollControl.MouseWheelDown()
    ScrollControl.MouseWheelLeft()
    ScrollControl.MouseWheelRight()
    ScrollControl.SetVerticalOffset(Double)
    ScrollControl.SetHorizontalOffset(Double)
    ScrollControl.MakeVisible(Visual, Rect)
    ScrollControl.OnMouseEnter(MouseEventArgs)
    ScrollControl.OnMouseDown(MouseButtonEventArgs)
    ScrollControl.OnMouseMove(MouseEventArgs)
    ScrollControl.OnMouseUp(MouseButtonEventArgs)
    ScrollControl.OnPreviewMouseWheel(MouseWheelEventArgs)
    ScrollControl.OnPreviewMouseUp(MouseButtonEventArgs)
    ScrollControl.OnScrollControlMouseMove(ScrollControlMouseEventArgs)
    ScrollControl.OnScrollControlMouseUp(ScrollControlMouseButtonEventArgs)
    ScrollControl.OnScrollControlMouseDown(ScrollControlMouseButtonEventArgs)
    ScrollControl.OnScrollControlPreviewMouseMove(ScrollControlMouseEventArgs)
    ScrollControl.OnScrollControlPreviewMouseUp(ScrollControlMouseButtonEventArgs)
    ScrollControl.OnScrollControlPreviewMouseDown(ScrollControlMouseButtonEventArgs)
    ScrollControl.ZoomScale
    ScrollControl.IsArrangeDirty
    ScrollControl.IsInArrangeOverride
    ScrollControl.IsInArrangeContent
    ScrollControl.TopLeftFrameExtent
    ScrollControl.BottomRightFrameExtent
    ScrollControl.BackgroundFrame
    ScrollControl.ForegroundFrame
    ScrollControl.ElementsFrame
    ScrollControl.InnerFrame
    ScrollControl.GraphicFrame
    ScrollControl.VisualChildren
    ScrollControl.VisualChildrenCount
    ScrollControl.VScroll
    ScrollControl.HScroll
    ScrollControl.IScrollBarProvider.Element
    ScrollControl.HScrollBar
    ScrollControl.VScrollBar
    ScrollControl.ScrollOwner
    ScrollControl.CanHorizontallyScroll
    ScrollControl.CanVerticallyScroll
    ScrollControl.HorizontalOffset
    ScrollControl.VerticalOffset
    ScrollControl.ExtentWidth
    ScrollControl.ExtentHeight
    ScrollControl.ViewportWidth
    ScrollControl.ViewportHeight
    ScrollControl.HScrollBarShadow
    ScrollControl.VScrollBarShadow
    ScrollControl.MouseEventListeners
    ScrollControl.ScrollControlMouseMove
    ScrollControl.ScrollControlMouseUp
    ScrollControl.ScrollControlMouseDown
    ScrollControl.ScrollControlPreviewMouseMove
    ScrollControl.ScrollControlPreviewMouseUp
    ScrollControl.ScrollControlPreviewMouseDown
    VisualContainer.WantsMouseInputProperty
    VisualContainer.WantsKeyInputProperty
    VisualContainer.CellRenderBoundsProperty
    VisualContainer.GetWantsMouseInput(DependencyObject, UIElement)
    VisualContainer.SetWantsMouseInput(DependencyObject, Nullable<Boolean>)
    VisualContainer.SetWantsKeyInput(DependencyObject, Boolean)
    VisualContainer.GetWantsKeyInput(DependencyObject)
    VisualContainer.GetRenderBoundsInherited(DependencyObject)
    VisualContainer.GetRenderBounds(DependencyObject)
    VisualContainer.SetRenderBounds(DependencyObject, Rect)
    VisualContainer.GetParent(DependencyObject)
    VisualContainer.HitTestCore(GeometryHitTestParameters)
    VisualContainer.Dispose()
    VisualContainer.Children
    Namespace: Syncfusion.Windows.Controls.Grid
    Assembly: Syncfusion.Grid.Wpf.dll
    Syntax
    public class GridControlBase : VirtualizingCellsControl, IScrollBarProvider, IScrollInfo, IDisposable, IGridPrintPaginator
    Remarks

    GridControlBase offers many events that you can subscribe to and modify the default behavior of the grid. Typically, methods that are sent before the action is carried out allows you to adjust certain parameters or cancel the operation. These events usually end with an "ing" suffix, like "Changing". Events that are raised after the data in the model have been changed inform associated controls about the success of the operation.

    Constructors

    GridControlBase()

    Initializes a new GridControlBase.

    Declaration
    public GridControlBase()

    Fields

    AddSkinResourceForDataTemplateProperty

    AddSkinResourceForDataTemplate Attached Dependency Property

    Declaration
    public static readonly DependencyProperty AddSkinResourceForDataTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    AllowDropDownKeyHandlingProperty

    AllowComboBoxDropDownKeyHandling Attached Dependency Property

    Declaration
    public static readonly DependencyProperty AllowDropDownKeyHandlingProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    AllowSelectionInDataTemplateProperty

    Declaration
    public static readonly DependencyProperty AllowSelectionInDataTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    CancelModeEvent

    Declaration
    public static readonly RoutedEvent CancelModeEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellButtonClickEvent

    Declaration
    public static readonly RoutedEvent CellButtonClickEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellCancelModeEvent

    Declaration
    public static readonly RoutedEvent CellCancelModeEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellClickEvent

    Declaration
    public static readonly RoutedEvent CellClickEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellCursorEvent

    Declaration
    public static readonly RoutedEvent CellCursorEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseDownEvent

    Declaration
    public static readonly RoutedEvent CellMouseDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseHoverEnterEvent

    Declaration
    public static readonly RoutedEvent CellMouseHoverEnterEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseHoverEvent

    Declaration
    public static readonly RoutedEvent CellMouseHoverEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseHoverLeaveEvent

    Declaration
    public static readonly RoutedEvent CellMouseHoverLeaveEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseMoveEvent

    Declaration
    public static readonly RoutedEvent CellMouseMoveEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellMouseUpEvent

    Declaration
    public static readonly RoutedEvent CellMouseUpEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellRenderedEvent

    Declaration
    public static readonly RoutedEvent CellRenderedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CellRestoreModeEvent

    Declaration
    public static readonly RoutedEvent CellRestoreModeEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellAcceptedChangesEvent

    Declaration
    public static readonly RoutedEvent CurrentCellAcceptedChangesEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellActivatedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellActivatedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellActivateFailedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellActivateFailedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellActivatingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellActivatingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellChangedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellChangedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellChangingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellChangingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellClosedDropDownEvent

    Declaration
    public static readonly RoutedEvent CurrentCellClosedDropDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellConfirmChangesFailedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellConfirmChangesFailedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellDeactivatedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellDeactivatedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellDeactivateFailedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellDeactivateFailedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellDeactivatingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellDeactivatingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellEditingCompleteEvent

    Declaration
    public static readonly RoutedEvent CurrentCellEditingCompleteEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellKeyDownEvent

    Declaration
    public static readonly RoutedEvent CurrentCellKeyDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellMovedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellMovedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellMoveFailedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellMoveFailedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellMovingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellMovingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellPreviewKeyDownEvent

    Declaration
    public static readonly RoutedEvent CurrentCellPreviewKeyDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellRejectedChangesEvent

    Declaration
    public static readonly RoutedEvent CurrentCellRejectedChangesEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellShowedDropDownEvent

    Declaration
    public static readonly RoutedEvent CurrentCellShowedDropDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellShowingDropDownEvent

    Declaration
    public static readonly RoutedEvent CurrentCellShowingDropDownEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellStartEditingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellStartEditingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellValidatedEvent

    Declaration
    public static readonly RoutedEvent CurrentCellValidatedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    CurrentCellValidatingEvent

    Declaration
    public static readonly RoutedEvent CurrentCellValidatingEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    DropDownSelectionChangedEvent

    Declaration
    public static readonly RoutedEvent DropDownSelectionChangedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    IgnoreChangedEventProperty

    Returns the cell renderer of an UIElement inside a cell. When the editor inside a cell has children and you query this attached property for a child it will query the top-most parent element of the cell renderer for the value of the property.

    Declaration
    public static readonly DependencyProperty IgnoreChangedEventProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MoveCurrentCellDirectionEvent

    Declaration
    public static readonly RoutedEvent MoveCurrentCellDirectionEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    PrepareRenderCellEvent

    Declaration
    public static readonly RoutedEvent PrepareRenderCellEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    previous

    Declaration
    public GridRangeInfo previous
    Field Value
    Type Description
    GridRangeInfo

    PrintDescriptionProperty

    Declaration
    public static readonly DependencyProperty PrintDescriptionProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrintFooterHeightProperty

    Declaration
    public static readonly DependencyProperty PrintFooterHeightProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrintFooterTemplateProperty

    Declaration
    public static readonly DependencyProperty PrintFooterTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrintHeaderHeightProperty

    Declaration
    public static readonly DependencyProperty PrintHeaderHeightProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrintHeaderTemplateProperty

    Declaration
    public static readonly DependencyProperty PrintHeaderTemplateProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PrintPageMarginProperty

    DependencyProperty for PrintPageMargin property.

    Declaration
    public static readonly DependencyProperty PrintPageMarginProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    QueryAllowDragColumnEvent

    Declaration
    public static readonly RoutedEvent QueryAllowDragColumnEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    QueryNextCurrentCellPositionEvent

    Declaration
    public static readonly RoutedEvent QueryNextCurrentCellPositionEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    ResizingColumnsEvent

    Declaration
    public static readonly RoutedEvent ResizingColumnsEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    ResizingRowsEvent

    Declaration
    public static readonly RoutedEvent ResizingRowsEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    SelectionChangedEvent

    Occurs after the model updates its internal data structures when the model is in the process of selecting a range of cells.

    Declaration
    public static RoutedEvent SelectionChangedEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    WrapCellNextControlInFormEvent

    Declaration
    public static readonly RoutedEvent WrapCellNextControlInFormEvent
    Field Value
    Type Description
    System.Windows.RoutedEvent

    Properties

    AllowDragColumns

    Gets or sets a value indicating whether the grid columns can be dragged.

    Declaration
    public bool AllowDragColumns { get; set; }
    Property Value
    Type Description
    System.Boolean

    AllowDragDrop

    Gets or sets a value indicating whether the grid columns can be dragged.

    Declaration
    public bool AllowDragDrop { get; set; }
    Property Value
    Type Description
    System.Boolean

    AutoScroller

    Gets the auto scroller which provides automatic scrolling of content when the user drags the pressed mouse to an edge of the control.

    Declaration
    public GridControlDragAutoScroller AutoScroller { get; }
    Property Value
    Type Description
    GridControlDragAutoScroller

    The auto scroller.

    CellRenderers

    Manages the collection of GridCellRendererBase objects for the current grid view method.

    Declaration
    public GridCellRendererCollection CellRenderers { get; }
    Property Value
    Type Description
    GridCellRendererCollection
    Remarks

    Cell renderers will be created on demand by calling the CreateRenderer(). Each renderer is associated with a GridCellModelBase object that holds its data and has knowledge how to instantiate a renderer and associates it with a grid view.

    A renderer is created for each grid view but renderers (of the same cell type) share the same GridCellModelBase instance even though they belong to different grid views.

    Examples

    The following examples show how to get a reference to the renderer for a specific cell.

                GridStyleInfo style = Model[rowIndex, colIndex];
                GridCellRendererBase renderer =(GridCellRendererBase)CellRenderers[style.CellType];

    CellSpanBackgrounds

    Returns the cell spanned backgrounds.

    Declaration
    public GridCellSpanBackgroundInfoCollection CellSpanBackgrounds { get; }
    Property Value
    Type Description
    GridCellSpanBackgroundInfoCollection

    ColumnWidths

    Returns the column widths for the grid.

    Declaration
    public IEditableLineSizeHost ColumnWidths { get; }
    Property Value
    Type Description
    IEditableLineSizeHost

    CoveredCells

    Returns the covered cells.

    Declaration
    public GridCoveredCellInfoCollection CoveredCells { get; }
    Property Value
    Type Description
    GridCoveredCellInfoCollection

    CurrentCell

    Gets the current cell.

    Declaration
    public GridCurrentCell CurrentCell { get; }
    Property Value
    Type Description
    GridCurrentCell

    CurrentCellBorderWeight

    Obsolete. Use Model.Options.CurrentCellBorderWitdh.

    Declaration
    [Obsolete("Use Model.Options.CurrentCellBorderWitdh")]
    public double CurrentCellBorderWeight { get; set; }
    Property Value
    Type Description
    System.Double

    ExternalMove

    Used by GridSelectCellsMouseController.

    Declaration
    public GridCurrentCellMoveDelegateHandler ExternalMove { get; set; }
    Property Value
    Type Description
    GridCurrentCellMoveDelegateHandler

    FooterColumns

    Gets or sets the footer columns count.

    Declaration
    public int FooterColumns { get; set; }
    Property Value
    Type Description
    System.Int32

    FooterRows

    Gets or sets the footer row count.

    Declaration
    public int FooterRows { get; set; }
    Property Value
    Type Description
    System.Int32

    FrozenColumns

    Gets or sets the frozen column count.

    Declaration
    public int FrozenColumns { get; set; }
    Property Value
    Type Description
    System.Int32

    FrozenRows

    Gets or sets the frozen row count.

    Declaration
    public int FrozenRows { get; set; }
    Property Value
    Type Description
    System.Int32

    HighlightBorder

    Obsolete. Use Model.Options.HighlightSelectionBorder.

    Declaration
    [Obsolete("Use Model.Options.HighlightSelectionBorder")]
    public Brush HighlightBorder { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    HighlightBrush

    Obsolete. Use Model.Options.HighlightSelectionAlphaBlend.

    Declaration
    [Obsolete("Use Model.Options.HighlightSelectionAlphaBlend")]
    public Brush HighlightBrush { get; set; }
    Property Value
    Type Description
    System.Windows.Media.Brush

    ImageCells

    Declaration
    public GridOverlappingCellInfoCollection ImageCells { get; }
    Property Value
    Type Description
    GridOverlappingCellInfoCollection

    Model

    Gets or sets the model.

    Declaration
    public GridModel Model { get; set; }
    Property Value
    Type Description
    GridModel

    The model.

    NavigateWithArrowKeysCellsRange

    The range of cells in the grid that can be navigated to using arrow keys. This range can but does not need to include header and footer rows and columns. The default scenario is that header and footer rows and columns are excluded

    Cells outside the range can still be clicked on and be made the current cell but they will be skipped when the user navigate with arrow keys.

    Declaration
    public virtual GridRangeInfo NavigateWithArrowKeysCellsRange { get; }
    Property Value
    Type Description
    GridRangeInfo

    The grid cells range.

    Remarks

    When the user clicks on a cell it will be made the current cell through a MoveTo(Int32, Int32) call when the cell is enabled. When the user navigates with arrow keys the next current cell is determined by looping in the direction and skipping disabled cells with the Move(GridDirectionType, Int32, Boolean, Boolean) method. The Move method checks this range to determine when to stop searching in a given direction.

    OleDragDropEventsTarget

    Gets or sets the OleDragDropEventsTarget. Redirects events defined in IGridOleDragDropEventsTarget to the specified object. Each event will first be called on IGridOleDragDropEventsTarget before the actual event handler in this control is called.

    Declaration
    public IGridOleDragDropEventsTarget OleDragDropEventsTarget { get; set; }
    Property Value
    Type Description
    IGridOleDragDropEventsTarget

    PageCount

    Gets the number of pages.

    Declaration
    public int PageCount { get; }
    Property Value
    Type Description
    System.Int32

    PaneDesc

    Returns a System.String that represents the current object.

    Declaration
    public string PaneDesc { get; }
    Property Value
    Type Description
    System.String

    PrintColumns

    Declaration
    public int[] PrintColumns { get; set; }
    Property Value
    Type Description
    System.Int32[]

    PrintDescription

    Specifies a description of the job to be printed. This text will appear in the Print Dialog.

    Declaration
    public string PrintDescription { get; set; }
    Property Value
    Type Description
    System.String

    PrintFooterHeight

    Gets or sets the height for the print footer.

    Declaration
    public double PrintFooterHeight { get; set; }
    Property Value
    Type Description
    System.Double

    PrintFooterTemplate

    Gets or sets a data template for the print footer.

    Declaration
    public DataTemplate PrintFooterTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    PrintHeaderHeight

    Gets or sets the height for the print header.

    Declaration
    public double PrintHeaderHeight { get; set; }
    Property Value
    Type Description
    System.Double

    PrintHeaderTemplate

    Gets or sets a data template for the print header.

    Declaration
    public DataTemplate PrintHeaderTemplate { get; set; }
    Property Value
    Type Description
    System.Windows.DataTemplate

    PrintPageMargin

    Gets or sets the marign for the print page.

    Declaration
    public Thickness PrintPageMargin { get; set; }
    Property Value
    Type Description
    System.Windows.Thickness

    PrintRange

    Gets or sets the grid range that is selected for printing.

    Declaration
    public GridRangeInfo PrintRange { get; set; }
    Property Value
    Type Description
    GridRangeInfo

    RenderStyles

    Gets a collection of rendering styles for grid cells.

    Declaration
    public GridControlRenderStyles RenderStyles { get; }
    Property Value
    Type Description
    GridControlRenderStyles

    ResetHiddenWhenFreezing

    Get or set a value that is used to check whether the frozen rows needs to reset the hidden rows/columns to avoid resetting the previous hidden rows/columns

    Declaration
    public bool ResetHiddenWhenFreezing { get; set; }
    Property Value
    Type Description
    System.Boolean

    RowHeights

    Returns the row heights for the grid.

    Declaration
    public IEditableLineSizeHost RowHeights { get; }
    Property Value
    Type Description
    IEditableLineSizeHost

    ScalingOptions

    Declaration
    public ScalingOptions ScalingOptions { get; set; }
    Property Value
    Type Description
    ScalingOptions

    ScrollCellsRange

    The range of cells in the grid that can be scrolled. This excludes all frozen rows and columns.

    Declaration
    public GridRangeInfo ScrollCellsRange { get; }
    Property Value
    Type Description
    GridRangeInfo

    Methods

    ArrangeCellUIElements(Size)

    Declaration
    protected override void ArrangeCellUIElements(Size arrangeSize)
    Parameters
    Type Name Description
    System.Windows.Size arrangeSize
    Overrides
    VirtualizingCellsControl.ArrangeCellUIElements(Size)

    CanAutoCalculateWidth()

    Declaration
    protected override bool CanAutoCalculateWidth()
    Returns
    Type Description
    System.Boolean
    Overrides
    ScrollAxisControl.CanAutoCalculateWidth()

    CreateGridViewMoveCellsState()

    Declaration
    protected virtual GridViewMoveCellsState CreateGridViewMoveCellsState()
    Returns
    Type Description
    GridViewMoveCellsState

    CreateOleDropTarget(GridControlBase, GridDragDropFlags)

    Creates a GridOleDropTarget object and calls GridOleDropTarget.Register. Override this method if you want to customize behavior of the GridOleDropTarget object.

    Declaration
    protected virtual GridOleDropTarget CreateOleDropTarget(GridControlBase grid, GridDragDropFlags flags)
    Parameters
    Type Name Description
    GridControlBase grid

    The grid control

    GridDragDropFlags flags

    Value for DragDropDropTargetFlags

    Returns
    Type Description
    GridOleDropTarget

    returns GridOleDropTarget

    Dispose(Boolean)

    Declaration
    public override void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing
    Overrides
    VirtualizingCellsControl.Dispose(Boolean)

    DrawSelectedCellsRectangle(DrawingContext, Rect)

    Declaration
    protected virtual void DrawSelectedCellsRectangle(DrawingContext dccBackground, Rect r)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dccBackground
    System.Windows.Rect r

    EnableOleDataSource()

    Enables OLE Data Source support for this control with default support for Text and Styles format.

    Declaration
    public bool EnableOleDataSource()
    Returns
    Type Description
    System.Boolean

    True if support was enabled successfully; False otherwise.

    EnableOleDataSource(GridDragDropFlags)

    Enables OLE Data Source support for this control with default support for Text and Styles format.

    Declaration
    public bool EnableOleDataSource(GridDragDropFlags flags)
    Parameters
    Type Name Description
    GridDragDropFlags flags

    See GridDragDropFlags for various flags that customize the OLE Data Source behavior of the grid.

    Returns
    Type Description
    System.Boolean

    True if support was enabled successfully; False otherwise.

    EnableOleDropTarget()

    Enables OLE Drop Target support for this control with default support for Text and Styles format.

    Declaration
    public void EnableOleDropTarget()

    EnableOleDropTarget(GridDragDropFlags)

    Enables OLE Drop Target support for this control with GridDragDropFlags options specified.

    Declaration
    public void EnableOleDropTarget(GridDragDropFlags flags)
    Parameters
    Type Name Description
    GridDragDropFlags flags

    See GridDragDropFlags for various flags that customize the OLE Drop Target behavior of the grid.

    ExpandSelectedCellsRange(GridRangeInfo)

    Expands the range of selected cells.

    Declaration
    public virtual GridRangeInfo ExpandSelectedCellsRange(GridRangeInfo selectedCells)
    Parameters
    Type Name Description
    GridRangeInfo selectedCells

    The selected cells range.

    Returns
    Type Description
    GridRangeInfo

    Expanded range of selected cells.

    GetAddSkinResourceForDataTemplate(DependencyObject)

    Gets the AddSkinResourceForDataTemplate property. This dependency property indicates whether skins have to be added for DataTemplate as MergedDictionaries.

    Declaration
    public static bool GetAddSkinResourceForDataTemplate(DependencyObject d)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d
    Returns
    Type Description
    System.Boolean

    GetAllowDropDownKeyHandling(DependencyObject)

    Gets the AllowComboBoxDropDownKeyHandling property. This dependency property indicates whether ComboBox DropDown should handle up down key.

    Declaration
    public static bool GetAllowDropDownKeyHandling(DependencyObject d)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d
    Returns
    Type Description
    System.Boolean

    GetAllowSelectionInDataTemplate(DependencyObject)

    Declaration
    public static bool GetAllowSelectionInDataTemplate(DependencyObject o)
    Parameters
    Type Name Description
    System.Windows.DependencyObject o
    Returns
    Type Description
    System.Boolean

    GetAutomationTemplateElement(DependencyObject)

    Gets value true / false if this is a templated element, Set this to true if the AutomationElement returning from a grid cell has to be from the underlying control.

    Declaration
    public static bool GetAutomationTemplateElement(DependencyObject dpo)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    Dependency Object.

    Returns
    Type Description
    System.Boolean

    true / false

    GetCellBackground(IRenderCellInfo, Boolean)

    Gets the cell background for a cell from the IRenderCellInfo cell style.

    Declaration
    protected override Brush GetCellBackground(IRenderCellInfo ci, bool combineBackgrounds)
    Parameters
    Type Name Description
    IRenderCellInfo ci

    The cell style.

    System.Boolean combineBackgrounds
    Returns
    Type Description
    System.Windows.Media.Brush
    Overrides
    VirtualizingCellsControl.GetCellBackground(IRenderCellInfo, Boolean)

    GetCellRenderer(IRenderCellInfo)

    Declaration
    protected override ICellRenderer GetCellRenderer(IRenderCellInfo cellInfo)
    Parameters
    Type Name Description
    IRenderCellInfo cellInfo
    Returns
    Type Description
    ICellRenderer
    Overrides
    VirtualizingCellsControl.GetCellRenderer(IRenderCellInfo)

    GetCellRenderer(DependencyObject)

    Gets the attached dependency property value.

    Declaration
    public static IGridCellRenderer GetCellRenderer(DependencyObject dpo)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be queried for the effective value of the dependency property.

    Returns
    Type Description
    IGridCellRenderer

    Returns the effective value for the given instance.

    GetDelayLoad(DependencyObject)

    Gets a boolean value if the DependencyObject should be loaded with a delay when it is created.

    Declaration
    public static bool GetDelayLoad(DependencyObject dpo)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The dpo.

    Returns
    Type Description
    System.Boolean

    GetIgnoreChangedEvent(DependencyObject)

    Gets the attached dependency property value.

    Declaration
    public static bool? GetIgnoreChangedEvent(DependencyObject dpo)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be queried for the effective value of the dependency property.

    Returns
    Type Description
    System.Nullable<System.Boolean>

    Returns the effective value for the given instance.

    GetNextCurrentCellPosition(GridDirectionType, ref Int32, ref Int32)

    Determines the next position for the current cell for a given direction. Normally, cells that are not marked as enabled with Enabled will be skipped but you can hook into this mechanism by implementing an event handler for QueryNextCurrentCellPosition.

    Declaration
    public bool GetNextCurrentCellPosition(GridDirectionType direction, ref int rowIndex, ref int colIndex)
    Parameters
    Type Name Description
    GridDirectionType direction

    The GridDirectionType that specifies the direction of the current cell movement.

    System.Int32 rowIndex

    The row index.

    System.Int32 colIndex

    The column index.

    Returns
    Type Description
    System.Boolean

    True if an enabled cell was found; False otherwise.

    Remarks

    This method will raise the QueryNextCurrentCellPosition event. In your event handler, you can call QueryNextEnabledCell(GridDirectionType, ref Int32, ref Int32) from your QueryNextMoveCell event handler to find out about the next enabled cell and then decide on further criteria if the suggested cell is good.

    See the SampleGrid class in the gridpad sample for an example.

    GetRenderCellInfo(Int32, Int32)

    Declaration
    protected override sealed IRenderCellInfo GetRenderCellInfo(int rowIndex, int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex
    System.Int32 columnIndex
    Returns
    Type Description
    IRenderCellInfo
    Overrides
    VirtualizingCellsControl.GetRenderCellInfo(Int32, Int32)

    GetRenderStyleInfo(RowColumnIndex)

    Gets the rendering style for a cell given its row and column indices.

    Declaration
    public GridRenderStyleInfo GetRenderStyleInfo(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Row and column indices as RowColumnIndex.

    Returns
    Type Description
    GridRenderStyleInfo

    Rendering cell style.

    GetRenderStyleInfo(RowColumnIndex, Boolean)

    Gets the rendering style for a cell given its row and column indices.

    Declaration
    public GridRenderStyleInfo GetRenderStyleInfo(RowColumnIndex cellRowColumnIndex, bool createDisposableObject)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Row and column indices as RowColumnIndex.

    System.Boolean createDisposableObject

    When true, returns a render style object that can be disposed.

    Returns
    Type Description
    GridRenderStyleInfo

    Rendering cell style.

    GetRenderStyleInfo(Int32, Int32)

    Gets the rendering style for a cell given its row and column indices.

    Declaration
    public GridRenderStyleInfo GetRenderStyleInfo(int rowIndex, int columnIndex)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Row index.

    System.Int32 columnIndex

    Column index.

    Returns
    Type Description
    GridRenderStyleInfo

    Rendering cell style.

    GetRenderStyleInfo(Int32, Int32, Boolean)

    Gets the rendering style for a cell given its row and column indices.

    Declaration
    public GridRenderStyleInfo GetRenderStyleInfo(int rowIndex, int columnIndex, bool createDisposableObject)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    Row index.

    System.Int32 columnIndex

    Column index.

    System.Boolean createDisposableObject

    When true, returns a render style object that can be disposed.

    Returns
    Type Description
    GridRenderStyleInfo

    Rendering cell style.

    GetRenderStyleInfo(DependencyObject)

    Gets the attached dependency property value.

    Declaration
    public static GridRenderStyleInfo GetRenderStyleInfo(DependencyObject dpo)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be queried for the effective value of the dependency property.

    Returns
    Type Description
    GridRenderStyleInfo

    Returns the effective value for the given instance.

    InvalidateCell(CellSpanInfoBase)

    Reset cached values for the cell span and reset any visuals associated with the cell. You need to call InvalidateVisual or RenderNow after this method.

    Declaration
    public override void InvalidateCell(CellSpanInfoBase span)
    Parameters
    Type Name Description
    CellSpanInfoBase span

    Cell spanned range to be invalidated.

    Overrides
    VirtualizingCellsControl.InvalidateCell(CellSpanInfoBase)

    InvalidateCell(RowColumnIndex)

    Reset cached values for cell and reset any visuals associated with the cell. You need to call InvalidateVisual or RenderNow after this method.

    Declaration
    public override void InvalidateCell(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Row and column indices as RowColumnIndex.

    Overrides
    VirtualizingCellsControl.InvalidateCell(RowColumnIndex)

    InvalidateCell(GridRangeInfo)

    Reset cached values for a range of cells and reset any visuals associated with the cell. You need to call InvalidateVisual or RenderNow after this method.

    Declaration
    public void InvalidateCell(GridRangeInfo gridRangeInfo)
    Parameters
    Type Name Description
    GridRangeInfo gridRangeInfo

    A range of cells to invalidate.

    InvalidateRenderCell(GridRangeInfo)

    Invalidate cell so that PrepareRenderCell will get called again but not QueryCellStyle.

    Declaration
    public void InvalidateRenderCell(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    The range of cells to invalidate.

    InvalidateRowResize()

    Calls InvalidateVisual.

    Declaration
    public virtual void InvalidateRowResize()

    MeasureOverride(Size)

    Declaration
    protected override Size MeasureOverride(Size constraint)
    Parameters
    Type Name Description
    System.Windows.Size constraint
    Returns
    Type Description
    System.Windows.Size
    Overrides
    VirtualizingCellsControl.MeasureOverride(Size)

    ModelInsertColumns(Int32, Int32, GridViewMoveCellsState)

    Declaration
    protected virtual void ModelInsertColumns(int insertAtColumnIndex, int count, GridViewMoveCellsState moveCellsState)
    Parameters
    Type Name Description
    System.Int32 insertAtColumnIndex
    System.Int32 count
    GridViewMoveCellsState moveCellsState

    ModelInsertRows(Int32, Int32, GridViewMoveCellsState)

    Declaration
    protected virtual void ModelInsertRows(int insertAtRowIndex, int count, GridViewMoveCellsState moveCellsState)
    Parameters
    Type Name Description
    System.Int32 insertAtRowIndex
    System.Int32 count
    GridViewMoveCellsState moveCellsState

    ModelRemoveColumns(Int32, Int32, GridViewMoveCellsState)

    Declaration
    protected virtual void ModelRemoveColumns(int removeAtColumnIndex, int count, GridViewMoveCellsState moveCellsState)
    Parameters
    Type Name Description
    System.Int32 removeAtColumnIndex
    System.Int32 count
    GridViewMoveCellsState moveCellsState

    ModelRemoveRows(Int32, Int32, GridViewMoveCellsState)

    Declaration
    protected virtual void ModelRemoveRows(int removeAtRowIndex, int count, GridViewMoveCellsState moveCellsState)
    Parameters
    Type Name Description
    System.Int32 removeAtRowIndex
    System.Int32 count
    GridViewMoveCellsState moveCellsState

    MoveCurrentCellWithArrowKey(KeyEventArgs)

    Moves the current cell in the direction indicated by the arrow keys.

    Declaration
    public virtual bool MoveCurrentCellWithArrowKey(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e

    The System.Windows.Input.KeyEventArgs object.

    Returns
    Type Description
    System.Boolean

    True if the operation was successful; False otherwise.

    OnArrangeContent(Size)

    Declaration
    protected override void OnArrangeContent(Size arrangeSize)
    Parameters
    Type Name Description
    System.Windows.Size arrangeSize
    Overrides
    VirtualizingCellsControl.OnArrangeContent(Size)

    OnArrangeOverride(Size, ref Boolean)

    Declaration
    protected override Size OnArrangeOverride(Size arrangeSize, ref bool isArrangeDirty)
    Parameters
    Type Name Description
    System.Windows.Size arrangeSize
    System.Boolean isArrangeDirty
    Returns
    Type Description
    System.Windows.Size
    Overrides
    VirtualizingCellsControl.OnArrangeOverride(Size, ref Boolean)

    OnBaseStylesMapChanged(EventArgs)

    Declaration
    protected virtual void OnBaseStylesMapChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    OnCancelMode(SyncfusionRoutedEventArgs)

    Raises the CancelMode event.

    Declaration
    protected virtual void OnCancelMode(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCanExecuteCopy(CanExecuteRoutedEventArgs)

    Declaration
    protected virtual void OnCanExecuteCopy(CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecuteCut(CanExecuteRoutedEventArgs)

    Declaration
    protected virtual void OnCanExecuteCut(CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecutePaste(CanExecuteRoutedEventArgs)

    Declaration
    protected virtual void OnCanExecutePaste(CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecuteRedo(Object, CanExecuteRoutedEventArgs)

    Declaration
    protected static void OnCanExecuteRedo(object sender, CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecuteRedo(CanExecuteRoutedEventArgs)

    Declaration
    protected virtual void OnCanExecuteRedo(CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecuteUndo(Object, CanExecuteRoutedEventArgs)

    Declaration
    protected static void OnCanExecuteUndo(object sender, CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Object sender
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCanExecuteUndo(CanExecuteRoutedEventArgs)

    Declaration
    protected virtual void OnCanExecuteUndo(CanExecuteRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.CanExecuteRoutedEventArgs args

    OnCellButtonClick(GridCellButtonClickEventArgs)

    Declaration
    protected virtual void OnCellButtonClick(GridCellButtonClickEventArgs e)
    Parameters
    Type Name Description
    GridCellButtonClickEventArgs e

    OnCellCancelMode(SyncfusionRoutedEventArgs)

    Declaration
    protected virtual void OnCellCancelMode(SyncfusionRoutedEventArgs args)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs args

    OnCellClick(GridCellClickEventArgs)

    Declaration
    protected virtual void OnCellClick(GridCellClickEventArgs e)
    Parameters
    Type Name Description
    GridCellClickEventArgs e

    OnCellModelsChanged(CollectionChangeEventArgs)

    Declaration
    protected virtual void OnCellModelsChanged(CollectionChangeEventArgs e)
    Parameters
    Type Name Description
    System.ComponentModel.CollectionChangeEventArgs e

    OnCellMouseDown(GridCellMouseControllerEventArgs)

    Declaration
    protected virtual void OnCellMouseDown(GridCellMouseControllerEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseControllerEventArgs args

    OnCellMouseHover(GridCellMouseControllerEventArgs)

    Declaration
    protected virtual void OnCellMouseHover(GridCellMouseControllerEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseControllerEventArgs args

    OnCellMouseHoverEnter(GridCellMouseEventArgs)

    Declaration
    protected virtual void OnCellMouseHoverEnter(GridCellMouseEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseEventArgs args

    OnCellMouseHoverLeave(GridCellMouseEventArgs)

    Declaration
    protected virtual void OnCellMouseHoverLeave(GridCellMouseEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseEventArgs args

    OnCellMouseMove(GridCellMouseControllerEventArgs)

    Declaration
    protected virtual void OnCellMouseMove(GridCellMouseControllerEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseControllerEventArgs args

    OnCellMouseUp(GridCellMouseControllerEventArgs)

    Declaration
    protected virtual void OnCellMouseUp(GridCellMouseControllerEventArgs args)
    Parameters
    Type Name Description
    GridCellMouseControllerEventArgs args

    OnCellRestoreMode(SyncfusionRoutedEventArgs)

    Declaration
    protected virtual void OnCellRestoreMode(SyncfusionRoutedEventArgs args)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs args

    OnColumnsInserted(GridRangeInsertedEventArgs)

    Declaration
    protected virtual void OnColumnsInserted(GridRangeInsertedEventArgs e)
    Parameters
    Type Name Description
    GridRangeInsertedEventArgs e

    OnColumnsMoved(GridRangeMovedEventArgs)

    Declaration
    protected virtual void OnColumnsMoved(GridRangeMovedEventArgs e)
    Parameters
    Type Name Description
    GridRangeMovedEventArgs e

    OnColumnsRemoved(GridRangeRemovedEventArgs)

    Declaration
    protected virtual void OnColumnsRemoved(GridRangeRemovedEventArgs e)
    Parameters
    Type Name Description
    GridRangeRemovedEventArgs e

    OnCommitCellInfo(GridCommitCellInfoEventArgs)

    Declaration
    protected virtual void OnCommitCellInfo(GridCommitCellInfoEventArgs e)
    Parameters
    Type Name Description
    GridCommitCellInfoEventArgs e

    OnCommittedCellInfo(GridCommitCellInfoEventArgs)

    Declaration
    protected virtual void OnCommittedCellInfo(GridCommitCellInfoEventArgs e)
    Parameters
    Type Name Description
    GridCommitCellInfoEventArgs e

    OnCreateAutomationPeer()

    Declaration
    protected override AutomationPeer OnCreateAutomationPeer()
    Returns
    Type Description
    System.Windows.Automation.Peers.AutomationPeer

    OnCurrentCellAcceptedChanges(SyncfusionRoutedEventArgs)

    Raises the cancelable CurrentCellAcceptedChanges event.

    Declaration
    protected virtual void OnCurrentCellAcceptedChanges(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellActivateFailed(GridCurrentCellActivateFailedEventArgs)

    Raises the CurrentCellActivateFailed event.

    Declaration
    protected virtual void OnCurrentCellActivateFailed(GridCurrentCellActivateFailedEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellActivateFailedEventArgs e

    The GridCurrentCellActivateFailedEventArgs instance containing the event data.

    OnCurrentCellActivating(GridCurrentCellActivatingEventArgs)

    Raises the CurrentCellActivating event.

    Declaration
    protected virtual void OnCurrentCellActivating(GridCurrentCellActivatingEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellActivatingEventArgs e

    The GridCurrentCellActivatingEventArgs instance containing the event data.

    OnCurrentCellChanged(SyncfusionRoutedEventArgs)

    Raises the CurrentCellChanged event.

    Declaration
    protected virtual void OnCurrentCellChanged(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    A System.EventArgs that contains the event data.

    OnCurrentCellChanging(SyncfusionCancelRoutedEventArgs)

    Raises the CurrentCellChanging event.

    Declaration
    protected virtual void OnCurrentCellChanging(SyncfusionCancelRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionCancelRoutedEventArgs e

    A System.ComponentModel.CancelEventArgs that contains the event data.

    OnCurrentCellClosedDropDown(SyncfusionRoutedEventArgs)

    Declaration
    protected virtual void OnCurrentCellClosedDropDown(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    OnCurrentCellConfirmChangesFailed(SyncfusionRoutedEventArgs)

    Raises the CurrentCellConfirmChangesFailed event.

    Declaration
    protected virtual void OnCurrentCellConfirmChangesFailed(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellDeactivated(GridCurrentCellDeactivatedEventArgs)

    Raises the CurrentCellDeactivated event.

    Declaration
    protected virtual void OnCurrentCellDeactivated(GridCurrentCellDeactivatedEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellDeactivatedEventArgs e

    A GridCurrentCellDeactivatedEventArgs that contains the event data.

    OnCurrentCellDeactivateFailed(SyncfusionRoutedEventArgs)

    Raises the CurrentCellDeactivateFailed event.

    Declaration
    protected virtual void OnCurrentCellDeactivateFailed(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellDeactivating(SyncfusionCancelRoutedEventArgs)

    Raises the CurrentCellDeactivating event.

    Declaration
    protected virtual void OnCurrentCellDeactivating(SyncfusionCancelRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionCancelRoutedEventArgs e

    An System.ComponentModel.CancelEventArgs that contains the event data.

    OnCurrentCellEditingComplete(SyncfusionRoutedEventArgs)

    Raises the CurrentCellEditingComplete event.

    Declaration
    protected virtual void OnCurrentCellEditingComplete(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellKeyDown(GridCellKeyEventArgs)

    Declaration
    protected virtual bool OnCurrentCellKeyDown(GridCellKeyEventArgs e)
    Parameters
    Type Name Description
    GridCellKeyEventArgs e
    Returns
    Type Description
    System.Boolean

    OnCurrentCellMoved(GridCurrentCellMovedEventArgs)

    Raises the CurrentCellMoved event.

    Declaration
    protected virtual void OnCurrentCellMoved(GridCurrentCellMovedEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellMovedEventArgs e

    A GridCurrentCellMovedEventArgs that contains the event data.

    OnCurrentCellMoveFailed(GridCurrentCellMoveFailedEventArgs)

    Raises the CurrentCellMoveFailed event.

    Declaration
    protected virtual void OnCurrentCellMoveFailed(GridCurrentCellMoveFailedEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellMoveFailedEventArgs e

    A GridCurrentCellMoveFailedEventArgs that contains the event data.

    OnCurrentCellMoving(GridCurrentCellMovingEventArgs)

    Raises the CurrentCellMoving event.

    Declaration
    protected virtual void OnCurrentCellMoving(GridCurrentCellMovingEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellMovingEventArgs e

    A GridCurrentCellMovingEventArgs that contains the event data.

    OnCurrentCellPreviewKeyDown(GridCellKeyEventArgs)

    Declaration
    protected virtual bool OnCurrentCellPreviewKeyDown(GridCellKeyEventArgs e)
    Parameters
    Type Name Description
    GridCellKeyEventArgs e
    Returns
    Type Description
    System.Boolean

    OnCurrentCellRejectedChanges(SyncfusionRoutedEventArgs)

    Raises the CurrentCellRejectedChanges event.

    Declaration
    protected virtual void OnCurrentCellRejectedChanges(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellShowedDropDown(SyncfusionRoutedEventArgs)

    Occurs after the drop-down part has been dropped-down and made visible.

    Declaration
    protected virtual void OnCurrentCellShowedDropDown(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    OnCurrentCellShowingDropDown(GridCurrentCellShowingDropDownEventArgs)

    Declaration
    protected virtual void OnCurrentCellShowingDropDown(GridCurrentCellShowingDropDownEventArgs e)
    Parameters
    Type Name Description
    GridCurrentCellShowingDropDownEventArgs e

    OnCurrentCellStartEditing(SyncfusionCancelRoutedEventArgs)

    Raises the CurrentCellStartEditing event.

    Declaration
    protected virtual void OnCurrentCellStartEditing(SyncfusionCancelRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionCancelRoutedEventArgs e

    A System.ComponentModel.CancelEventArgs that contains the event data.

    OnCurrentCellValidated(SyncfusionRoutedEventArgs)

    Raises the CurrentCellValidated event.

    Declaration
    protected virtual void OnCurrentCellValidated(SyncfusionRoutedEventArgs e)
    Parameters
    Type Name Description
    SyncfusionRoutedEventArgs e

    An System.EventArgs that contains the event data.

    OnCurrentCellValidating(CurrentCellValidatingEventArgs)

    Raises the cancelable CurrentCellValidating event.

    Declaration
    protected virtual void OnCurrentCellValidating(CurrentCellValidatingEventArgs e)
    Parameters
    Type Name Description
    CurrentCellValidatingEventArgs e

    An System.ComponentModel.CancelEventArgs that contains the event data.

    OnDragEnter(DragEventArgs)

    Declaration
    protected override void OnDragEnter(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e

    OnDragLeave(DragEventArgs)

    Declaration
    protected override void OnDragLeave(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e

    OnDragOver(DragEventArgs)

    Declaration
    protected override void OnDragOver(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e

    OnDrop(DragEventArgs)

    Declaration
    protected override void OnDrop(DragEventArgs e)
    Parameters
    Type Name Description
    System.Windows.DragEventArgs e
    Overrides
    ScrollControl.OnDrop(DragEventArgs)

    OnDropDownSelectionChanged(GridCellComboValueChangedEventArgs)

    Declaration
    protected virtual void OnDropDownSelectionChanged(GridCellComboValueChangedEventArgs args)
    Parameters
    Type Name Description
    GridCellComboValueChangedEventArgs args

    OnExecutedCopy(ExecutedRoutedEventArgs)

    Declaration
    protected virtual void OnExecutedCopy(ExecutedRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.ExecutedRoutedEventArgs args

    OnExecutedCut(ExecutedRoutedEventArgs)

    Declaration
    protected virtual void OnExecutedCut(ExecutedRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.ExecutedRoutedEventArgs args

    OnExecutedPaste(ExecutedRoutedEventArgs)

    Declaration
    protected virtual void OnExecutedPaste(ExecutedRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.ExecutedRoutedEventArgs args

    OnExecuteRedo(ExecutedRoutedEventArgs)

    Declaration
    protected virtual void OnExecuteRedo(ExecutedRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.ExecutedRoutedEventArgs args

    OnExecuteUndo(ExecutedRoutedEventArgs)

    Declaration
    protected virtual void OnExecuteUndo(ExecutedRoutedEventArgs args)
    Parameters
    Type Name Description
    System.Windows.Input.ExecutedRoutedEventArgs args

    OnGridCellCursor(GridCellCursorEventArgs)

    Declaration
    protected virtual void OnGridCellCursor(GridCellCursorEventArgs args)
    Parameters
    Type Name Description
    GridCellCursorEventArgs args

    OnGridCellRenderEvent(GridCellRenderEventArgs)

    Declaration
    protected virtual void OnGridCellRenderEvent(GridCellRenderEventArgs args)
    Parameters
    Type Name Description
    GridCellRenderEventArgs args

    OnKeyDown(KeyEventArgs)

    Declaration
    protected override void OnKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e
    Overrides
    VirtualizingCellsControl.OnKeyDown(KeyEventArgs)

    OnModelCreated()

    Declaration
    protected virtual GridModel OnModelCreated()
    Returns
    Type Description
    GridModel

    OnMouseLeave(MouseEventArgs)

    Declaration
    protected override void OnMouseLeave(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e
    Overrides
    ScrollControl.OnMouseLeave(MouseEventArgs)

    OnMoveCurrentCellDirection(GridMoveCurrentCellDirectionEventArgs)

    Raises the MoveCurrentCellDirection event.

    Declaration
    protected virtual void OnMoveCurrentCellDirection(GridMoveCurrentCellDirectionEventArgs e)
    Parameters
    Type Name Description
    GridMoveCurrentCellDirectionEventArgs e

    A GridMoveCurrentCellDirectionEventArgs that contains the event data.

    OnParseCommonFormats(GridCellTextEventArgs)

    Declaration
    protected virtual void OnParseCommonFormats(GridCellTextEventArgs e)
    Parameters
    Type Name Description
    GridCellTextEventArgs e

    OnPrepareRenderCell(GridPrepareRenderCellEventArgs)

    Declaration
    protected virtual void OnPrepareRenderCell(GridPrepareRenderCellEventArgs e)
    Parameters
    Type Name Description
    GridPrepareRenderCellEventArgs e

    OnPreviewKeyDown(KeyEventArgs)

    Declaration
    protected override void OnPreviewKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e
    Overrides
    VirtualizingCellsControl.OnPreviewKeyDown(KeyEventArgs)

    OnPreviewMouseDown(MouseButtonEventArgs)

    Declaration
    protected override void OnPreviewMouseDown(MouseButtonEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseButtonEventArgs e
    Overrides
    ScrollControl.OnPreviewMouseDown(MouseButtonEventArgs)

    OnPreviewMouseMove(MouseEventArgs)

    Implements handling for the PreviewMouseMove�event. When no mouse button is pressed and the mouse is over a cell it calls .

    Declaration
    protected override void OnPreviewMouseMove(MouseEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.MouseEventArgs e

    The System.Windows.Input.MouseEventArgs that contains the event data.

    Overrides
    ScrollControl.OnPreviewMouseMove(MouseEventArgs)

    OnPreviewTextInput(TextCompositionEventArgs)

    Declaration
    protected override void OnPreviewTextInput(TextCompositionEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.TextCompositionEventArgs e

    OnQueryBaseStyles(GridQueryBaseStylesEventArgs)

    Declaration
    protected virtual void OnQueryBaseStyles(GridQueryBaseStylesEventArgs e)
    Parameters
    Type Name Description
    GridQueryBaseStylesEventArgs e

    OnQueryCanDragRange(GridQueryCanDragRangeEventArgs)

    Raises the event.

    Declaration
    protected virtual void OnQueryCanDragRange(GridQueryCanDragRangeEventArgs e)
    Parameters
    Type Name Description
    GridQueryCanDragRangeEventArgs e

    An that contains the event data.

    OnQueryCellFormattedText(GridCellTextEventArgs)

    Declaration
    protected virtual void OnQueryCellFormattedText(GridCellTextEventArgs e)
    Parameters
    Type Name Description
    GridCellTextEventArgs e

    OnQueryCellInfo(GridQueryCellInfoEventArgs)

    Declaration
    protected virtual void OnQueryCellInfo(GridQueryCellInfoEventArgs e)
    Parameters
    Type Name Description
    GridQueryCellInfoEventArgs e

    OnQueryCellModel(GridQueryCellModelEventArgs)

    Declaration
    protected virtual void OnQueryCellModel(GridQueryCellModelEventArgs e)
    Parameters
    Type Name Description
    GridQueryCellModelEventArgs e

    OnQueryCellSpanBackgrounds(GridQueryCellSpanBackgroundsEventArgs)

    Declaration
    protected virtual void OnQueryCellSpanBackgrounds(GridQueryCellSpanBackgroundsEventArgs e)
    Parameters
    Type Name Description
    GridQueryCellSpanBackgroundsEventArgs e

    OnQueryCellText(GridCellTextEventArgs)

    Declaration
    protected virtual void OnQueryCellText(GridCellTextEventArgs e)
    Parameters
    Type Name Description
    GridCellTextEventArgs e

    OnQueryCoveredRange(GridQueryCoveredRangeEventArgs)

    Declaration
    protected virtual void OnQueryCoveredRange(GridQueryCoveredRangeEventArgs e)
    Parameters
    Type Name Description
    GridQueryCoveredRangeEventArgs e

    OnQueryNextCurrentCellPosition(GridQueryNextCurrentCellPositionEventArgs)

    Raises the QueryNextCurrentCellPosition event.

    Declaration
    protected virtual void OnQueryNextCurrentCellPosition(GridQueryNextCurrentCellPositionEventArgs e)
    Parameters
    Type Name Description
    GridQueryNextCurrentCellPositionEventArgs e

    A GridQueryNextCurrentCellPositionEventArgs that contains the event data.

    OnRaiseQueryAllowDragColumn(GridQueryDragColumnHeaderEventArgs)

    Declaration
    protected virtual void OnRaiseQueryAllowDragColumn(GridQueryDragColumnHeaderEventArgs ae)
    Parameters
    Type Name Description
    GridQueryDragColumnHeaderEventArgs ae

    OnRender(DrawingContext)

    Declaration
    protected override void OnRender(DrawingContext dc)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    Overrides
    VirtualizingCellsControl.OnRender(DrawingContext)

    OnRenderCell(DrawingContext, RenderCellArgs)

    Declaration
    protected override void OnRenderCell(DrawingContext dc, RenderCellArgs rca)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    RenderCellArgs rca
    Overrides
    VirtualizingCellsControl.OnRenderCell(DrawingContext, RenderCellArgs)

    OnRenderHiddenColBorder(DrawingContext, RenderCellArgs, Boolean)

    Declaration
    protected virtual void OnRenderHiddenColBorder(DrawingContext dc, RenderCellArgs rca, bool preceding)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    RenderCellArgs rca
    System.Boolean preceding

    OnRenderHiddenRowBorder(DrawingContext, RenderCellArgs, Boolean)

    Declaration
    protected virtual void OnRenderHiddenRowBorder(DrawingContext dc, RenderCellArgs rca, bool preceding)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    RenderCellArgs rca
    System.Boolean preceding

    OnRenderSelectionBorder(DrawingContext, Rect, CellBorderSide, Pen)

    Declaration
    protected virtual void OnRenderSelectionBorder(DrawingContext dc, Rect cellRect, CellBorderSide borderSide, Pen pen)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    System.Windows.Rect cellRect
    CellBorderSide borderSide
    System.Windows.Media.Pen pen

    OnResizingColumns(GridResizingColumnsEventArgs)

    Declaration
    protected virtual void OnResizingColumns(GridResizingColumnsEventArgs args)
    Parameters
    Type Name Description
    GridResizingColumnsEventArgs args

    OnResizingRows(GridResizingRowsEventArgs)

    Declaration
    protected virtual void OnResizingRows(GridResizingRowsEventArgs args)
    Parameters
    Type Name Description
    GridResizingRowsEventArgs args

    OnRowsInserted(GridRangeInsertedEventArgs)

    Declaration
    protected virtual void OnRowsInserted(GridRangeInsertedEventArgs e)
    Parameters
    Type Name Description
    GridRangeInsertedEventArgs e

    OnRowsMoved(GridRangeMovedEventArgs)

    Declaration
    protected virtual void OnRowsMoved(GridRangeMovedEventArgs e)
    Parameters
    Type Name Description
    GridRangeMovedEventArgs e

    OnRowsRemoved(GridRangeRemovedEventArgs)

    Declaration
    protected virtual void OnRowsRemoved(GridRangeRemovedEventArgs e)
    Parameters
    Type Name Description
    GridRangeRemovedEventArgs e

    OnSaveCellFormattedText(GridCellTextEventArgs)

    Declaration
    protected virtual void OnSaveCellFormattedText(GridCellTextEventArgs e)
    Parameters
    Type Name Description
    GridCellTextEventArgs e

    OnSaveCellText(GridCellTextEventArgs)

    Declaration
    protected virtual void OnSaveCellText(GridCellTextEventArgs e)
    Parameters
    Type Name Description
    GridCellTextEventArgs e

    OnSelectionChanged(GridSelectionChangedEventArgs)

    Declaration
    protected virtual void OnSelectionChanged(GridSelectionChangedEventArgs e)
    Parameters
    Type Name Description
    GridSelectionChangedEventArgs e

    OnSelectionChanging(GridSelectionChangingEventArgs)

    Declaration
    protected virtual void OnSelectionChanging(GridSelectionChangingEventArgs e)
    Parameters
    Type Name Description
    GridSelectionChangingEventArgs e

    OnUnloaded(RoutedEventArgs)

    Declaration
    protected override void OnUnloaded(RoutedEventArgs e)
    Parameters
    Type Name Description
    System.Windows.RoutedEventArgs e
    Overrides
    VirtualizingCellsControl.OnUnloaded(RoutedEventArgs)

    OnWrapCellNextControlInForm(GridWrapCellNextControlInFormEventArgs)

    Raises the WrapCellNextControlInForm event.

    Declaration
    protected virtual void OnWrapCellNextControlInForm(GridWrapCellNextControlInFormEventArgs e)
    Parameters
    Type Name Description
    GridWrapCellNextControlInFormEventArgs e

    A GridWrapCellNextControlInFormEventArgs that contains the event data.

    RaiseCellCommentOpening(RowColumnIndex, ContentControl, String)

    Declaration
    public void RaiseCellCommentOpening(RowColumnIndex cell, ContentControl popup, string corner)
    Parameters
    Type Name Description
    RowColumnIndex cell
    System.Windows.Controls.ContentControl popup
    System.String corner

    RaiseCellToolTipOpening(RowColumnIndex, ContentControl)

    Declaration
    public void RaiseCellToolTipOpening(RowColumnIndex cell, ContentControl popup)
    Parameters
    Type Name Description
    RowColumnIndex cell
    System.Windows.Controls.ContentControl popup

    RaiseCurrenctCellLoaded(RowColumnIndex, UIElement)

    Declaration
    public void RaiseCurrenctCellLoaded(RowColumnIndex cell, UIElement element)
    Parameters
    Type Name Description
    RowColumnIndex cell
    System.Windows.UIElement element

    RaiseGridDataQueryAllowDragColumn(Int32, Int32, GridQueryDragColumnHeaderReason, GridQueryDragColumnHeaderAction)

    Declaration
    public virtual GridDataQueryDragColumnHeaderEventArgs RaiseGridDataQueryAllowDragColumn(int colIndex, int insertBeforeColumn, GridQueryDragColumnHeaderReason reason, GridQueryDragColumnHeaderAction tag)
    Parameters
    Type Name Description
    System.Int32 colIndex
    System.Int32 insertBeforeColumn
    GridQueryDragColumnHeaderReason reason
    GridQueryDragColumnHeaderAction tag
    Returns
    Type Description
    GridDataQueryDragColumnHeaderEventArgs

    RaiseQueryAllowDragColumn(Int32, Int32, GridQueryDragColumnHeaderReason)

    Declaration
    public virtual bool RaiseQueryAllowDragColumn(int colIndex, int insertBeforeColumn, GridQueryDragColumnHeaderReason reason)
    Parameters
    Type Name Description
    System.Int32 colIndex
    System.Int32 insertBeforeColumn
    GridQueryDragColumnHeaderReason reason
    Returns
    Type Description
    System.Boolean

    RaiseQueryCanOleDragRange(GridQueryCanDragRangeEventArgs)

    Initiates call to .

    Declaration
    public void RaiseQueryCanOleDragRange(GridQueryCanDragRangeEventArgs e)
    Parameters
    Type Name Description
    GridQueryCanDragRangeEventArgs e

    The event arguments.

    RaiseWrapCellNextControlInForm(GridWrapCellNextControlInFormEventArgs)

    Initiates call to OnWrapCellNextControlInForm(GridWrapCellNextControlInFormEventArgs).

    Declaration
    public void RaiseWrapCellNextControlInForm(GridWrapCellNextControlInFormEventArgs e)
    Parameters
    Type Name Description
    GridWrapCellNextControlInFormEventArgs e

    The event arguments.

    RangeToClippedVisibleRect(RowColumnIndex)

    Returns the visible client rectangle for the given cell range.

    Declaration
    public Rect RangeToClippedVisibleRect(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Row and column indices as RowColumnIndex.

    Returns
    Type Description
    System.Windows.Rect

    Visible client rectangle for the given cell range.

    RangeToClippedVisibleRect(RowColumnIndex, Boolean)

    Returns the visible client rectangle for the given cell range.

    Declaration
    public Rect RangeToClippedVisibleRect(RowColumnIndex cellRowColumnIndex, bool expandCoveredCell)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    Row and column indices as RowColumnIndex.

    System.Boolean expandCoveredCell

    When true, any covered cell will be expanded before calculating the visible rectangle.

    Returns
    Type Description
    System.Windows.Rect

    Visible client rectangle for the given cell range.

    RangeToClippedVisibleRect(GridRangeInfo)

    Returns the visible client rectangle for the given cell range.

    Declaration
    public Rect RangeToClippedVisibleRect(GridRangeInfo range)
    Parameters
    Type Name Description
    GridRangeInfo range

    Cell range.

    Returns
    Type Description
    System.Windows.Rect

    Visible client rectangle for the given cell range.

    RangeToRect(ScrollAxisRegion, ScrollAxisRegion, GridRangeInfo, Boolean, Boolean)

    For internal use.

    Declaration
    public Rect RangeToRect(ScrollAxisRegion rowRegion, ScrollAxisRegion columnRegion, GridRangeInfo range, bool allowEstimatesForOutOfViewRows, bool allowEstimatesForOutOfViewColumns)
    Parameters
    Type Name Description
    ScrollAxisRegion rowRegion

    Scroll axis region for row.

    ScrollAxisRegion columnRegion

    Scroll axis region for column.

    GridRangeInfo range

    Cell range.

    System.Boolean allowEstimatesForOutOfViewRows

    If set to true, allows estimate for out of view rows.

    System.Boolean allowEstimatesForOutOfViewColumns

    If set to true, allows estimate for out of view columns.

    Returns
    Type Description
    System.Windows.Rect

    Visible rectangle for the given range.

    RegisterDataObjectConsumer(IGridDataObjectConsumer)

    Registers a IGridDataObjectConsumer with the grid that can participate in an OLE Drop Target operation. If you want to add support for custom clipboard formats, you should create a class that implements IGridDataObjectConsumer and register it with RegisterDataObjectConsumer(IGridDataObjectConsumer).

    Declaration
    public void RegisterDataObjectConsumer(IGridDataObjectConsumer consumer)
    Parameters
    Type Name Description
    IGridDataObjectConsumer consumer

    An IGridDataObjectConsumer to be added to the internal collection of OLE Drop Target consumers.

    RenderActiveRangeBorder()

    Declaration
    protected virtual void RenderActiveRangeBorder()

    RenderCellBorders(DrawingContext)

    Declaration
    protected override void RenderCellBorders(DrawingContext dc)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    Overrides
    VirtualizingCellsControl.RenderCellBorders(DrawingContext)

    RenderCellComment(DrawingContext, GridStyleInfo, Rect)

    Declaration
    protected virtual void RenderCellComment(DrawingContext dc, GridStyleInfo style, Rect cellRect)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    GridStyleInfo style
    System.Windows.Rect cellRect

    RenderCellErrorInfo(DrawingContext, GridStyleInfo, Rect)

    Declaration
    protected virtual void RenderCellErrorInfo(DrawingContext dc, GridStyleInfo style, Rect cellRect)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    GridStyleInfo style
    System.Windows.Rect cellRect

    RenderCellImage(DrawingContext, GridStyleInfo, Rect)

    Declaration
    protected virtual void RenderCellImage(DrawingContext dc, GridStyleInfo style, Rect cellRect)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    GridStyleInfo style
    System.Windows.Rect cellRect

    RenderCells(DrawingContext)

    Declaration
    protected override void RenderCells(DrawingContext dc)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc
    Overrides
    VirtualizingCellsControl.RenderCells(DrawingContext)

    RenderCurrentCellBorder()

    Render current cell border into the dvCurrentCellBorder DrawingVisual of the ScrollControl.ForegroundFrame. This will not trigger any InvalidateVisual or InvalidateArrange calls.

    Declaration
    protected virtual void RenderCurrentCellBorder()

    RenderCurrentCellBorder(DrawingContext, Rect)

    Declaration
    protected virtual void RenderCurrentCellBorder(DrawingContext dccBorder, Rect r)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dccBorder
    System.Windows.Rect r

    RenderHiddenCellBorder()

    Declaration
    protected virtual void RenderHiddenCellBorder()

    RenderRow(DrawingContext, VisibleLineInfo, Point)

    Renders a row of cells. The method calls OnRenderCell(DrawingContext, RenderCellArgs) for each cell. OnRenderCell gets the ICellRenderer for a cell and calls its Render(DrawingContext, RenderCellArgs) method.

    Declaration
    protected override void RenderRow(DrawingContext dc, VisibleLineInfo visibleRow, Point corner)
    Parameters
    Type Name Description
    System.Windows.Media.DrawingContext dc

    The drawing context.

    VisibleLineInfo visibleRow

    The visible row.

    System.Windows.Point corner

    The corner which is the point after the last visible row and column of the body region.

    Overrides
    VirtualizingCellsControl.RenderRow(DrawingContext, VisibleLineInfo, Point)

    RenderSelectedCells()

    Declaration
    protected virtual void RenderSelectedCells()

    ResetRowResize()

    Gets called from ResizeRowsMouseController when user ended resizing a row. The method calls ScrollRows.ResetLineResize followed by a call to InvalidateRowResize.

    Declaration
    public virtual void ResetRowResize()

    ResumeFormulaCalculation(GridRangeInfo)

    Resume the formula calculation while rendering the grid

    Declaration
    public void ResumeFormulaCalculation(GridRangeInfo Range)
    Parameters
    Type Name Description
    GridRangeInfo Range

    ScrollInView(RowColumnIndex)

    Brings the given cell into view.

    Declaration
    public virtual void ScrollInView(RowColumnIndex cellRowColumnIndex)
    Parameters
    Type Name Description
    RowColumnIndex cellRowColumnIndex

    The row and column indices as RowColumnIndex.

    SetAddSkinResourceForDataTemplate(DependencyObject, Boolean)

    Sets the AddSkinResourceForDataTemplate property. This dependency property indicates whether skins have to be added for DataTemplate as MergedDictionaries.

    Declaration
    public static void SetAddSkinResourceForDataTemplate(DependencyObject d, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d
    System.Boolean value

    SetAllowDropDownKeyHandling(DependencyObject, Boolean)

    Sets the AllowComboBoxDropDownKeyHandling property. This dependency property indicates whether ComboBox DropDown should handle up down key.

    Declaration
    public static void SetAllowDropDownKeyHandling(DependencyObject d, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject d
    System.Boolean value

    SetAllowSelectionInDataTemplate(DependencyObject, Boolean)

    Declaration
    public static void SetAllowSelectionInDataTemplate(DependencyObject o, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject o
    System.Boolean value

    SetAutomationTemplateElement(DependencyObject, Boolean)

    Sets the automation template element.

    Declaration
    public static void SetAutomationTemplateElement(DependencyObject dpo, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The dpo.

    System.Boolean value

    if set to true [value].

    SetCellRenderer(DependencyObject, IGridCellRenderer)

    Sets the attached dependency property value.

    Declaration
    public static void SetCellRenderer(DependencyObject dpo, IGridCellRenderer value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be assigned the value of the dependency property.

    IGridCellRenderer value

    The value.

    SetColumnWidth(Int32, Double)

    Sets the width for the given column.

    Declaration
    public virtual void SetColumnWidth(int columnIndex, double size)
    Parameters
    Type Name Description
    System.Int32 columnIndex

    The column index.

    System.Double size

    Column Width to be set.

    SetDelayLoad(DependencyObject, Boolean)

    Sets a boolean value if the DependencyObject should be loaded with a delay when it is created. Set this for templated controls.

    Declaration
    public static void SetDelayLoad(DependencyObject dpo, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo
    System.Boolean value

    SetIgnoreChangedEvent(DependencyObject, Boolean)

    Sets the attached dependency property value.

    Declaration
    public static void SetIgnoreChangedEvent(DependencyObject dpo, bool value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be assigned the value of the dependency property.

    System.Boolean value

    The value.

    SetPrintPageSize(Size)

    Sets the print page size.

    Declaration
    public void SetPrintPageSize(Size printSize)
    Parameters
    Type Name Description
    System.Windows.Size printSize

    Print size.

    SetRenderStyleInfo(DependencyObject, GridRenderStyleInfo)

    Sets the attached dependency property value.

    Declaration
    public static void SetRenderStyleInfo(DependencyObject dpo, GridRenderStyleInfo value)
    Parameters
    Type Name Description
    System.Windows.DependencyObject dpo

    The instance to be assigned the value of the dependency property.

    GridRenderStyleInfo value

    The value.

    SetRowHeight(Int32, Double)

    Sets the height for the given row.

    Declaration
    public virtual void SetRowHeight(int rowIndex, double size)
    Parameters
    Type Name Description
    System.Int32 rowIndex

    The row index.

    System.Double size

    Row Height to be set.

    SetRowResize(Int32, Double)

    Gets called from ResizeRowsMouseController when user resizes a row. The method calls ScrollRows.SetLineResize followed by a call to InvalidateRowResize.

    Declaration
    public virtual void SetRowResize(int index, double height)
    Parameters
    Type Name Description
    System.Int32 index
    System.Double height

    ShouldGraphicCellTryToHandlePreviewKeyDown(KeyEventArgs)

    Declaration
    protected virtual bool ShouldGraphicCellTryToHandlePreviewKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e
    Returns
    Type Description
    System.Boolean

    ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs)

    Declaration
    protected virtual bool ShouldGridTryToHandlePreviewKeyDown(KeyEventArgs e)
    Parameters
    Type Name Description
    System.Windows.Input.KeyEventArgs e
    Returns
    Type Description
    System.Boolean

    ShouldRenderCurrentCellBorder()

    Declaration
    protected virtual bool ShouldRenderCurrentCellBorder()
    Returns
    Type Description
    System.Boolean

    ShouldRenderStyleBackgrounds()

    Declaration
    protected override bool ShouldRenderStyleBackgrounds()
    Returns
    Type Description
    System.Boolean
    Overrides
    VirtualizingCellsControl.ShouldRenderStyleBackgrounds()

    SuspendFormulaCalculation()

    Suspend formula calculation while rendering the grid

    Declaration
    public void SuspendFormulaCalculation()

    UnloadArrangedCells()

    Recycles the UI element objects of the cells.

    Declaration
    public override void UnloadArrangedCells()
    Overrides
    VirtualizingCellsControl.UnloadArrangedCells()

    UnwireModel()

    Declaration
    protected virtual void UnwireModel()

    WireModel()

    Declaration
    protected virtual void WireModel()

    Events

    BaseStylesMapChanged

    Occurs when the GridModel.BaseStylesMap is changed.

    Declaration
    public event EventHandler BaseStylesMapChanged
    Event Type
    Type Description
    System.EventHandler

    CancelMode

    Occurs any current user interaction should be cancelled, e.g. cancel select cells when escape key is pressed.

    Declaration
    public event GridRoutedEventHandler CancelMode
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    WM_CANCELMODE is sent to cancel certain modes, such as mouse capture. For example, the system sends this message to the active window when a dialog box or message box is displayed. Certain functions also send this message explicitly to the specified window regardless of whether it is the active window. For example, the EnableWindow function sends this message when disabling the specified window.

    CellButtonClick

    Declaration
    public event GridCellButtonClickEventHandler CellButtonClick
    Event Type
    Type Description
    GridCellButtonClickEventHandler

    CellCancelMode

    Occurs when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the mouse operation is canceled.

    Declaration
    public event GridRoutedEventHandler CellCancelMode
    Event Type
    Type Description
    GridRoutedEventHandler

    CellClick

    Occurs when the user clicks inside a cell.

    Declaration
    public event GridCellClickEventHandler CellClick
    Event Type
    Type Description
    GridCellClickEventHandler

    CellCommentOpening

    Declaration
    public event GridControlBase.GridCellCommentOpeningEvent CellCommentOpening
    Event Type
    Type Description
    GridControlBase.GridCellCommentOpeningEvent

    CellCursor

    Grid queries for the cursor to display for a specific cell when the cell indicated previously with a non-zero hit-test value that it wants the mouse operation

    Declaration
    public event GridCellCursorEventHandler CellCursor
    Event Type
    Type Description
    GridCellCursorEventHandler

    CellModelsChanged

    Occurs when the CellModels collection is changed.

    Declaration
    public event CollectionChangeEventHandler CellModelsChanged
    Event Type
    Type Description
    System.ComponentModel.CollectionChangeEventHandler

    CellMouseDown

    Occurs when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button.

    Declaration
    public event GridCellMouseControllerEventHandler CellMouseDown
    Event Type
    Type Description
    GridCellMouseControllerEventHandler

    CellMouseHover

    Occurs when the cell's HitTest method indicated previously with a non-zero hit-test value that it wants the mouse operation or when the user is hovering the mouse over cells and the "SelectCells" mouse controller is about to handle the mouse operation.

    Declaration
    public event GridCellMouseControllerEventHandler CellMouseHover
    Event Type
    Type Description
    GridCellMouseControllerEventHandler

    CellMouseHoverEnter

    Occurs when the cell's HitTest method indicated previously with a non-zero hit-test value that it wants the mouse operation or when the user is hovering the mouse over cells and the "SelectCells" mouse controller is about to handle the mouse operation.

    Declaration
    public event GridCellMouseEventHandler CellMouseHoverEnter
    Event Type
    Type Description
    GridCellMouseEventHandler

    CellMouseHoverLeave

    Occurs when the cell's HitTest method indicated previously with a non-zero hit-test value that it wants the mouse operation or when the user is hovering the mouse over cells and the "SelectCells" mouse controller is about to handle the mouse operation.

    Declaration
    public event GridCellMouseEventHandler CellMouseHoverLeave
    Event Type
    Type Description
    GridCellMouseEventHandler

    CellMouseMove

    Occurs when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button and is moving the mouse pointer.

    Declaration
    public event GridCellMouseControllerEventHandler CellMouseMove
    Event Type
    Type Description
    GridCellMouseControllerEventHandler

    CellMouseUp

    Occurs when your cell renderer has indicated in its OnHitTest override that it wants to receive mouse events and the user has pressed a mouse button and is releasing the button.

    Declaration
    public event GridCellMouseControllerEventHandler CellMouseUp
    Event Type
    Type Description
    GridCellMouseControllerEventHandler

    CellRendered

    Occurs after the grid cells have been rendered.

    Declaration
    public event GridCellRenderEventHandler CellRendered
    Event Type
    Type Description
    GridCellRenderEventHandler

    CellRestoreMode

    Occurs after the CellCancelMode event and is used to restore the cell state.

    Declaration
    public event GridRoutedEventHandler CellRestoreMode
    Event Type
    Type Description
    GridRoutedEventHandler

    CellToolTipOpening

    Occurs before the opening of Tooltip Popup

    Declaration
    public event GridControlBase.GridCellToolTipOpeningEvent CellToolTipOpening
    Event Type
    Type Description
    GridControlBase.GridCellToolTipOpeningEvent

    ColumnsInserted

    Occurs after a range of columns has been inserted. See GridRangeInsertedEventArgs for more details.

    Declaration
    public event GridRangeInsertedEventHandler ColumnsInserted
    Event Type
    Type Description
    GridRangeInsertedEventHandler

    ColumnsMoved

    Occurs after a range of columns is moved. See GridRangeMovedEventArgs for more details.

    Declaration
    public event GridRangeMovedEventHandler ColumnsMoved
    Event Type
    Type Description
    GridRangeMovedEventHandler

    ColumnsRemoved

    Occurs after a range of columns has been removed. See GridRangeRemovedEventArgs for more details.

    Declaration
    public event GridRangeRemovedEventHandler ColumnsRemoved
    Event Type
    Type Description
    GridRangeRemovedEventHandler

    CommitCellInfo

    Occurs when the model is about to save style information about a specific cell.

    Declaration
    public event GridCommitCellInfoEventHandler CommitCellInfo
    Event Type
    Type Description
    GridCommitCellInfoEventHandler

    CommittedCellInfo

    Occurs when the model has saved style information about a specific cell.

    Declaration
    public event GridCommitCellInfoEventHandler CommittedCellInfo
    Event Type
    Type Description
    GridCommitCellInfoEventHandler

    CurrentCellAcceptedChanges

    Occurs when the grid accepts changes made to the active current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellAcceptedChanges
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid raises this cancelable event when the CurrentCell object's ConfirmChanges() method is called. Deactivate() and EndEdit() call this method when the current cell was in editing mode and its contents were modified and validated.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    If you assign true to System.ComponentModel.CancelEventArgs.Cancel, the grid will not deactivate the current cell.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellActivated

    Occurs after the grid activates the specified cell as current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellActivated
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    You can determine if Activate(Int32, Int32) was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See Also
    GridCurrentCellActivatingEventArgs
    Activate(Int32, Int32)
    IsInMoveTo

    CurrentCellActivateFailed

    Occurs after the grid fails to activate a specific cell as current cell.

    Declaration
    public event GridCurrentCellActivateFailedEventHandler CurrentCellActivateFailed
    Event Type
    Type Description
    GridCurrentCellActivateFailedEventHandler
    Remarks

    You can determine if Activate(Int32, Int32) was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    See Also
    GridCurrentCellActivateFailedEventArgs
    Activate(Int32, Int32)
    IsInMoveTo

    CurrentCellActivating

    Occurs before the grid activates the specified cell as current cell.

    Declaration
    public event GridCurrentCellActivatingEventHandler CurrentCellActivating
    Event Type
    Type Description
    GridCurrentCellActivatingEventHandler
    Remarks

    You can disallow the activation of specific cells at run-time when you assign True to System.ComponentModel.CancelEventArgs.Cancel.

    You can modify the CellRowColumnIndex to activate a different cell.

    You can determine if Activate(Int32, Int32) was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    Once the current cell has been activated, a CurrentCellActivated event is raised or a CurrentCellActivateFailed if activating the specified cell failed.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    See Also
    GridCurrentCellActivatingEventArgs
    Activate(Int32, Int32)
    IsInMoveTo

    CurrentCellChanged

    Occurs when the user changes contents of the current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellChanged
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid sends this event whenever changes occur, similar to a event.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellChanging

    Occurs when the user wants to modify contents of the current cell.

    Declaration
    public event GridCancelRoutedEventHandler CurrentCellChanging
    Event Type
    Type Description
    GridCancelRoutedEventHandler
    Remarks

    The grid sends this event before the changes are applied to the active cell. You can cancel the operation by setting System.ComponentModel.CancelEventArgs.Cancel to True.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellClosedDropDown

    Declaration
    public event GridRoutedEventHandler CurrentCellClosedDropDown
    Event Type
    Type Description
    GridRoutedEventHandler

    CurrentCellConfirmChangesFailed

    Occurs when the grid could not save changes made to the active current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellConfirmChangesFailed
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid raises this event when the CurrentCell object's ConfirmChanges() method is called and its contents were modified and could not be succesfully validated or saved back to the data source.

    The Exception and properties provide details why the operation failed. If you want to display a message box be sure to reset the the error state with .

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellDeactivated

    Occurs after the grid deactivates current cell.

    Declaration
    public event GridCurrentCellDeactivatedEventHandler CurrentCellDeactivated
    Event Type
    Type Description
    GridCurrentCellDeactivatedEventHandler
    Remarks

    The grid raises this event when the CurrentCell object's Deactivate() method is called. The event occurs after any CurrentCellRejectedChanges, CurrentCellAcceptedChanges, CurrentCellRejectedChanges, or CurrentCellAcceptedChanges are raised.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellDeactivateFailed

    Occurs after the grid fails to deactivate the current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellDeactivateFailed
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid raises this event when the CurrentCell object's Deactivate() method is called and can not deactivate the current cell. The reason deactivation may fail could be that the cell's contents were invalid or any of the event handlers associated with deactivating the current cell signaled to abort this operation.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellDeactivating

    Occurs before the grid the deactivates the current cell.

    Declaration
    public event GridCancelRoutedEventHandler CurrentCellDeactivating
    Event Type
    Type Description
    GridCancelRoutedEventHandler
    Remarks

    You can cancel the operation by setting System.ComponentModel.CancelEventArgs.Cancel to True.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    See Also
    Deactivate()
    IsInMoveTo

    CurrentCellEditingComplete

    Occurs when the grid completes editing mode for the active current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellEditingComplete
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid raises this event when the CurrentCell object's EndEdit() or CancelEdit() method is called. The event occurs after CurrentCellRejectedChanges or CurrentCellAcceptedChanges were raised.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellKeyDown

    Occurs during a key press in the current cell.

    Declaration
    public event GridCellKeyEventHandler CurrentCellKeyDown
    Event Type
    Type Description
    GridCellKeyEventHandler

    CurrentCellLoaded

    Declaration
    public event GridControlBase.GridCurrentCellLoadedEvent CurrentCellLoaded
    Event Type
    Type Description
    GridControlBase.GridCurrentCellLoadedEvent

    CurrentCellMoved

    Occurs when the current cell has been successfully moved to a new position.

    Declaration
    public event GridCurrentCellMovedEventHandler CurrentCellMoved
    Event Type
    Type Description
    GridCurrentCellMovedEventHandler
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    See Also
    GridCurrentCellMovedEventArgs
    MoveTo(Int32, Int32)

    CurrentCellMoveFailed

    Occurs when the current cell fails to be moved to a new position.

    Declaration
    public event GridCurrentCellMoveFailedEventHandler CurrentCellMoveFailed
    Event Type
    Type Description
    GridCurrentCellMoveFailedEventHandler
    Remarks

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    might hold an error message why the operation failed.

    See Also
    GridCurrentCellMoveFailedEventArgs
    MoveTo(Int32, Int32)

    CurrentCellMoving

    Occurs when the current cell is about to be moved to a new position.

    Declaration
    public event GridCurrentCellMovingEventHandler CurrentCellMoving
    Event Type
    Type Description
    GridCurrentCellMovingEventHandler
    Remarks

    You can disallow the activataion of specific cells at run-time when you assign True to System.ComponentModel.CancelEventArgs.Cancel.

    You can modify the CellRowColumnIndex to activate a different cell.

    You can also modify the .

    Once the current cell has been moved, a CurrentCellMoved event is raised or a CurrentCellMoveFailed if moving to the specified target cell failed.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    See Also
    GridCurrentCellMovingEventArgs
    MoveTo(Int32, Int32)

    CurrentCellPreviewKeyDown

    Occurs during the PreviewKeyDown event for the current cell.

    Declaration
    public event GridCellKeyEventHandler CurrentCellPreviewKeyDown
    Event Type
    Type Description
    GridCellKeyEventHandler

    CurrentCellRejectedChanges

    Occurs when the grid rejects changes made to the active current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellRejectedChanges
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    The grid raises this event when the CurrentCell object's RejectChanges() method is called. Deactivate() and CancelEdit() call this method when the current cell was in editing mode and its contents were modified.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellShowedDropDown

    Occurs after the drop-down part has been dropped-down and made visible.

    Declaration
    public event GridRoutedEventHandler CurrentCellShowedDropDown
    Event Type
    Type Description
    GridRoutedEventHandler

    CurrentCellShowingDropDown

    Declaration
    public event GridCurrentCellShowingDropDownEventHandler CurrentCellShowingDropDown
    Event Type
    Type Description
    GridCurrentCellShowingDropDownEventHandler

    CurrentCellStartEditing

    Occurs before the current cell switches into editing mode.

    Declaration
    public event GridCancelRoutedEventHandler CurrentCellStartEditing
    Event Type
    Type Description
    GridCancelRoutedEventHandler
    Remarks

    The grid will switch into editing mode when the user presses a key while the cell is not in editing mode or when you call BeginEdit(). You can cancel the operation by setting System.ComponentModel.CancelEventArgs.Cancel to True.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellValidated

    Occurs when the grid has successfully validated the contents of the active current cell.

    Declaration
    public event GridRoutedEventHandler CurrentCellValidated
    Event Type
    Type Description
    GridRoutedEventHandler
    Remarks

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    CurrentCellValidating

    Occurs when the grid validates contents of the active current cell.

    Declaration
    public event CurrentCellValidatingEventHandler CurrentCellValidating
    Event Type
    Type Description
    CurrentCellValidatingEventHandler
    Remarks

    You can mark the contents as invalid by by setting System.ComponentModel.CancelEventArgs.Cancel to True.

    The grid raises this event when the CurrentCell object's Validate() method is called. Deactivate() calls this method when the current cell was in editing mode and its contents were modified.

    You can determine if Deactivate() was called stand-alone or as result of a MoveTo(Int32, Int32) call by checking the IsInMoveTo property.

    You can find out about the current cell's position by querying the CellRowColumnIndex property of the CurrentCell object in GridControlBase.

    See MoveTo(Int32, Int32) for a discussion about the order of events that you receive when the current cell is moved.

    DropDownSelectionChanged

    Declaration
    public event GridCellComboValueChangedEventHandler DropDownSelectionChanged
    Event Type
    Type Description
    GridCellComboValueChangedEventHandler

    MoveCurrentCellDirection

    Occurs when the direction for current cell movement is changed.

    Declaration
    public event GridMoveCurrentCellDirectionEventHandler MoveCurrentCellDirection
    Event Type
    Type Description
    GridMoveCurrentCellDirectionEventHandler

    ParseCommonFormats

    Use this event to provide support for parsing the formatted string and convert it into the the underlying cell's value considering Format and CellValueType.

    This event is raised from GridCellModelBase.ApplyFormattedText after SaveCellFormattedText was raised. The event is raised only if the SaveCellFormattedText did not set e.Handled.

    Declaration
    public event GridCellTextEventHandler ParseCommonFormats
    Event Type
    Type Description
    GridCellTextEventHandler

    PrepareRenderCell

    Occurs before a cell gets rendered.

    Declaration
    public event GridPrepareRenderCellEventHandler PrepareRenderCell
    Event Type
    Type Description
    GridPrepareRenderCellEventHandler

    QueryAllowDragColumn

    Occurs when the user hovers the mouse over the edge of a selected range. You can determine whether to allow the column drag action.

    Declaration
    public event GridQueryDragColumnHeaderEventHandler QueryAllowDragColumn
    Event Type
    Type Description
    GridQueryDragColumnHeaderEventHandler

    QueryBaseStyles

    Occurs when the model queries information about base styles at a specific cell.

    Declaration
    public event GridQueryBaseStylesEventHandler QueryBaseStyles
    Event Type
    Type Description
    GridQueryBaseStylesEventHandler

    QueryCanDragRange

    Declaration
    public event GridExcelLikeDragRangeEventHandler QueryCanDragRange
    Event Type
    Type Description
    GridExcelLikeDragRangeEventHandler

    QueryCellFormattedText

    Occurs each time the FormattedText is called to get the formatted string that represents the underlying cell's value considering Format.

    Declaration
    public event GridCellTextEventHandler QueryCellFormattedText
    Event Type
    Type Description
    GridCellTextEventHandler

    QueryCellInfo

    Occurs when the model queries for style information about a specific cell.

    Declaration
    public event GridQueryCellInfoEventHandler QueryCellInfo
    Event Type
    Type Description
    GridQueryCellInfoEventHandler

    QueryCellModel

    Occurs when querying for a cell type.

    Declaration
    public event GridQueryCellModelEventHandler QueryCellModel
    Event Type
    Type Description
    GridQueryCellModelEventHandler

    QueryCellSpanBackgrounds

    Occurs when the model queries information about a cell spanned range at a specific cell.

    Declaration
    public event GridQueryCellSpanBackgroundsEventHandler QueryCellSpanBackgrounds
    Event Type
    Type Description
    GridQueryCellSpanBackgroundsEventHandler

    QueryCellText

    Occurs each time the Text is called to get the raw string that represents the underlying cell's value.

    Declaration
    public event GridCellTextEventHandler QueryCellText
    Event Type
    Type Description
    GridCellTextEventHandler

    QueryCoveredRange

    Occurs when the model queries information about covered cells at a specific cell.

    Declaration
    public event GridQueryCoveredRangeEventHandler QueryCoveredRange
    Event Type
    Type Description
    GridQueryCoveredRangeEventHandler

    QueryNextCurrentCellPosition

    Occurs when the model queries the next position to move the current cell.

    Declaration
    public event GridQueryNextCurrentCellPositionEventHandler QueryNextCurrentCellPosition
    Event Type
    Type Description
    GridQueryNextCurrentCellPositionEventHandler

    ResizingColumns

    Occurs when the user is resizing a selected range of columns.

    Declaration
    public event GridResizingColumnsEventHandler ResizingColumns
    Event Type
    Type Description
    GridResizingColumnsEventHandler

    ResizingRows

    Occurs when the user is resizing a selected range of rows.

    Declaration
    public event GridResizingRowsEventHandler ResizingRows
    Event Type
    Type Description
    GridResizingRowsEventHandler

    RowsInserted

    Occurs after a range of rows has been inserted. See GridRangeInsertedEventArgs for more details.

    Declaration
    public event GridRangeInsertedEventHandler RowsInserted
    Event Type
    Type Description
    GridRangeInsertedEventHandler

    RowsMoved

    Occurs after a range of rows is moved. See GridRangeMovedEventArgs for more details.

    Declaration
    public event GridRangeMovedEventHandler RowsMoved
    Event Type
    Type Description
    GridRangeMovedEventHandler

    RowsRemoved

    Occurs after a range of rows has been removed. See GridRangeRemovedEventArgs for more details.

    Declaration
    public event GridRangeRemovedEventHandler RowsRemoved
    Event Type
    Type Description
    GridRangeRemovedEventHandler

    SaveCellFormattedText

    Occurs each time the FormattedText is called to parse the formatted string that represents the underlying cell's value considering Format and CellValueType.

    Declaration
    public event GridCellTextEventHandler SaveCellFormattedText
    Event Type
    Type Description
    GridCellTextEventHandler

    SaveCellText

    Occurs each time the Text is called to set the unformatted string that represents the underlying cell's value.

    Declaration
    public event GridCellTextEventHandler SaveCellText
    Event Type
    Type Description
    GridCellTextEventHandler

    SelectionChanged

    Occurs after the model updates its internal data structures when the model is in the process of selecting a range of cells.

    Declaration
    public event GridSelectionChangedEventHandler SelectionChanged
    Event Type
    Type Description
    GridSelectionChangedEventHandler

    SelectionChanging

    Occurs before the model updates internal data structures when the model is in the process of selecting a range of cells.

    Declaration
    public event GridSelectionChangingEventHandler SelectionChanging
    Event Type
    Type Description
    GridSelectionChangingEventHandler

    WrapCellNextControlInForm

    Occurs before the grid is about to be left because the user is at the top-left or bottom-right cell and about to tab out of the grid. This event is only raised if the NextControlInForm has been specified for WrapCell.

    Declaration
    public event GridWrapCellNextControlInFormEventHandler WrapCellNextControlInForm
    Event Type
    Type Description
    GridWrapCellNextControlInFormEventHandler
    See Also
    GridWrapCellNextControlInFormEventHandler

    Explicit Interface Implementations

    IGridPrintPaginator.GetPrintTotalPageCount(Size)

    Declaration
    int IGridPrintPaginator.GetPrintTotalPageCount(Size printPageSize)
    Parameters
    Type Name Description
    System.Windows.Size printPageSize
    Returns
    Type Description
    System.Int32

    IGridPrintPaginator.GetPrintVisualAt(Int32, Size)

    Declaration
    FrameworkElement IGridPrintPaginator.GetPrintVisualAt(int pageNumber, Size PageSize)
    Parameters
    Type Name Description
    System.Int32 pageNumber
    System.Windows.Size PageSize
    Returns
    Type Description
    System.Windows.FrameworkElement

    Implements

    IScrollBarProvider
    System.Windows.Controls.Primitives.IScrollInfo
    System.IDisposable
    IGridPrintPaginator

    Extension Methods

    GridPrintExtensions.ShowPrintDialog(GridControlBase)
    GridPrintExtensions.ShowPrintDialog(GridControlBase, Action<GridPrintDialog>)
    GridPrintExtensions.Print(GridControlBase)
    GridPrintExtensions.Print(GridControlBase, Action<PrintDialog>)
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved