Represents the master template for RadGridView that provides the core functionality for data display, hierarchical relationships, selection management, and event synchronization across the entire grid structure.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
public class MasterGridViewTemplate : GridViewTemplate, IComponent, IDisposable, IDataItemSource, IHierarchicalRow, INotifyPropertyChangingEx, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IGridViewEventListenerInheritance: objectMarshalByRefObjectComponentGridViewTemplateMasterGridViewTemplate
Implements:
Inherited Members
Constructors
Initializes a new instance of the MasterGridViewTemplate class.
public MasterGridViewTemplate()Properties
Gets or sets a value indicating whether a new bound row should be added to the data source before entering edit mode.
[Browsable(false)]
public bool AddNewBoundRowBeforeEdit { get; set; }Gets or sets a value indicating whether the RadGridView will automatically generate hierarchical relationships from the data source structure when data binding is performed.
[Browsable(false)]
public bool AutoGenerateHierarchy { get; set; }Gets a value that indicates whether the IPagedCollectionView.PageIndex value is allowed to change.
public virtual bool CanChangePage { get; }true if the IPagedCollectionView.PageIndex value is allowed to change; otherwise, false.
Gets or sets a value that determines whether users can copy cell text values to the clipboard and whether row and column header text is included in the copy operation.
[Browsable(false)]
public GridViewClipboardCopyMode ClipboardCopyMode { get; set; }Gets or sets a value that determines whether users can cut cell text values to the clipboard and whether row and column header text is included in the cut operation.
[Browsable(false)]
public GridViewClipboardCutMode ClipboardCutMode { get; set; }Gets or sets a value that determines whether users can paste clipboard content into the RadGridView control and how the paste operation is handled.
[Browsable(false)]
public GridViewClipboardPasteMode ClipboardPasteMode { get; set; }Gets or sets the currently active row in the grid. Setting this property triggers current row changed events and updates the current column to match the new row's template if applicable.
[Browsable(false)]
public GridViewRowInfo CurrentRow { get; set; }Gets or sets the currently active GridViewInfo that represents the view containing the current row and associated template information.
[Browsable(false)]
public GridViewInfo CurrentView { get; set; }Gets or sets a value indicating whether data pagination is enabled for the current data view, allowing data to be displayed in pages.
[Browsable(true)]
public bool EnablePaging { get; set; }Gets the EventDispatcher instance responsible for managing and dispatching events within the master template. Creates a new instance if one does not already exist.
[Browsable(false)]
public override EventDispatcher EventDispatcher { get; }Overrides:
Gets or sets the hierarchy data provider for the master template. Only GridViewSelfReferenceDataProvider and GridViewSelfReferenceLoadOnDemandDataProvider types are supported for master templates.
[Browsable(false)]
public override GridViewHierarchyDataProvider HierarchyDataProvider { get; set; }Overrides:
Gets a value that indicates whether a page index change is in process.
public virtual bool IsPageChanging { get; }true if the page index is changing; otherwise, false.
Gets the root master template. For MasterGridViewTemplate instances, this property returns itself as it represents the top-level template in the hierarchy.
[Browsable(false)]
public override MasterGridViewTemplate MasterTemplate { get; }Overrides:
Gets or sets a value indicating whether multiple cells, rows, or columns can be selected simultaneously in the RadGridView. When false, only single selection is allowed.
public bool MultiSelect { get; set; }Gets the RadGridView control that owns this master template instance.
[Browsable(false)]
public RadGridView Owner { get; }Gets the zero-based index of the current page.
public virtual int PageIndex { get; }The zero-based index of the current page.
Gets or sets the number of items to display on a page.
public virtual int PageSize { get; set; }The number of items to display on a page.
Gets or sets a value indicating whether paging is performed before grouping or vice versa.
public virtual bool PagingBeforeGrouping { get; set; }true if paging is performed before grouping; otherwise, false.
Gets the collection of GridViewRelation instances that define the hierarchical structure and parent-child relationships between templates in the grid.
[Browsable(false)]
public GridViewRelationCollection Relations { get; }Gets the collection of GridViewCellInfo instances that represent the cells currently selected by the user across all templates in the grid.
[Browsable(false)]
public GridViewSelectedCellsCollection SelectedCells { get; }Gets the collection of GridViewRowInfo instances that represent the rows currently selected by the user across all templates in the grid.
[Browsable(false)]
public GridViewSelectedRowsCollection SelectedRows { get; }Gets or sets the selection mode that determines how cells, rows, or columns can be selected in the RadGridView.
public GridViewSelectionMode SelectionMode { get; set; }Gets or sets the GridViewColumn that will contain the self-reference expander items for hierarchical data display in self-referencing scenarios.
[Browsable(true)]
public GridViewColumn SelfReferenceExpanderColumn { get; set; }Gets the GridViewSynchronizationService instance that coordinates event dispatch and synchronization across all templates and views within the RadGridView hierarchy.
[Browsable(false)]
public GridViewSynchronizationService SynchronizationService { get; }Gets the total number of pages.
public virtual int TotalPages { get; }Gets or sets a value indicating whether the grid operates in virtual mode, where data management operations such as sorting, filtering, and grouping are handled by the application rather than the grid control.
[Browsable(false)]
public bool VirtualMode { get; set; }Methods
Analyzes a queue of grid view events.
protected override bool AnalyzeQueueCore(List<GridViewEvent> events)The list of events to analyze.
Returns:true if the queue was analyzed successfully; otherwise, false.
Overrides:
Begins the cell copy.
public void BeginCellCopy()Begins the row copy.
public void BeginRowCopy()Suspends event dispatching and begins a batch update operation to improve performance when making multiple changes to the grid.
public override void BeginUpdate()Overrides:
Clears all selected rows and cells from their respective collections in an efficient batch operation.
protected virtual void ClearSelectedRowsOrCells()Copies the formatted values of the currently selected cells to the clipboard without removing them from the grid.
public virtual void Copy()Creates the binding context for the master template. The master template inherits its binding context from the RadGridView control.
protected override BindingContext CreateBindingContext()Returns null as the master template uses the binding context from its parent RadGridView control.
Overrides:
Creates and returns a new GridViewListSource instance specifically configured for the master template.
protected override GridViewListSource CreateListSource()A new GridViewListSource instance associated with this master template.
Overrides:
Moves the currently selected cells or rows to the clipboard, removing their values from the grid.
public virtual void Cut()Ends the cell copy.
public void EndCellCopy()Completes the initialization of the master template and triggers hierarchy generation if no child templates exist.
public override void EndInit()Overrides:
Ends the row copy.
public void EndRowCopy()Resumes event dispatching and ends the batch update operation, triggering hierarchy changed events across all templates in the grid.
public override void EndUpdate(bool notify, DataViewChangedEventArgs e)Indicates whether to notify listeners of the changes.
eDataViewChangedEventArgsThe data view changed event arguments containing information about the changes.
Overrides:
Retrieves the formatted values that represent the contents of the selected cells for copying to the clipboard without actually placing them on the clipboard.
public virtual DataObject GetClipboardContent()A DataObject containing the formatted cell values in multiple clipboard formats.
Retrieves and parses clipboard data in multiple formats (HTML, Text, CSV) and returns it as a structured collection of rows and columns.
protected virtual List<List<string>> GetClipboardData()List<List<string>>
A list of lists representing rows and columns of clipboard data.
Gets the event listener priority for the master template, which is set to highest priority to ensure it processes events first.
protected override EventListenerPriority GetEventListenerPirotiy()The Highest priority level.
Overrides:
Gets the event processing mode for the master template, enabling all phases of event processing including pre-processing, processing, post-processing, and queue analysis.
protected override GridEventProcessMode GetEventProcessMode()A combination of GridEventProcessMode flags indicating comprehensive event processing.
Overrides:
Gets the collection of existing rows where clipboard data should be pasted, starting from the current row position.
protected virtual List<GridViewRowInfo> GetRowsToPasteIn(int numberOfRowsToGet)The number of rows to retrieve for pasting.
Returns:List<GridViewRowInfo>
A list of GridViewRowInfo objects representing the target rows for pasting.
Sets the first page as the current page.
public virtual bool MoveToFirstPage()true if the operation was successful; otherwise, false.
Sets the last page as the current page.
public virtual bool MoveToLastPage()true if the operation was successful; otherwise, false.
Moves to the page after the current page.
public virtual bool MoveToNextPage()true if the operation was successful; otherwise, false.
Moves to the page before the current page.
public virtual bool MoveToPreviousPage()true if the operation was successful; otherwise, false.
Handles property change notifications, triggering hierarchy generation when DataSource or DataMember properties change.
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)The PropertyChangedEventArgs containing information about the changed property.
Overrides:
Called when the page is changing.
protected virtual void OnPageChanging(object sender, PageChangingEventArgs e)The sender.
ePageChangingEventArgsThe PageChangingEventArgs instance containing the event data.
Handles view change events and performs additional logic such as paging adjustments when the view is reset.
protected override void OnViewChanged(object sender, DataViewChangedEventArgs e)The source of the event.
eDataViewChangedEventArgsThe DataViewChangedEventArgs containing information about the view change.
Overrides:
Pastes the contents from the clipboard into the grid starting at the current cell position, creating new rows if necessary when pasting multiple rows.
public virtual void Paste()Pastes the data to new row.
protected virtual void PasteDataToNewRow(List<string> rowData)The row data.
Pastes a row of clipboard data into an existing grid row, performing data type conversion and validation as needed.
protected virtual void PasteDataToRow(List<string> rowData, GridViewRowInfo row)The list of string values representing the clipboard row data.
rowGridViewRowInfoThe target GridViewRowInfo where the data will be pasted.
Post-processes grid events, handling row disposal and view change cleanup operations after the main event processing is complete.
protected override GridViewEventResult PostProcessEventCore(GridViewEvent eventData)The GridViewEvent containing event information.
Returns:A GridViewEventResult indicating the post-processing outcome, or null if no special handling is required.
Overrides:
Pre-processes grid events, particularly current row change events, to determine if the event should continue processing or be canceled.
protected override GridViewEventResult PreProcessEventCore(GridViewEvent eventData)The GridViewEvent containing event information.
Returns:A GridViewEventResult indicating whether to continue event processing or cancel it.
Overrides:
Processes core grid events including current row changes, template data source initialization, and column collection changes.
protected override GridViewEventResult ProcessEventCore(GridViewEvent eventData)The GridViewEvent containing event information.
Returns:A GridViewEventResult indicating the processing outcome, or null to continue with default processing.
Overrides:
Resets the master template to its default state by clearing all child templates, relations, columns, and resetting the data source and AutoGenerateHierarchy property.
public void Reset()Resets the current row.
protected override void ResetCurrentRow()Overrides:
Sets the current position in the grid by changing the active row and column, with optional validation of the row change.
protected bool SetPosition(GridViewRowInfo row, GridViewColumn column, bool validateRowChange)The GridViewRowInfo to set as the current row.
columnGridViewColumnThe GridViewColumn to set as the current column.
validateRowChangeboolIndicates whether to validate the row change operation.
Returns:True if the position was successfully changed; otherwise, false.
Performs the core logic for setting the current position, including event handling, current row/column changes, and UI updates.
protected virtual bool SetPositionCore(GridViewRowInfo newRow, GridViewColumn newColumn, GridViewRowInfo oldRow, GridViewColumn oldColumn, bool validateRowChange)The new GridViewRowInfo to set as current.
newColumnGridViewColumnThe new GridViewColumn to set as current.
oldRowGridViewRowInfoThe previous current row.
oldColumnGridViewColumnThe previous current column.
validateRowChangeboolIndicates whether to validate the row change operation.
Returns:True if the position change was successful; otherwise, false.
Unsubscribes from internal events to prevent memory leaks when the master template is being disposed.
protected override void UnwireEvents()Overrides:
Subscribes to internal events required for the master template functionality, including paging events from the data view.
protected override void WireEvents()Overrides: