Class GridTableElement

Represents the main table element in a grid view that handles displaying rows and columns of data. This element is responsible for rendering the table structure, managing scrolling, and handling row and cell interactions.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
ScrollViewElement<RowsContainerElement>
GridTableElement
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class GridTableElement : ScrollViewElement<RowsContainerElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider, IRowView, IGridView, IGridViewEventListener

Constructors

GridTableElement()

Initializes a new instance of the GridTableElement class.

Declaration
public GridTableElement()

Fields

AlternatingRowColorProperty

Identifies the AlternatingRowColor dependency property.

Declaration
public static RadProperty AlternatingRowColorProperty
Field Value
RadProperty

CellSpacingProperty

Identifies the CellSpacing dependency property.

Declaration
public static RadProperty CellSpacingProperty
Field Value
RadProperty

ChildRowHeightProperty

Identifies the ChildRowHeight dependency property.

Declaration
public static RadProperty ChildRowHeightProperty
Field Value
RadProperty

ColumnDragHintProperty

Identifies the ColumnDragHint dependency property.

Declaration
public static RadProperty ColumnDragHintProperty
Field Value
RadProperty

CurrentRowHeaderImageProperty

Identifies the CurrentRowHeaderImage dependency property.

Declaration
public static RadProperty CurrentRowHeaderImageProperty
Field Value
RadProperty

DrawHorizontalOuterBorderProperty

This property is not relevant for this class.

Declaration
public static RadProperty DrawHorizontalOuterBorderProperty
Field Value
RadProperty

DrawVerticalOuterBorderProperty

This property is not relevant for this class.

Declaration
public static RadProperty DrawVerticalOuterBorderProperty
Field Value
RadProperty

EditRowHeaderImageProperty

Identifies the EditRowHeaderImage dependency property.

Declaration
public static RadProperty EditRowHeaderImageProperty
Field Value
RadProperty

EnableHotTrackingProperty

Identifies the EnableHotTracking dependency property.

Declaration
public static RadProperty EnableHotTrackingProperty
Field Value
RadProperty

ErrorRowHeaderImageProperty

Identifies the ErrorRowHeaderImage dependency property.

Declaration
public static RadProperty ErrorRowHeaderImageProperty
Field Value
RadProperty

ExtendVerticalScrollBarProperty

Identifies the ExtendVerticalScrollBar dependency property.

Declaration
public static RadProperty ExtendVerticalScrollBarProperty
Field Value
RadProperty

FilterRowHeightProperty

Identifies the FilterRowHeight dependency property.

Declaration
public static RadProperty FilterRowHeightProperty
Field Value
RadProperty

GridBorderHeightProperty

This property is not relevant for this class.

Declaration
public static RadProperty GridBorderHeightProperty
Field Value
RadProperty

GridBorderWidthProperty

This property is not relevant for this class.

Declaration
public static RadProperty GridBorderWidthProperty
Field Value
RadProperty

GroupHeaderHeightProperty

Identifies the GroupHeaderHeight dependency property.

Declaration
public static RadProperty GroupHeaderHeightProperty
Field Value
RadProperty

GroupIndentProperty

Identifies the GroupIndent dependency property.

Declaration
public static RadProperty GroupIndentProperty
Field Value
RadProperty

HasColumnHeadersProperty

Identifies the HasColumnHeaders dependency property.

Declaration
public static RadProperty HasColumnHeadersProperty
Field Value
RadProperty

MenuThemeNameProperty

Identifies the MenuThemeName dependency property.

Declaration
public static RadProperty MenuThemeNameProperty
Field Value
RadProperty

NewRowHeaderImageProperty

Identifies the NewRowHeaderImage dependency property.

Declaration
public static RadProperty NewRowHeaderImageProperty
Field Value
RadProperty

RowDragHintProperty

Identifies the RowDragHint dependency property.

Declaration
public static RadProperty RowDragHintProperty
Field Value
RadProperty

RowHeaderColumnWidthProperty

Identifies the RowHeaderColumnWidth dependency property.

Declaration
public static RadProperty RowHeaderColumnWidthProperty
Field Value
RadProperty

RowHeightProperty

Identifies the RowHeight dependency property.

Declaration
public static RadProperty RowHeightProperty
Field Value
RadProperty

RowSpacingProperty

Identifies the RowSpacing dependency property.

Declaration
public static RadProperty RowSpacingProperty
Field Value
RadProperty

ScrollBarThemeNameProperty

Identifies the ScrollBarThemeName dependency property.

Declaration
public static RadProperty ScrollBarThemeNameProperty
Field Value
RadProperty

SearchHighlightColorProperty

Identifies the SearchHighlightColor dependency property.

Declaration
public static RadProperty SearchHighlightColorProperty
Field Value
RadProperty

SearchRowHeaderImageProperty

Identifies the SearchRowHeaderImage dependency property.

Declaration
public static RadProperty SearchRowHeaderImageProperty
Field Value
RadProperty

SearchRowHeightProperty

Identifies the SearchRowHeight dependency property.

Declaration
public static RadProperty SearchRowHeightProperty
Field Value
RadProperty

SelectColumnWidthProperty

Identifies the SelectColumnWidth dependency property.

Declaration
public static RadProperty SelectColumnWidthProperty
Field Value
RadProperty

ShowSelfReferenceLinesProperty

Identifies the ShowSelfReferenceLines dependency property.

Declaration
public static RadProperty ShowSelfReferenceLinesProperty
Field Value
RadProperty

TableHeaderHeightProperty

Identifies the TableHeaderHeight dependency property.

Declaration
public static RadProperty TableHeaderHeightProperty
Field Value
RadProperty

TreeLevelIndentProperty

Identifies the TreeLevelIndent dependency property.

Declaration
public static RadProperty TreeLevelIndentProperty
Field Value
RadProperty

Properties

AlternatingRowColor

Gets or sets a value indicating the alternating row color for odd rows.

Declaration
[RadPropertyDefaultValue("AlternatingRowColor", typeof(GridTableElement))]
public virtual Color AlternatingRowColor { get; set; }
Property Value
System.Drawing.Color

CellElementProvider

Gets or sets the cell element provider.

Declaration
public IVirtualizedElementProvider<GridViewColumn> CellElementProvider { get; set; }
Property Value
IVirtualizedElementProvider<GridViewColumn>

The cell element provider.

CellSpacing

Gets or sets the horizontal spacing between adjacent cells in the grid.

Declaration
[RadPropertyDefaultValue("CellSpacing", typeof(GridTableElement))]
public virtual int CellSpacing { get; set; }
Property Value
System.Int32

ChildRowHeight

Gets or sets the height of child rows in a hierarchical grid structure. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("ChildRowHeight", typeof(GridTableElement))]
public virtual int ChildRowHeight { get; set; }
Property Value
System.Int32

ChildViews

Gets a collection containing all visible child views

Declaration
public ReadOnlyCollection<IRowView> ChildViews { get; }
Property Value
System.Collections.ObjectModel.ReadOnlyCollection<IRowView>

Implements

ColumnDragHint

Gets or sets the RadImageShape instance which describes the hint that indicates where a column will be dropped after a drag operation.

Declaration
[VsbBrowsable(true)]
public RadImageShape ColumnDragHint { get; set; }
Property Value
RadImageShape

ColumnScroller

Gets the column scroller.

Declaration
public ItemScroller<GridViewColumn> ColumnScroller { get; }
Property Value
ItemScroller<GridViewColumn>

The column scroller.

CurrentCell

Gets the current GridCellElement in the GridTableElement.

Declaration
public virtual GridCellElement CurrentCell { get; }
Property Value
GridCellElement

Implements

CurrentCellAddress

Gets the address of the current GridCellElement

Declaration
public virtual Point CurrentCellAddress { get; }
Property Value
System.Drawing.Point

Implements

CurrentRow

Gets the current GridRowElement in the GridTableElement.

Declaration
public virtual GridRowElement CurrentRow { get; }
Property Value
GridRowElement

Implements

CurrentRowHeaderImage

Gets or sets an image for the row header cell of the current GridRowElement.

Declaration
public virtual Image CurrentRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

EditRowHeaderImage

Gets or sets an image for the row header cell of the GridRowElement indicating it is currently in edit mode.

Declaration
public virtual Image EditRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

EnableHotTracking

Gets or sets a value indicating whether the hottracking behavior is enabled.

Declaration
[RadPropertyDefaultValue("EnableHotTracking", typeof(GridTableElement))]
public bool EnableHotTracking { get; set; }
Property Value
System.Boolean

ErrorRowHeaderImage

Gets or sets an image for the row header cell of the GridRowElement with error.

Declaration
public virtual Image ErrorRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

ExtendVerticalScrollBar

Gets or sets a value indicating whether the vertical scrollbar should be extended to encompass the upper right corner.

Declaration
[RadPropertyDefaultValue("ExtendVerticalScrollBar", typeof(GridTableElement))]
public bool ExtendVerticalScrollBar { get; set; }
Property Value
System.Boolean

FilterRowHeight

Gets or sets the height of the filter row used for column filtering operations. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("FilterRowHeight", typeof(GridTableElement))]
public virtual int FilterRowHeight { get; set; }
Property Value
System.Int32

GridViewElement

Gets the RadGridViewElement that owns this view.

Declaration
public RadGridViewElement GridViewElement { get; }
Property Value
RadGridViewElement

Implements

GroupHeaderHeight

Gets or sets the height of group header rows in the grid. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("GroupHeaderHeight", typeof(GridTableElement))]
public virtual int GroupHeaderHeight { get; set; }
Property Value
System.Int32

GroupIndent

Gets or sets the width of the GridViewIndentColumn.

Declaration
[RadPropertyDefaultValue("GroupIndent", typeof(GridTableElement))]
public int GroupIndent { get; set; }
Property Value
System.Int32

IsCurrentView

Gets a value indicating whether the view is current

Declaration
public bool IsCurrentView { get; }
Property Value
System.Boolean

Implements

IsUpdating

Gets a value indicating that the user interface is updating now.

Declaration
public bool IsUpdating { get; }
Property Value
System.Boolean

MasterTemplate

Gets the master template.

Declaration
public MasterGridViewTemplate MasterTemplate { get; }
Property Value
MasterGridViewTemplate

The master template.

MenuThemeName

Gets or sets a value indicating the name of the theme for the context menu in the current GridTableElement.

Declaration
[RadPropertyDefaultValue("MenuThemeName", typeof(GridTableElement))]
public string MenuThemeName { get; set; }
Property Value
System.String

NewRowHeaderImage

Gets or sets an image for the row header cell of the GridNewRowElement.

Declaration
public virtual Image NewRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

PageViewMode

Gets or sets the page view mode used in child views.The supported modes are: Strip, Stack, Outlook, EplorerBar.

Declaration
public PageViewMode PageViewMode { get; set; }
Property Value
PageViewMode

PageViewProvider

Gets or sets the PageViewProvider used in the child views.

Declaration
public IRadPageViewProvider PageViewProvider { get; set; }
Property Value
IRadPageViewProvider

RowDragHint

Gets or sets the RadImageShape instance which describes the hint that indicates where a row will be dropped after a drag operation.

Declaration
[VsbBrowsable(true)]
public RadImageShape RowDragHint { get; set; }
Property Value
RadImageShape

RowElementProvider

Gets or sets the row element provider.

Declaration
public IVirtualizedElementProvider<GridViewRowInfo> RowElementProvider { get; set; }
Property Value
IVirtualizedElementProvider<GridViewRowInfo>

The row element provider.

RowHeaderColumnWidth

Gets or sets the width of the GridViewRowHeaderColumn.

Declaration
[RadPropertyDefaultValue("RowHeaderColumnWidth", typeof(GridTableElement))]
public int RowHeaderColumnWidth { get; set; }
Property Value
System.Int32

RowHeight

Gets or sets the height of data rows in the grid table. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("RowHeight", typeof(GridTableElement))]
public virtual int RowHeight { get; set; }
Property Value
System.Int32

RowScroller

Gets the row scroller.

Declaration
public RowScroller RowScroller { get; }
Property Value
RowScroller

The row scroller.

RowSpacing

Gets or sets the vertical spacing between adjacent rows in the grid.

Declaration
[RadPropertyDefaultValue("RowSpacing", typeof(GridTableElement))]
public virtual int RowSpacing { get; set; }
Property Value
System.Int32

RowsPerPage

Gets the number of rows displayed to the user.

Declaration
public virtual int RowsPerPage { get; }
Property Value
System.Int32

Implements

ScrollBarThemeName

Gets or sets a value indicating the name of the theme for the context menu in the current GridTableElement.

Declaration
[RadPropertyDefaultValue("ScrollBarThemeName", typeof(GridTableElement))]
public string ScrollBarThemeName { get; set; }
Property Value
System.String

ScrollBehavior

Gets the ScrollServiceBehavior that is responsible for the kinetic scrolling option.

Declaration
public ScrollServiceBehavior ScrollBehavior { get; }
Property Value
ScrollServiceBehavior

SearchHighlightColor

Gets or sets the color that will be used for highlighting search matches in the grid.

Declaration
[RadPropertyDefaultValue("SearchHighlightColor", typeof(GridTableElement))]
public virtual Color SearchHighlightColor { get; set; }
Property Value
System.Drawing.Color

SearchRowHeaderImage

Gets or sets an image for the row header cell of the GridSearchRowElement.

Declaration
public virtual Image SearchRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

SearchRowHeight

Gets or sets the height of the search row used for searching within the grid data. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("SearchRowHeight", typeof(GridTableElement))]
public virtual int SearchRowHeight { get; set; }
Property Value
System.Int32

SelectColumnWidth

Gets or sets the width of the GridViewSelectColumn.

Declaration
[RadPropertyDefaultValue("SelectColumnWidth", typeof(GridTableElement))]
public int SelectColumnWidth { get; set; }
Property Value
System.Int32

ShowSelfReferenceLines

Gets or sets a value indicating whether to show lines in self reference mode.

Declaration
public bool ShowSelfReferenceLines { get; set; }
Property Value
System.Boolean

SkipVisibilityCheck

Get or set a value indicating whether to skip the control visibility check when ensuring cell/row visibility. If you set it to true, the control will scroll to row/cell even when not visible, when ScrollTo or similar functionality is used.

Declaration
public bool SkipVisibilityCheck { get; set; }
Property Value
System.Boolean

TableHeaderHeight

Gets or sets the height of the column headers row. The value is automatically scaled according to the current DPI settings.

Declaration
[RadPropertyDefaultValue("TableHeaderHeight", typeof(GridTableElement))]
public virtual int TableHeaderHeight { get; set; }
Property Value
System.Int32

TreeLevelIndent

Gets or sets the value that determines the indent width among expander primitives in self-reference hierarchy.

Declaration
[RadPropertyDefaultValue("TreeLevelIndent", typeof(GridTableElement))]
public int TreeLevelIndent { get; set; }
Property Value
System.Int32

ViewInfo

Gets the GridViewInfo that this view represents.

Declaration
public GridViewInfo ViewInfo { get; }
Property Value
GridViewInfo

Implements

ViewTemplate

Gets the view template.

Declaration
public GridViewTemplate ViewTemplate { get; }
Property Value
GridViewTemplate

The view template.

VisualRows

Gets a RadElementCollection containing the rows currently visible on screen.

Declaration
public virtual IList<GridRowElement> VisualRows { get; }
Property Value
System.Collections.Generic.IList<GridRowElement>

Implements

Methods

ArrangeVScrollBar(ref RectangleF, RectangleF, RectangleF)

Arranges the vertical scroll bar.

Declaration
protected override void ArrangeVScrollBar(ref RectangleF viewElementRect, RectangleF hscrollBarRect, RectangleF clientRect)
Parameters
System.Drawing.RectangleF viewElementRect

The view element rect.
System.Drawing.RectangleF hscrollBarRect

The hscroll bar rect.
System.Drawing.RectangleF clientRect

The client rect.
Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.RowsContainerElement>.ArrangeVScrollBar(System.Drawing.RectangleF, System.Drawing.RectangleF, System.Drawing.RectangleF)

BeginUpdate()

Begins batch update of the items.

Declaration
public bool BeginUpdate()
Returns
System.Boolean

Implements

BestFitColumn(GridViewColumn)

Widens / shrinks a column based on the space required by the text in the columns.

Declaration
public void BestFitColumn(GridViewColumn column)
Parameters
GridViewColumn column

The column.

BestFitColumns()

Automatically adjusts the width of all columns based on the content of their cells to ensure optimal fit.

Declaration
public void BestFitColumns()

BestFitColumns(BestFitColumnMode)

Automatically adjusts the width of all columns based on the content of their cells using the specified mode.

Declaration
public void BestFitColumns(BestFitColumnMode mode)
Parameters
BestFitColumnMode mode

The BestFitColumnMode that determines which cells to consider for the calculation.

CreateChildElements()

Creates and initializes the child elements of the grid table. Sets up the row and column scrollers with their respective element providers.

Declaration
protected override void CreateChildElements()
Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.RowsContainerElement>.CreateChildElements()

Detach()

Detaches the view from its owner.

Declaration
public virtual void Detach()
Implements

DisplayedColumnCount(Boolean)

Returns the number of columns displayed to the user.

Declaration
public virtual int DisplayedColumnCount(bool includePartialColumn)
Parameters
System.Boolean includePartialColumn

true to include partial columns in the displayed column count; otherwise, false.
Returns
System.Int32

The number of columns displayed to the user.
Implements

DisplayedRowCount(Boolean)

Returns the number of rows displayed to the user.

Declaration
public virtual int DisplayedRowCount(bool includePartialRow)
Parameters
System.Boolean includePartialRow

true to include partial rows in the displayed row count; otherwise, false.
Returns
System.Int32

The number of rows displayed to the user.
Implements

DisposeManagedResources()

Releases all managed resources used by this element, including event handlers, scrollers and internal components.

Declaration
protected override void DisposeManagedResources()
Overrides

DpiScaleChanged(SizeF)

Fires when the DPI scale is changed.

Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
System.Drawing.SizeF scaleFactor

The scale factor.
Overrides

EndUpdate()

Ends batch update of the items.

Declaration
public bool EndUpdate()
Returns
System.Boolean

Implements

EndUpdate(Boolean)

Ends batch update of the items.

Declaration
public bool EndUpdate(bool performUpdate)
Parameters
System.Boolean performUpdate

Tells the view whether an update is required or not.
Returns
System.Boolean

Implements

EnsureCellVisible(GridViewRowInfo, GridViewColumn)

Ensures that the specified cell is visible.

Declaration
public virtual bool EnsureCellVisible(GridViewRowInfo rowInfo, GridViewColumn column)
Parameters
GridViewRowInfo rowInfo

A GridViewRowInfo that specifies the cell's row
GridViewColumn column

A GridViewColumn that specifies the cell's column
Returns
System.Boolean

Implements

EnsureRowVisible(GridViewRowInfo)

Ensures that the specified row is visible.

Declaration
public virtual bool EnsureRowVisible(GridViewRowInfo rowInfo)
Parameters
GridViewRowInfo rowInfo

A GridViewRowInfo that specifies the row
Returns
System.Boolean

Implements

GetCellElement(GridViewRowInfo, GridViewColumn)

Gets a cell based on corresponding GridViewRowInfo and GridViewColumn

Declaration
public virtual GridCellElement GetCellElement(GridViewRowInfo rowInfo, GridViewColumn column)
Parameters
GridViewRowInfo rowInfo

The corresponding GridViewRowInfo
GridViewColumn column

The corresponding GridViewColumn
Returns
GridCellElement

An instance to a GridCellElement if successful, null otherwise
Implements

GetRowElement(GridViewRowInfo)

Gets the row's visual element based on the corresponding GridViewRowInfo

Declaration
public virtual GridRowElement GetRowElement(GridViewRowInfo rowInfo)
Parameters
GridViewRowInfo rowInfo

The corresponding GridViewRowInfo

Returns
GridRowElement

An instance to a GridRowElement if successful, null otherwise
Implements

