Class VirtualGridTableElement

Represents the table element of RadVirtualGrid.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
ScrollViewElement<VirtualRowsContainerElement>
VirtualGridTableElement
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 VirtualGridTableElement : ScrollViewElement<VirtualRowsContainerElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

VirtualGridTableElement(RadVirtualGridElement, VirtualGridViewInfo)

Initializes a new instance of the VirtualGridTableElement class.

Declaration
public VirtualGridTableElement(RadVirtualGridElement gridElement, VirtualGridViewInfo viewInfo)
Parameters
RadVirtualGridElement gridElement

The grid element.
VirtualGridViewInfo viewInfo

The view info.

Fields

AlternatingRowColorProperty

Declaration
public static RadProperty AlternatingRowColorProperty
Field Value
RadProperty

CurrentRowHeaderImageProperty

Declaration
public static RadProperty CurrentRowHeaderImageProperty
Field Value
RadProperty

EditRowHeaderImageProperty

Declaration
public static RadProperty EditRowHeaderImageProperty
Field Value
RadProperty

EnableHotTrackingProperty

Declaration
public static RadProperty EnableHotTrackingProperty
Field Value
RadProperty

FilterRowHeightProperty

Declaration
public static RadProperty FilterRowHeightProperty
Field Value
RadProperty

HeaderRowHeightProperty

Declaration
public static RadProperty HeaderRowHeightProperty
Field Value
RadProperty

IndentColumnWidthProperty

Declaration
public static RadProperty IndentColumnWidthProperty
Field Value
RadProperty

NewRowHeightProperty

Declaration
public static RadProperty NewRowHeightProperty
Field Value
RadProperty

RowErrorImageProperty

Declaration
public static RadProperty RowErrorImageProperty
Field Value
RadProperty

RowHeightProperty

Declaration
public static RadProperty RowHeightProperty
Field Value
RadProperty

RowWaitingImageProperty

Declaration
public static RadProperty RowWaitingImageProperty
Field Value
RadProperty

Properties

AlternatingRowColor

Gets or sets the color of the alternating row.

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

The color of the alternating row.

CellSpacing

Gets or sets the cell spacing.

Declaration
public int CellSpacing { get; set; }
Property Value
System.Int32

The cell spacing.

ColumnCount

Gets or sets the number of columns displayed in the table element.

Declaration
public int ColumnCount { get; set; }
Property Value
System.Int32

ColumnLayout

Gets or sets the column layout.

Declaration
public BaseVirtualGridColumnLayout ColumnLayout { get; set; }
Property Value
BaseVirtualGridColumnLayout

The column layout.

ColumnScroller

Gets the column scroller.

Declaration
public VirtualGridItemScroller ColumnScroller { get; }
Property Value
VirtualGridItemScroller

The column scroller.

ColumnsViewState

Gets an VirtualGridTableViewState containing information and settings for the currently displayed columns.

Declaration
public VirtualGridTableViewState ColumnsViewState { get; }
Property Value
VirtualGridTableViewState

ColumnWidth

Gets or sets the default column width.

Declaration
public int ColumnWidth { get; set; }
Property Value
System.Int32

CurrentRowHeaderImage

Gets or sets an image for the indent cell of the current VirtualGridRowElement.

Declaration
[RadPropertyDefaultValue("CurrentRowHeaderImage", typeof(VirtualGridTableElement))]
public virtual Image CurrentRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

EditRowHeaderImage

Gets or sets an image for the indent cell of a VirtualGridRowElement that is currently in edit mode.

Declaration
[RadPropertyDefaultValue("EditRowHeaderImage", typeof(VirtualGridTableElement))]
public virtual Image EditRowHeaderImage { get; set; }
Property Value
System.Drawing.Image

EnableHotTracking

Gets or sets a value indicating whether there is a visual indication for the row currently under the mouse.

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

FilterRowHeight

Gets or sets the height of the filtering row.

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

GridElement

Gets the grid element.

Declaration
public RadVirtualGridElement GridElement { get; }
Property Value
RadVirtualGridElement

The grid element.

HeaderRowHeight

Gets or sets the height of the header row.

Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("HeaderRowHeight", typeof(VirtualGridTableElement))]
public int HeaderRowHeight { get; set; }
Property Value
System.Int32

IndentColumnWidth

