ClassVirtualGridTableElement
Represents the table element of RadVirtualGrid.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class VirtualGridTableElement : ScrollViewElement<VirtualRowsContainerElement>, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider
Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemUIItemBaseLightVisualElementScrollViewElement<VirtualRowsContainerElement>VirtualGridTableElement
Implements:
Inherited Members
Constructors
VirtualGridTableElement(RadVirtualGridElement, VirtualGridViewInfo)
Initializes a new instance of the VirtualGridTableElement class.
Declaration
public VirtualGridTableElement(RadVirtualGridElement gridElement, VirtualGridViewInfo viewInfo)
Parameters
gridElement
The grid element.
viewInfo
The view info.
Fields
AlternatingRowColorProperty
Declaration
public static RadProperty AlternatingRowColorProperty
Field Value
CurrentRowHeaderImageProperty
Declaration
public static RadProperty CurrentRowHeaderImageProperty
Field Value
EditRowHeaderImageProperty
Declaration
public static RadProperty EditRowHeaderImageProperty
Field Value
EnableHotTrackingProperty
Declaration
public static RadProperty EnableHotTrackingProperty
Field Value
FilterRowHeightProperty
Declaration
public static RadProperty FilterRowHeightProperty
Field Value
HeaderRowHeightProperty
Declaration
public static RadProperty HeaderRowHeightProperty
Field Value
IndentColumnWidthProperty
Declaration
public static RadProperty IndentColumnWidthProperty
Field Value
NewRowHeightProperty
Declaration
public static RadProperty NewRowHeightProperty
Field Value
RowErrorImageProperty
Declaration
public static RadProperty RowErrorImageProperty
Field Value
RowWaitingImageProperty
Declaration
public static RadProperty RowWaitingImageProperty
Field Value
Properties
AlternatingRowColor
Gets or sets the color of the alternating row.
Declaration
[VsbBrowsable(true)]
public virtual Color AlternatingRowColor { get; set; }
Property Value
The color of the alternating row.
CellSpacing
Gets or sets the cell spacing.
Declaration
public int CellSpacing { get; set; }
Property Value
The cell spacing.
ColumnCount
Gets or sets the number of columns displayed in the table element.
ColumnLayout
Gets or sets the column layout.
Declaration
public BaseVirtualGridColumnLayout ColumnLayout { get; set; }
Property Value
The column layout.
ColumnScroller
Gets the column scroller.
Declaration
public VirtualGridItemScroller ColumnScroller { get; }
Property Value
The column scroller.
ColumnWidth
Gets or sets the default column width.
ColumnsViewState
Gets an VirtualGridTableViewState containing information and settings for the currently displayed columns.
Declaration
public VirtualGridTableViewState ColumnsViewState { get; }
Property Value
CurrentRowHeaderImage
Gets or sets an image for the indent cell of the current VirtualGridRowElement.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image CurrentRowHeaderImage { get; set; }
Property Value
EditRowHeaderImage
Gets or sets an image for the indent cell of a VirtualGridRowElement that is currently in edit mode.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image EditRowHeaderImage { get; set; }
Property Value
EnableHotTracking
Gets or sets a value indicating whether there is a visual indication for the row currently under the mouse.
Declaration
[VsbBrowsable(true)]
public bool EnableHotTracking { get; set; }
Property Value
FilterRowHeight
Gets or sets the height of the filtering row.
Declaration
[VsbBrowsable(true)]
public int FilterRowHeight { get; set; }
Property Value
GridElement
Gets the grid element.
Declaration
public RadVirtualGridElement GridElement { get; }
Property Value
The grid element.
HeaderRowHeight
Gets or sets the height of the header row.
Declaration
[VsbBrowsable(true)]
public int HeaderRowHeight { get; set; }
Property Value
IndentColumnWidth
Gets or sets the width of the indent column.
Declaration
[VsbBrowsable(true)]
public int IndentColumnWidth { get; set; }
Property Value
NewRowHeight
Gets or sets the height of the add new row.
Declaration
[VsbBrowsable(true)]
public int NewRowHeight { get; set; }
Property Value
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
RowCount
Gets or sets the number of rows displayed in the table element.
RowErrorImage
Gets or sets an image for the indent cell of a VirtualGridRowElement containing a data error.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image RowErrorImage { get; set; }
Property Value
RowHeight
Gets or sets the default height of data rows.
Declaration
[VsbBrowsable(true)]
public int RowHeight { get; set; }
Property Value
RowScroller
Gets the row scroller.
Declaration
public VirtualGridItemScroller RowScroller { get; }
Property Value
The row scroller.
RowSpacing
Gets or sets the
RowWaitingImage
Gets or sets an image for the indent cell of a VirtualGridRowElement that is indicating the row is busy.
Declaration
[TypeConverter(typeof(ImageTypeConverter))]
public Image RowWaitingImage { get; set; }
Property Value
RowsViewState
Gets an VirtualGridTableViewState containing information and settings for the currently displayed rows.
Declaration
public VirtualGridTableViewState RowsViewState { get; }
Property Value
ViewInfo
Gets or sets the view info containing the settings for this table element.
Declaration
public VirtualGridViewInfo ViewInfo { get; set; }
Property Value
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
Methods
ArrangeOverride(SizeF)
Arranges the elements in the available size.
CollapseRow(int)
Collapses the specified row.
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()
Overrides
DpiScaleChanged(SizeF)
Triggered when the scale is changed.
Declaration
public override void DpiScaleChanged(SizeF scaleFactor)
Parameters
scaleFactor
The scale factor.
Overrides
ExpandRow(int)
Expands the specified row.
GetChildViewInfo(int)
Gets the child view info.
Declaration
public VirtualGridViewInfo GetChildViewInfo(int rowIndex)
Parameters
rowIndex
Index of the row.
Returns
GetColumnWidth(int)
Gets the height of the column at the given column index.
GetRowHeight(int)
Gets the height of the row at the given row index.
IsColumnPinned(int)
Determines whether the column at the specified index is pinned.
IsRowExpanded(int)
Returs a value indicating whether the specified row is expanded.
IsRowPinned(int)
Determines whether the row at the specified index is pinned.
MeasureOverride(SizeF)
Measures the elements with the available size.
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)
Handles property change events by invalidating the fill cache and invoking the base class property change handler.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
e
Event arguments containing information about the property that changed.
Overrides
OnViewInfoPropertyChanged(object, PropertyChangedEventArgs)
Called when the view info property is changed.
Declaration
protected virtual void OnViewInfoPropertyChanged(object sender, PropertyChangedEventArgs e)
Parameters
sender
The sender.
e
The PropertyChangedEventArgs instance containing the event data.
ScrollTo(int)
Scrolls with the specified delta.
ScrollTo(int, RadScrollBarElement)
Scrolls with the specified delta.
Declaration
public void ScrollTo(int delta, RadScrollBarElement scrollBar)
Parameters
delta
The delta.
scrollBar
The scroll bar.
SetColumnPinPosition(int, PinnedColumnPosition)
Sets the pin position of the specified column.
Declaration
public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)
Parameters
columnIndex
The index of the column.
pinPosition
The new pin position.
SetColumnWidth(int, int)
Sets the width of the column.
SetColumnWidth(int, params int[])
Sets the width of the columns at the specified column indices in the master view info.
SetRowHeight(int, int)
Sets the height of the row at the specified row index in the current view info.
SetRowHeight(int, params int[])
Sets the height of the rows at the specified row indices in the master view info.
SetRowPinPosition(int, PinnedRowPosition)
Sets the pin position of the specified row.
Declaration
public void SetRowPinPosition(int rowIndex, PinnedRowPosition pinPosition)
Parameters
rowIndex
The index of the row.
pinPosition
The new pin position.
SynchronizeRow(int, bool)
Synchronizes the row.
SynchronizeRows(bool)
Synchronizes the rows.
Declaration
public void SynchronizeRows(bool recursive)
Parameters
recursive
Indicates if it is recursive.
SynchronizeRows(bool, bool)
Synchronizes the rows.
UpdateNoDataText()
Updates the no data text.
Declaration
protected void UpdateNoDataText()
UpdateOnMeasure(SizeF)
Updates the table element after measure process.
UpdateOnViewInfoChanged()
Triggers when the view info is changed.
Declaration
protected virtual void UpdateOnViewInfoChanged()