Initialize(RadGridViewElement, GridViewInfo)

Initializes the view with an instance of the GridViewTemplate.

Declaration
public virtual void Initialize(RadGridViewElement gridRootElement, GridViewInfo viewInfo)
Parameters
RadGridViewElement gridRootElement

GridViewInfo viewInfo

An instance of GridViewTemplate.
Implements

InitializeFields()

Initializes member fields to their default values. This method is called prior the CreateChildItems one and allows for initialization of members on which child elements depend.

Declaration
protected override void InitializeFields()
Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.RowsContainerElement>.InitializeFields()

InvalidateCell(GridViewRowInfo, GridViewColumn)

Invalidates a single cell

Declaration
public virtual void InvalidateCell(GridViewRowInfo rowInfo, GridViewColumn column)
Parameters
GridViewRowInfo rowInfo

The corresponding GridViewRowInfo
GridViewColumn column

The corresponding GridViewColumn
Implements

InvalidateRow(GridViewRowInfo)

Invalidates a row

Declaration
public virtual void InvalidateRow(GridViewRowInfo rowInfo)
Parameters
GridViewRowInfo rowInfo

The GridViewRowInfo to invalidate
Implements

IsRowVisible(GridViewRowInfo)

Gets a value indicating whether the row is visible

Declaration
public virtual bool IsRowVisible(GridViewRowInfo value)
Parameters
GridViewRowInfo value

The GridViewRowInfo to check for visibility
Returns
System.Boolean

Returns true if the row is visible
Implements

MeasureOverride(SizeF)

Measures the size required by the grid table element and its children within the specified available size.

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

The available size that the element can use for layout.
Returns
System.Drawing.SizeF

The size that the element requires for layout.
Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.RowsContainerElement>.MeasureOverride(System.Drawing.SizeF)

OnLoaded()

Called when the grid table element and all its children have been successfully loaded into the element tree. Sets up event handlers and initializes template-related functionality.

Declaration
protected override void OnLoaded()
Overrides

OnPanGesture(PanGestureEventArgs)

Handles pan gestures for touch-enabled interfaces, allowing scrolling and navigation within the grid.

Declaration
protected override void OnPanGesture(PanGestureEventArgs args)
Parameters
PanGestureEventArgs args

The arguments containing information about the pan gesture event.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

ProcessBatchPropertyChanged(Type, PropertyChangedEventArgs)

Declaration
protected virtual GridViewEventResult ProcessBatchPropertyChanged(Type originatorType, PropertyChangedEventArgs propertyChanged)
Parameters
System.Type originatorType

System.ComponentModel.PropertyChangedEventArgs propertyChanged

Returns
GridViewEventResult

ProcessColumnEvent(GridViewColumn, GridViewEvent)

Processes the column event.

Declaration
protected virtual GridViewEventResult ProcessColumnEvent(GridViewColumn column, GridViewEvent eventData)
Parameters
GridViewColumn column

The column.
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

ProcessDragDrop(Point, ISupportDrag)

Processes drag-drop operations performed over this grid table element. Handles dropping of columns and other draggable items onto the grid.

Declaration
protected override void ProcessDragDrop(Point dropLocation, ISupportDrag dragObject)
Parameters
System.Drawing.Point dropLocation

The point where the dragged object was dropped.
ISupportDrag dragObject

The object being dragged.
Overrides

ProcessDragOver(Point, ISupportDrag)

Determines whether the grid table element can accept the dragged object at the current mouse location.

Declaration
protected override bool ProcessDragOver(Point currentMouseLocation, ISupportDrag dragObject)
Parameters
System.Drawing.Point currentMouseLocation

The current position of the mouse during dragging.
ISupportDrag dragObject

The object being dragged.
Returns
System.Boolean

True if the dragged object can be dropped at the current location; otherwise, false.
Overrides

ProcessFilterDescriptorCollectionEvent(GridViewFilterDescriptorCollection, GridViewEvent)

Processes the filter descriptor collection event.

Declaration
protected virtual GridViewEventResult ProcessFilterDescriptorCollectionEvent(GridViewFilterDescriptorCollection filters, GridViewEvent eventData)
Parameters
GridViewFilterDescriptorCollection filters