Gets or sets the width of the indent column.

Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("IndentColumnWidth", typeof(VirtualGridTableElement))]
public int IndentColumnWidth { get; set; }
Property Value
System.Int32

NewRowHeight

Gets or sets the height of the add new row.

Declaration
[VsbBrowsable(true)]
[RadPropertyDefaultValue("NewRowHeight", typeof(VirtualGridTableElement))]
public int NewRowHeight { get; set; }
Property Value
System.Int32

PagingPanelElement

Gets an instance of VirtualGridPagingPanelElement which allows the user to navigate between pages when paging is enabled.

Declaration
public VirtualGridPagingPanelElement PagingPanelElement { get; }
Property Value
VirtualGridPagingPanelElement

RowCount

Gets or sets the number of rows displayed in the table element.

Declaration
public int RowCount { get; set; }
Property Value
System.Int32

RowErrorImage

Gets or sets an image for the indent cell of a VirtualGridRowElement containing a data error.

Declaration
[RadPropertyDefaultValue("RowErrorImage", typeof(VirtualGridTableElement))]
public Image RowErrorImage { get; set; }
Property Value
System.Drawing.Image

RowHeight

Gets or sets the default height of data rows.

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

RowScroller

Gets the row scroller.

Declaration
public VirtualGridItemScroller RowScroller { get; }
Property Value
VirtualGridItemScroller

The row scroller.

RowSpacing

Gets or sets the

Declaration
public int RowSpacing { get; set; }
Property Value
System.Int32

RowsViewState

Gets an VirtualGridTableViewState containing information and settings for the currently displayed rows.

Declaration
public VirtualGridTableViewState RowsViewState { get; }
Property Value
VirtualGridTableViewState

RowWaitingImage

Gets or sets an image for the indent cell of a VirtualGridRowElement that is indicating the row is busy.

Declaration
[RadPropertyDefaultValue("RowWaitingImage", typeof(VirtualGridTableElement))]
public Image RowWaitingImage { get; set; }
Property Value
System.Drawing.Image

ViewInfo

Gets or sets the view info containing the settings for this table element.

Declaration
public VirtualGridViewInfo ViewInfo { get; set; }
Property Value
VirtualGridViewInfo

WaitingElement

Gets an instance of VirtualGridWaitingElement which can be used as a busy indicator for this table element.

Declaration
public VirtualGridWaitingElement WaitingElement { get; }
Property Value
VirtualGridWaitingElement

Methods

ArrangeOverride(SizeF)

Arranges the elements in the available size.

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

The final size.
Returns
System.Drawing.SizeF

Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.VirtualRowsContainerElement>.ArrangeOverride(System.Drawing.SizeF)

BeginUpdate()

Suspends layout updates.

Declaration
public void BeginUpdate()

CollapseRow(Int32)

Collapses the specified row.

Declaration
public bool CollapseRow(int rowIndex)
Parameters
System.Int32 rowIndex

The row index to collapse.
Returns
System.Boolean

True if the operation is successful, otherwise false.

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

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

DpiScaleChanged(SizeF)

Triggered when the scale is changed.

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

The scale factor.
Overrides

EndUpdate()

Resumes layout updates.

Declaration
public void EndUpdate()

ExpandRow(Int32)

Expands the specified row.

Declaration
public bool ExpandRow(int rowIndex)
Parameters
System.Int32 rowIndex

The row index to expand.
Returns
System.Boolean

True if the operation is successful, otherwise false.

GetChildViewInfo(Int32)

Gets the child view info.

Declaration
public VirtualGridViewInfo GetChildViewInfo(int rowIndex)
Parameters
System.Int32 rowIndex

Index of the row.
Returns
VirtualGridViewInfo

GetColumnWidth(Int32)

Gets the height of the column at the given column index.

