Class

GridTableElement

Initializes a new instance of the GridTableElement class.

Declaration

public GridTableElement()

Identifies the AlternatingRowColor dependency property.

Declaration

public static RadProperty AlternatingRowColorProperty

Field Value

Identifies the CellSpacing dependency property.

Declaration

public static RadProperty CellSpacingProperty

Field Value

Identifies the ChildRowHeight dependency property.

Declaration

public static RadProperty ChildRowHeightProperty

Field Value

Identifies the ColumnDragHint dependency property.

Declaration

public static RadProperty ColumnDragHintProperty

Field Value

Identifies the CurrentRowHeaderImage dependency property.

Declaration

public static RadProperty CurrentRowHeaderImageProperty

Field Value

Identifies the EditRowHeaderImage dependency property.

Declaration

public static RadProperty EditRowHeaderImageProperty

Field Value

Identifies the EnableHotTracking dependency property.

Declaration

public static RadProperty EnableHotTrackingProperty

Field Value

Identifies the ErrorRowHeaderImage dependency property.

Declaration

public static RadProperty ErrorRowHeaderImageProperty

Field Value

Identifies the ExtendVerticalScrollBar dependency property.

Declaration

public static RadProperty ExtendVerticalScrollBarProperty

Field Value

Identifies the FilterRowHeight dependency property.

Declaration

public static RadProperty FilterRowHeightProperty

Field Value

Identifies the GroupHeaderHeight dependency property.

Declaration

public static RadProperty GroupHeaderHeightProperty

Field Value

Identifies the GroupIndent dependency property.

Declaration

public static RadProperty GroupIndentProperty

Field Value

Identifies the HasColumnHeaders dependency property.

Declaration

public static RadProperty HasColumnHeadersProperty

Field Value

Identifies the MenuThemeName dependency property.

Declaration

public static RadProperty MenuThemeNameProperty

Field Value

Identifies the NewRowHeaderImage dependency property.

Declaration

public static RadProperty NewRowHeaderImageProperty

Field Value

Identifies the RowDragHint dependency property.

Declaration

public static RadProperty RowDragHintProperty

Field Value

Identifies the RowHeaderColumnWidth dependency property.

Declaration

public static RadProperty RowHeaderColumnWidthProperty

Field Value

Identifies the RowHeight dependency property.

Declaration

public static RadProperty RowHeightProperty

Field Value

Identifies the RowSpacing dependency property.

Declaration

public static RadProperty RowSpacingProperty

Field Value

Identifies the ScrollBarThemeName dependency property.

Declaration

public static RadProperty ScrollBarThemeNameProperty

Field Value

Identifies the SearchHighlightColor dependency property.

Declaration

public static RadProperty SearchHighlightColorProperty

Field Value

Identifies the SearchRowHeaderImage dependency property.

Declaration

public static RadProperty SearchRowHeaderImageProperty

Field Value

Identifies the SearchRowHeight dependency property.

Declaration

public static RadProperty SearchRowHeightProperty

Field Value

Identifies the SelectColumnWidth dependency property.

Declaration

public static RadProperty SelectColumnWidthProperty

Field Value

Identifies the ShowSelfReferenceLines dependency property.

Declaration

public static RadProperty ShowSelfReferenceLinesProperty

Field Value

Identifies the TableHeaderHeight dependency property.

Declaration

public static RadProperty TableHeaderHeightProperty

Field Value

Identifies the TreeLevelIndent dependency property.

Declaration

public static RadProperty TreeLevelIndentProperty

Field Value

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

Declaration

public virtual Color AlternatingRowColor { get; set; }

Property Value

Gets or sets the cell element provider.

Declaration

public IVirtualizedElementProvider<GridViewColumn> CellElementProvider { get; set; }

Property Value

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

Declaration

public virtual int CellSpacing { get; set; }

Property Value

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

public virtual int ChildRowHeight { get; set; }

Property Value

Gets a collection containing all visible child views

Declaration