The filters.
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

ProcessMasterTemplateEvent(GridViewEvent)

Processes the master template event.

Declaration
protected virtual GridViewEventResult ProcessMasterTemplateEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

ProcessRowEvent(GridViewRowInfo, GridViewEvent)

Processes the row event.

Declaration
protected virtual GridViewEventResult ProcessRowEvent(GridViewRowInfo row, GridViewEvent eventData)
Parameters
GridViewRowInfo row

The row.
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

ProcessTemplateEvent(GridViewEvent)

Processes the template event.

Declaration
protected virtual GridViewEventResult ProcessTemplateEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

ProcessViewInfoEvent(GridViewEvent)

Processes the view info event.

Declaration
protected virtual GridViewEventResult ProcessViewInfoEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

The event data.
Returns
GridViewEventResult

RemoveStylePropertySetting(IPropertySetting)

Called when element style condition changes. This method is used internally.

Declaration
public override void RemoveStylePropertySetting(IPropertySetting setting)
Parameters
IPropertySetting setting

Overrides

ScrollTo(Int32, Int32)

Scrolls to the specific cell.

Declaration
public virtual void ScrollTo(int row, int column)
Parameters
System.Int32 row

The row.
System.Int32 column

The column.

ScrollToColumn(Int32)

Scrolls to column.

Declaration
public virtual void ScrollToColumn(int columnIndex)
Parameters
System.Int32 columnIndex

Index of the column.

ScrollToRow(Int32)

Scrolls to row.

Declaration
public virtual void ScrollToRow(int row)
Parameters
System.Int32 row

The row.

ScrollToRow(GridViewRowInfo)

Scrolls to row.

Declaration
public virtual void ScrollToRow(GridViewRowInfo rowInfo)
Parameters
GridViewRowInfo rowInfo

The row info.

UnWireEvents()

Unsubscribes from events that were wired in the WireEvents() method to prevent memory leaks.

Declaration
protected void UnWireEvents()

Update(GridUINotifyAction, GridViewRowInfo[])

Updates with the specified action.

Declaration
public void Update(GridUINotifyAction action, params GridViewRowInfo[] rowInfos)
Parameters
GridUINotifyAction action

The action.
GridViewRowInfo[] rowInfos

The row infos.

UpdateColumnsDpiScaleFactor()

Updates the columns DPI scale factor.

Declaration
protected virtual void UpdateColumnsDpiScaleFactor()

UpdateReferences(ComponentThemableElementTree, Boolean, Boolean)

Declaration
protected override void UpdateReferences(ComponentThemableElementTree tree, bool updateInheritance, bool recursive)
Parameters
ComponentThemableElementTree tree

System.Boolean updateInheritance

System.Boolean recursive

Overrides

UpdateView()

Explicitly synchonizes the view with its owner.

Declaration
public virtual void UpdateView()
Implements

WireEvents()

Subscribes to necessary events for proper grid table operation including scrollbar, tooltip, and theme change events.

Declaration
protected void WireEvents()

Explicit Interface Implementations

IGridViewEventListener.AnalyzeQueue(List<GridViewEvent>)

Declaration
bool IGridViewEventListener.AnalyzeQueue(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

Returns
System.Boolean

Implements

IGridViewEventListener.DesiredEvents

Declaration
GridEventType IGridViewEventListener.DesiredEvents { get; }
Returns
GridEventType

Implements

IGridViewEventListener.DesiredProcessMode

Declaration
GridEventProcessMode IGridViewEventListener.DesiredProcessMode { get; }
Returns
GridEventProcessMode

Implements

IGridViewEventListener.PostProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.PostProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

IGridViewEventListener.PreProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.PreProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

IGridViewEventListener.Priority

Declaration
EventListenerPriority IGridViewEventListener.Priority { get; }
Returns
EventListenerPriority

Implements

IGridViewEventListener.ProcessEvent(GridViewEvent)

Declaration
GridViewEventResult IGridViewEventListener.ProcessEvent(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Implements

Extension Methods