Declaration
public int GetColumnWidth(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Int32

The height of the column.

GetRowHeight(Int32)

Gets the height of the row at the given row index.

Declaration
public int GetRowHeight(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Int32

The height of the row.

IsColumnPinned(Int32)

Determines whether the column at the specified index is pinned.

Declaration
public bool IsColumnPinned(int columnIndex)
Parameters
System.Int32 columnIndex

The index of the column.
Returns
System.Boolean

True if the column is pinned, otherwise false.

IsRowExpanded(Int32)

Returs a value indicating whether the specified row is expanded.

Declaration
public bool IsRowExpanded(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row is expanded, otherwise false.

IsRowPinned(Int32)

Determines whether the row at the specified index is pinned.

Declaration
public bool IsRowPinned(int rowIndex)
Parameters
System.Int32 rowIndex

The index of the row.
Returns
System.Boolean

True if the row is pinned, otherwise false.

MeasureOverride(SizeF)

Measures the elements with the available size.

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

The available size.
Returns
System.Drawing.SizeF

Overrides
Telerik.WinControls.UI.ScrollViewElement<Telerik.WinControls.UI.VirtualRowsContainerElement>.MeasureOverride(System.Drawing.SizeF)

OnLoaded()

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration
protected override void OnLoaded()
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

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

Overrides

OnViewInfoPropertyChanged(Object, PropertyChangedEventArgs)

Called when the view info property is changed.

Declaration
protected virtual void OnViewInfoPropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
System.Object sender

The sender.
System.ComponentModel.PropertyChangedEventArgs e

The System.ComponentModel.PropertyChangedEventArgs instance containing the event data.

ScrollTo(Int32)

Scrolls with the specified delta.

Declaration
public void ScrollTo(int delta)
Parameters
System.Int32 delta

The delta.

ScrollTo(Int32, RadScrollBarElement)

Scrolls with the specified delta.

Declaration
public void ScrollTo(int delta, RadScrollBarElement scrollBar)
Parameters
System.Int32 delta

The delta.
RadScrollBarElement scrollBar

The scroll bar.

SetColumnPinPosition(Int32, PinnedColumnPosition)

Sets the pin position of the specified column.

Declaration
public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)
Parameters
System.Int32 columnIndex

The index of the column.
PinnedColumnPosition pinPosition

The new pin position.

SetColumnWidth(Int32, Int32)

Sets the width of the column.

Declaration
public void SetColumnWidth(int columnIndex, int width)
Parameters
System.Int32 columnIndex

Index of the column.
System.Int32 width

The width.

SetColumnWidth(Int32, Int32[])

Sets the width of the columns at the specified column indices in the master view info.

Declaration
public void SetColumnWidth(int width, params int[] columnIndices)
Parameters
System.Int32 width

The new width of the columns.
System.Int32[] columnIndices

The indices of the columns.

SetRowHeight(Int32, Int32)

Sets the height of the row at the specified row index in the current view info.

Declaration
public void SetRowHeight(int rowIndex, int height)
Parameters
System.Int32 rowIndex

The index of the row.
System.Int32 height

The new height of the row.

SetRowHeight(Int32, Int32[])

Sets the height of the rows at the specified row indices in the master view info.

Declaration
public void SetRowHeight(int height, params int[] rowIndices)
Parameters
System.Int32 height

The new height of the rows.
System.Int32[] rowIndices

The indices of the rows.

SetRowPinPosition(Int32, PinnedRowPosition)

Sets the pin position of the specified row.

Declaration
public void SetRowPinPosition(int rowIndex, PinnedRowPosition pinPosition)
Parameters
System.Int32 rowIndex

The index of the row.
PinnedRowPosition pinPosition

The new pin position.

SynchronizeRow(Int32, Boolean)

Synchronizes the row.

Declaration
public void SynchronizeRow(int rowIndex, bool updateContent)
Parameters
System.Int32 rowIndex

Index of the row.
System.Boolean updateContent

Content of the update.

SynchronizeRows()

Synchronizes the rows.

Declaration
public void SynchronizeRows()

SynchronizeRows(Boolean)

Synchronizes the rows.

Declaration
public void SynchronizeRows(bool recursive)
Parameters
System.Boolean recursive

Indicates if it is recursive.

SynchronizeRows(Boolean, Boolean)

Synchronizes the rows.

Declaration
public void SynchronizeRows(bool recursive, bool updateContent)
Parameters
System.Boolean recursive

The recursive.
System.Boolean updateContent

Content of the update.

UpdateNoDataText()

Updates the no data text.

Declaration
protected void UpdateNoDataText()

UpdateOnMeasure(SizeF)

Updates the table element after measure process.

Declaration
protected virtual bool UpdateOnMeasure(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Size of the available.
Returns
System.Boolean

UpdateOnViewInfoChanged()

Triggers when the view info is changed.

Declaration
protected virtual void UpdateOnViewInfoChanged()

Extension Methods