public ReadOnlyCollection<IRowView> ChildViews { get; }

Property Value

Implements IRowView.ChildViews

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

Declaration

[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape ColumnDragHint { get; set; }

Property Value

Gets the column scroller.

Declaration

public ItemScroller<GridViewColumn> ColumnScroller { get; }

Property Value

Gets the current GridCellElement in the GridTableElement.

Declaration

public virtual GridCellElement CurrentCell { get; }

Property Value

Implements IRowView.CurrentCell

Gets the address of the current GridCellElement

Declaration

public virtual Point CurrentCellAddress { get; }

Property Value

Implements IRowView.CurrentCellAddress

Gets the current GridRowElement in the GridTableElement.

Declaration

public virtual GridRowElement CurrentRow { get; }

Property Value

Implements IRowView.CurrentRow

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

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image CurrentRowHeaderImage { get; set; }

Property Value

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

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image EditRowHeaderImage { get; set; }

Property Value

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

Declaration

public bool EnableHotTracking { get; set; }

Property Value

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

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image ErrorRowHeaderImage { get; set; }

Property Value

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

Declaration

public bool ExtendVerticalScrollBar { get; set; }

Property Value

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

public virtual int FilterRowHeight { get; set; }

Property Value

Gets the RadGridViewElement that owns this view.

Declaration

public RadGridViewElement GridViewElement { get; }

Property Value

Implements IGridView.GridViewElement

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

Declaration

public virtual int GroupHeaderHeight { get; set; }

Property Value

Gets or sets the width of the GridViewIndentColumn.

Declaration

public int GroupIndent { get; set; }

Property Value

Gets a value indicating whether the view is current

Declaration

public bool IsCurrentView { get; }

Property Value

Implements IRowView.IsCurrentView

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

Declaration

public bool IsUpdating { get; }

Property Value

Gets the master template.

Declaration

public MasterGridViewTemplate MasterTemplate { get; }

Property Value

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

Declaration

public string MenuThemeName { get; set; }

Property Value

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

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image NewRowHeaderImage { get; set; }

Property Value

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

Gets or sets the PageViewProvider used in the child views.

Declaration

public IRadPageViewProvider PageViewProvider { get; set; }

Property Value

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

Declaration

[Browsable(false)]
[VsbBrowsable(true)]
public RadImageShape RowDragHint { get; set; }

Property Value

Gets or sets the row element provider.

Declaration

public IVirtualizedElementProvider<GridViewRowInfo> RowElementProvider { get; set; }

Property Value

Gets or sets the width of the GridViewRowHeaderColumn.

Declaration

public int RowHeaderColumnWidth { get; set; }

Property Value

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

Declaration

public virtual int RowHeight { get; set; }

Property Value

Gets the row scroller.

Declaration

public RowScroller RowScroller { get; }

Property Value

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

Declaration

public virtual int RowSpacing { get; set; }

Property Value

Gets the number of rows displayed to the user.

Declaration

public virtual int RowsPerPage { get; }

Property Value

Implements IRowView.RowsPerPage

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

Declaration

public string ScrollBarThemeName { get; set; }

Property Value

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

Declaration

public ScrollServiceBehavior ScrollBehavior { get; }

Property Value

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

Declaration

public virtual Color SearchHighlightColor { get; set; }

Property Value

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

Declaration

[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image SearchRowHeaderImage { get; set; }

Property Value

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

public virtual int SearchRowHeight { get; set; }

Property Value

Gets or sets the width of the GridViewSelectColumn.

Declaration

public int SelectColumnWidth { get; set; }

Property Value

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

Declaration

public bool ShowSelfReferenceLines { get; set; }

Property Value

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

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

Declaration

public virtual int TableHeaderHeight { get; set; }

Property Value

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

Declaration

public int TreeLevelIndent { get; set; }

Property Value

Gets the GridViewInfo that this view represents.

Declaration

public GridViewInfo ViewInfo { get; }

Property Value

Implements IGridView.ViewInfo

Gets the view template.

Declaration

public GridViewTemplate ViewTemplate { get; }

Property Value

Gets a RadElementCollection containing the rows currently visible on screen.

Declaration

public virtual IList<GridRowElement> VisualRows { get; }

Property Value

Implements IRowView.VisualRows

Arranges the vertical scroll bar.

Declaration

protected override void ArrangeVScrollBar(ref RectangleF viewElementRect, RectangleF hscrollBarRect, RectangleF clientRect)

Parameters

Overrides ScrollViewElement<RowsContainerElement>.ArrangeVScrollBar(ref RectangleF, RectangleF, RectangleF)

Begins batch update of the items.

Declaration

public bool BeginUpdate()

Returns

Implements IRowView.BeginUpdate()

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

Declaration

public void BestFitColumn(GridViewColumn column)

Parameters

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

Declaration

public void BestFitColumns()

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

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 ScrollViewElement<RowsContainerElement>.CreateChildElements()

Detaches the view from its owner.

Declaration

public virtual void Detach()

Implements IGridView.Detach()

Returns the number of columns displayed to the user.

Declaration

public virtual int DisplayedColumnCount(bool includePartialColumn)

Parameters

Returns

Implements IRowView.DisplayedColumnCount(bool)

Returns the number of rows displayed to the user.

Declaration

public virtual int DisplayedRowCount(bool includePartialRow)

Parameters

Returns

Implements IRowView.DisplayedRowCount(bool)

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

Declaration

protected override void DisposeManagedResources()

Overrides LightVisualElement.DisposeManagedResources()

Fires when the DPI scale is changed.

Declaration

public override void DpiScaleChanged(SizeF scaleFactor)

Parameters

Overrides RadElement.DpiScaleChanged(SizeF)

Ends batch update of the items.

Declaration

public bool EndUpdate()

Returns

Implements IRowView.EndUpdate()

Ends batch update of the items.

Declaration

public bool EndUpdate(bool performUpdate)

Parameters

Returns

Implements IRowView.EndUpdate(bool)

Ensures that the specified cell is visible.

Declaration

public virtual bool EnsureCellVisible(GridViewRowInfo rowInfo, GridViewColumn column)

Parameters

Returns

Implements IRowView.EnsureCellVisible(GridViewRowInfo, GridViewColumn)

Ensures that the specified row is visible.

Declaration

public virtual bool EnsureRowVisible(GridViewRowInfo rowInfo)

Parameters

Returns

Implements IRowView.EnsureRowVisible(GridViewRowInfo)

Gets a cell based on corresponding GridViewRowInfo and GridViewColumn

Declaration

public virtual GridCellElement GetCellElement(GridViewRowInfo rowInfo, GridViewColumn column)

Parameters

Returns

Implements IRowView.GetCellElement(GridViewRowInfo, GridViewColumn)

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

Declaration

public virtual GridRowElement GetRowElement(GridViewRowInfo rowInfo)

Parameters

Returns

Implements IRowView.GetRowElement(GridViewRowInfo)

Initializes the view with an instance of the GridViewTemplate.

Declaration

public virtual void Initialize(RadGridViewElement gridRootElement, GridViewInfo viewInfo)

Parameters

Implements IGridView.Initialize(RadGridViewElement, GridViewInfo)

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 ScrollViewElement<RowsContainerElement>.InitializeFields()

Invalidates a single cell

Declaration

public virtual void InvalidateCell(GridViewRowInfo rowInfo, GridViewColumn column)

Parameters

Implements IRowView.InvalidateCell(GridViewRowInfo, GridViewColumn)

Invalidates a row

Declaration

public virtual void InvalidateRow(GridViewRowInfo rowInfo)

Parameters

Implements IRowView.InvalidateRow(GridViewRowInfo)

Gets a value indicating whether the row is visible

Declaration

public virtual bool IsRowVisible(GridViewRowInfo value)

Parameters

Returns

Implements IRowView.IsRowVisible(GridViewRowInfo)

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

Returns