VirtualGridViewInfo
Represents the view info.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class VirtualGridViewInfo : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor
Inheritance: objectDisposableObjectRadObjectVirtualGridViewInfo
Implements:
Inherited Members
Constructors
Initializes a new instance of the VirtualGridViewInfo class.
public VirtualGridViewInfo(RadVirtualGridElement gridElement)
The grid element.
Initializes a new instance of the VirtualGridViewInfo class.
public VirtualGridViewInfo(VirtualGridViewInfo parentViewInfo, int parentRowIndex)
The parent view info.
parentRowIndexintIndex of the parent row.
Fields
Gets the default column width.
public const int DefaultColumnWidth = 100
Gets the default height of the filter row.
public const int DefaultFilterRowHeight = 26
Gets the default height of the header row.
public const int DefaultHeaderRowHeight = 30
Gets the default height of the new row.
public const int DefaultNewRowHeight = 24
Gets the default height of data rows.
public const int DefaultRowHeight = 24
Gets the default spacing between virtualized items.
public const int DefaultSpacing = -1
Identifies the filter-row height setting bound to FilterRowHeightProperty.
public static RadProperty FilterRowHeightProperty
Identifies the header-row height setting bound to HeaderRowHeightProperty.
public static RadProperty HeaderRowHeightProperty
Identifies the new-row height setting bound to NewRowHeightProperty.
public static RadProperty NewRowHeightProperty
Identifies the data-row height setting bound to RowHeightProperty.
public static RadProperty RowHeightProperty
Properties
Gets or sets a value indicating the position of the add new row.
public SystemRowPosition AddNewRowPosition { get; set; }
Gets or sets a value indicating whether right-clicking on a data cell will show the default data cell context menu.
public bool AllowCellContextMenu { get; set; }
Gets or sets a value indicating whether right-clicking on a header cell will show the default header cell context menu.
public bool AllowColumnHeaderContextMenu { get; set; }
Gets or sets a value indicating whether users can resize columns through the grid UI.
public bool AllowColumnResize { get; set; }
Gets or sets a value indicating whether users can sort columns by clicking the header or through the header context menu.
public bool AllowColumnSort { get; set; }
Gets or sets a value indicating whether the Copy option in the context menu and the Ctrl+C shortcut will be available to the user.
public bool AllowCopy { get; set; }
Gets or sets a value indicating whether the Cut option in the context menu and the Ctrl+X shortcut will be available to the user.
public bool AllowCut { get; set; }
Gets or sets a value indicating whether users can delete rows.
public bool AllowDelete { get; set; }
Gets or sets a value indicating whether users can edit the values in data cells.
public bool AllowEdit { get; set; }
Gets or sets a value indicating whether the users can sort by more than one column.
public bool AllowMultiColumnSorting { get; set; }
Gets or sets a value indicating whether the Paste option in the context menu and the Ctrl+V shortcut will be available to the user.
public bool AllowPaste { get; set; }
Gets or sets a value indicating whether users can resize rows through the grid UI.
public bool AllowRowResize { get; set; }
Gets or sets a value indicating how column widths are determined.
public VirtualGridAutoSizeColumnsMode AutoSizeColumnsMode { get; set; }
Gets or sets the distance between adjacent cells.
public int CellSpacing { get; set; }
Gets or sets the total number of columns to be displayed in the grid.
public int ColumnCount { get; set; }
Gets an VirtualGridTableViewState containing information and settings for the currently displayed columns.
public VirtualGridTableViewState ColumnsViewState { get; }
Gets or sets the default column width.
public int ColumnWidth { get; set; }
Gets or sets a value indicating whether event and odd rows will have a different back color.
public bool EnableAlternatingRowColor { get; set; }
Gets or sets a value indicating whether data is presented in chunks (pages) to the user.
public bool EnablePaging { get; set; }
Gets or sets the height of the current view when it is a child view and UseScrollbarsInHierarchy is set to true.
public int ExpandedHeight { get; set; }
Gets the filter descriptors currently applied to the grid.
public FilterDescriptorCollection FilterDescriptors { get; }
Gets or sets the height of the filter row.
public int FilterRowHeight { get; set; }
FilterRowValues
Dictionary<int, FilterOperator>
Gets a dictionary containing a cache of the values entered in the filter row. The key is the column index.
public Dictionary<int, FilterOperator> FilterRowValues { get; }
Gets an instance of RadVirtualGridElement which is the main element of this control.
public RadVirtualGridElement GridElement { get; }
Gets or sets the height of the header row.
public int HeaderRowHeight { get; set; }
Gets the hierarchy level of the current view.
public int HierarchyLevel { get; }
Gets or sets the ScrollState of the horizontal scroll bar.
public ScrollState HorizontalScrollState { get; set; }
Gets a value indicating whether this view's parent row is expanded.
public bool IsExpanded { get; }
Gets or sets a value indicating whether the busy indicator of the current view is visible.
public bool IsWaiting { get; set; }
Gets or sets the minimum width a column can be.
public int MinColumnWidth { get; set; }
Gets or sets the minimum height a data row can be.
public int MinRowHeight { get; set; }
Gets or sets the height of the add new row.
public int NewRowHeight { get; set; }
Gets a dictionary containing a cache of the values entered in the new row. The key is the column index.
public Dictionary<int, object> NewRowValues { get; }
Gets or sets the amount of padding to be applied to child views.
public Padding Padding { get; set; }
Gets or sets the index of the page currently presented in the grid.
public int PageIndex { get; set; }
Gets or sets the number of rows shown per page when paging is enabled.
public int PageSize { get; set; }
Gets the index of the parent row when the current view is a child view.
public int ParentRowIndex { get; }
Gets the parent view info when the current view info is a child view info.
public VirtualGridViewInfo ParentViewInfo { get; }
Gets or sets the total number of rows to be displayed in the grid.
public int RowCount { get; set; }
Gets or sets the space between adjacent rows.
public int RowSpacing { get; set; }
Gets an VirtualGridTableViewState containing information and settings for the currently displayed rows.
public VirtualGridTableViewState RowsViewState { get; }
Gets or sets a value indicating whether the filter row is visible.
public bool ShowFilterRow { get; set; }
Gets or sets a value indicating whether the header row is visible.
public bool ShowHeaderRow { get; set; }
Gets or sets a value indicating whether the add new row is visible.
public bool ShowNewRow { get; set; }
Gets the sort descriptors currently applied to the grid.
public SortDescriptorCollection SortDescriptors { get; }
Gets the total number of pages when paging is enabled.
public int TotalPages { get; }
Gets or sets the ScrollState of the vertical scroll bar.
public ScrollState VerticalScrollState { get; set; }
Methods
Binds the properties.
public void BindProperties(VirtualGridTableElement source)
The source.
Clears the error text of the specified row.
Creates a child view info for the specified row.
protected virtual VirtualGridViewInfo CreateChildViewInfo(int rowIndex)
The index of the row.
Returns:A new instance of VirtualGridViewInfo.
Gets the child view info for the specified row.
Gets the child view info for the specified row.
public VirtualGridViewInfo GetChildViewInfo(int rowIndex)
The index of the row.
Returns:The child view info if it exists, otherwise null.
Gets a value indicating whether clicking on the header cell of this column would allow the user to set natural (no) sort.
Gets the column pin position.
public PinnedColumnPosition GetColumnPinPosition(int columnIndex)
Index of the column.
Returns:Gets the row pin position.
public PinnedRowPosition GetRowPinPosition(int rowIndex)
Index of the row.
Returns:Gets the total height of the row.
Handles the property change.
protected void HandlePropertyChange(string propertyName)
Name of the property.
Initializes the view info.
protected virtual void InitializeViewInfo()
Moves the current view to the first page.
public void MoveToFirstPage()
Moves the current view to the last page.
public void MoveToLastPage()
Moves the current view to the next page index.
public void MoveToNextPage()
Moves the current view to the specified page index.
Moves the current view to the previous page index.
public void MoveToPreviousPage()
Notifies the grid when filter descriptors change and clears cached filter-row values when the collection is reset.
protected virtual void OnFilterDescriptorsCollectionChanged(NotifyCollectionChangedEventArgs e)
Raises the standard .NET PropertyChanged event.
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Overrides:
Notifies bound consumers of header, filter, and new-row height changes, and updates the default data-row size.
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Overrides:
Resets the view states of the view. Resets row heights, pin positions, expanded state, column widths and column pin positions.
public void ResetViewState()
Sets a value indicating whether clicking on the header cell of this column would allow the user to set natural (no) sort.
Sets the specified data types as the data type of the columns in the view info. The assignment starts from the first column and ends where the specified data types end. Data types affect the editors in the columns and the available filter options for each column.
Sets the pin position of the specified column.
public void SetColumnPinPosition(int columnIndex, PinnedColumnPosition pinPosition)
The index of the column.
pinPositionPinnedColumnPositionThe new pin position.
Sets the row error text for the specified row. Setting the error text to null has the same effect as calling ClearRowErrorText(int)
Sets the pin position of the specified row.
public void SetRowPinPosition(int rowIndex, PinnedRowPosition position)
The index of the row.
positionPinnedRowPositionThe new pin position.
Marks the specified row as waiting. This will display a waiting indicator in the row indent cell.
Removes the mark of the specified row as waiting. This will hide the waiting indicator in the row indent cell.
Unbinds the properties.
public void UnbindProperties(VirtualGridTableElement source)
The source.