Class

MasterGridViewTemplate

Initializes a new instance of the MasterGridViewTemplate class.

Declaration

public MasterGridViewTemplate()

Gets or sets a value indicating whether a new bound row should be added to the data source before entering edit mode.

Declaration

[Browsable(false)]
public bool AddNewBoundRowBeforeEdit { get; set; }

Property Value

Gets or sets a value indicating whether the RadGridView will automatically generate hierarchical relationships from the data source structure when data binding is performed.

Declaration

[Browsable(false)]
public bool AutoGenerateHierarchy { get; set; }

Property Value

Gets a value that indicates whether the IPagedCollectionView.PageIndex value is allowed to change.

Declaration

public virtual bool CanChangePage { get; }

Property Value

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.

Declaration

[Browsable(false)]
public GridViewClipboardCopyMode ClipboardCopyMode { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public GridViewClipboardCutMode ClipboardCutMode { get; set; }

Property Value

Gets or sets a value that determines whether users can paste clipboard content into the RadGridView control and how the paste operation is handled.

Declaration

[Browsable(false)]
public GridViewClipboardPasteMode ClipboardPasteMode { get; set; }

Property Value

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.

Declaration

[Browsable(false)]
public GridViewRowInfo CurrentRow { get; set; }

Property Value

Gets or sets the currently active GridViewInfo that represents the view containing the current row and associated template information.

Declaration

[Browsable(false)]
public GridViewInfo CurrentView { get; set; }

Property Value

Gets or sets a value indicating whether data pagination is enabled for the current data view, allowing data to be displayed in pages.

Declaration

[Browsable(true)]
public bool EnablePaging { get; set; }

Property Value

Gets the EventDispatcher instance responsible for managing and dispatching events within the master template. Creates a new instance if one does not already exist.

Declaration

[Browsable(false)]
public override EventDispatcher EventDispatcher { get; }

Property Value

Overrides GridViewTemplate.EventDispatcher

Gets or sets the hierarchy data provider for the master template. Only GridViewSelfReferenceDataProvider and GridViewSelfReferenceLoadOnDemandDataProvider types are supported for master templates.

Declaration

[Browsable(false)]
public override GridViewHierarchyDataProvider HierarchyDataProvider { get; set; }

Property Value

Overrides GridViewTemplate.HierarchyDataProvider

Gets a value that indicates whether a page index change is in process.

Declaration

public virtual bool IsPageChanging { get; }

Property Value

Gets the root master template. For MasterGridViewTemplate instances, this property returns itself as it represents the top-level template in the hierarchy.

Declaration

[Browsable(false)]
public override MasterGridViewTemplate MasterTemplate { get; }

Property Value

Overrides GridViewTemplate.MasterTemplate

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.

Declaration

public bool MultiSelect { get; set; }

Property Value

Gets the RadGridView control that owns this master template instance.

Declaration

[Browsable(false)]
public RadGridView Owner { get; }

Property Value

Gets the zero-based index of the current page.

Declaration

public virtual int PageIndex { get; }

Property Value

Gets or sets the number of items to display on a page.

Declaration

public virtual int PageSize { get; set; }

Property Value

Gets or sets a value indicating whether paging is performed before grouping or vice versa.

Declaration

public virtual bool PagingBeforeGrouping { get; set; }

Property Value

Gets the collection of GridViewRelation instances that define the hierarchical structure and parent-child relationships between templates in the grid.

Declaration

[Browsable(false)]
public GridViewRelationCollection Relations { get; }

Property Value

Gets the collection of GridViewCellInfo instances that represent the cells currently selected by the user across all templates in the grid.

Declaration

[Browsable(false)]
public GridViewSelectedCellsCollection SelectedCells { get; }

Property Value

Gets the collection of GridViewRowInfo instances that represent the rows currently selected by the user across all templates in the grid.

Declaration

[Browsable(false)]
public GridViewSelectedRowsCollection SelectedRows { get; }

Property Value

Gets or sets the selection mode that determines how cells, rows, or columns can be selected in the RadGridView.

Declaration

public GridViewSelectionMode SelectionMode { get; set; }

Property Value

Gets or sets the GridViewColumn that will contain the self-reference expander items for hierarchical data display in self-referencing scenarios.

Declaration

[Browsable(true)]
public GridViewColumn SelfReferenceExpanderColumn { get; set; }

Property Value

Gets the GridViewSynchronizationService instance that coordinates event dispatch and synchronization across all templates and views within the RadGridView hierarchy.

Declaration

[Browsable(false)]
public GridViewSynchronizationService SynchronizationService { get; }

Property Value

Gets the total number of pages.

Declaration

public virtual int TotalPages { get; }

Property Value

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.

Declaration

[Browsable(false)]
public bool VirtualMode { get; set; }

Property Value

Analyzes a queue of grid view events.

Declaration

protected override bool AnalyzeQueueCore(List<GridViewEvent> events)

Parameters

Returns

Overrides GridViewTemplate.AnalyzeQueueCore(List<GridViewEvent>)

Begins the cell copy.

Declaration

public void BeginCellCopy()

Begins the row copy.

Declaration

public void BeginRowCopy()

Suspends event dispatching and begins a batch update operation to improve performance when making multiple changes to the grid.

Declaration

public override void BeginUpdate()

Overrides GridViewTemplate.BeginUpdate()

Clears all selected rows and cells from their respective collections in an efficient batch operation.

Declaration

protected virtual void ClearSelectedRowsOrCells()

Copies the formatted values of the currently selected cells to the clipboard without removing them from the grid.

Declaration

public virtual void Copy()

Creates the binding context for the master template. The master template inherits its binding context from the RadGridView control.

Declaration

protected override BindingContext CreateBindingContext()

Returns

Overrides GridViewTemplate.CreateBindingContext()

Creates and returns a new GridViewListSource instance specifically configured for the master template.

Declaration

protected override GridViewListSource CreateListSource()

Returns

Overrides GridViewTemplate.CreateListSource()

Moves the currently selected cells or rows to the clipboard, removing their values from the grid.

Declaration

public virtual void Cut()

Releases the unmanaged resources used by the Component and optionally releases the managed resources.

Declaration

protected override void Dispose(bool disposing)

Parameters

Overrides GridViewTemplate.Dispose(bool)

Ends the cell copy.

Declaration

public void EndCellCopy()

Completes the initialization of the master template and triggers hierarchy generation if no child templates exist.

Declaration

public override void EndInit()

Overrides GridViewTemplate.EndInit()

Ends the row copy.

Declaration

public void EndRowCopy()

Resumes event dispatching and ends the batch update operation, triggering hierarchy changed events across all templates in the grid.

Declaration

public override void EndUpdate(bool notify, DataViewChangedEventArgs e)

Parameters

Overrides GridViewTemplate.EndUpdate(bool, DataViewChangedEventArgs)

Retrieves the formatted values that represent the contents of the selected cells for copying to the clipboard without actually placing them on the clipboard.

Declaration

public virtual DataObject GetClipboardContent()

Returns

Retrieves and parses clipboard data in multiple formats (HTML, Text, CSV) and returns it as a structured collection of rows and columns.

Declaration

protected virtual List<List<string>> GetClipboardData()

Returns

Gets the event listener priority for the master template, which is set to highest priority to ensure it processes events first.

Declaration

protected override EventListenerPriority GetEventListenerPirotiy()

Returns

Overrides GridViewTemplate.GetEventListenerPirotiy()

Gets the event processing mode for the master template, enabling all phases of event processing including pre-processing, processing, post-processing, and queue analysis.

Declaration

protected override GridEventProcessMode GetEventProcessMode()

Returns

Overrides GridViewTemplate.GetEventProcessMode()

Gets the collection of existing rows where clipboard data should be pasted, starting from the current row position.

Declaration

protected virtual List<GridViewRowInfo> GetRowsToPasteIn(int numberOfRowsToGet)

Parameters

Returns

Sets the first page as the current page.

Declaration

public virtual bool MoveToFirstPage()

Returns

Sets the last page as the current page.

Declaration

public virtual bool MoveToLastPage()

Returns

Moves to the page after the current page.

Declaration

public virtual bool MoveToNextPage()

Returns

Requests a page move to the page at the specified zero-based index.

Declaration

public virtual bool MoveToPage(int pageIndex)

Parameters

Returns

Moves to the page before the current page.

Declaration

public virtual bool MoveToPreviousPage()

Returns

Handles property change notifications, triggering hierarchy generation when DataSource or DataMember properties change.

Declaration

protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)

Parameters

Overrides GridViewTemplate.OnNotifyPropertyChanged(PropertyChangedEventArgs)

Called when the page is changed.

Declaration

protected virtual void OnPageChanged(object sender, EventArgs e)

Parameters

Called when the page is changing.

Declaration

protected virtual void OnPageChanging(object sender, PageChangingEventArgs e)

Parameters

Handles view change events and performs additional logic such as paging adjustments when the view is reset.

Declaration

protected override void OnViewChanged(object sender, DataViewChangedEventArgs e)

Parameters

Overrides GridViewTemplate.OnViewChanged(object, DataViewChangedEventArgs)

Pastes the contents from the clipboard into the grid starting at the current cell position, creating new rows if necessary when pasting multiple rows.

Declaration

public virtual void Paste()

Pastes the data to new row.

Declaration

protected virtual void PasteDataToNewRow(List<string> rowData)

Parameters

Pastes a row of clipboard data into an existing grid row, performing data type conversion and validation as needed.

Declaration

protected virtual void PasteDataToRow(List<string> rowData, GridViewRowInfo row)

Parameters

Post-processes grid events, handling row disposal and view change cleanup operations after the main event processing is complete.

Declaration

protected override GridViewEventResult PostProcessEventCore(GridViewEvent eventData)

Parameters

Returns

Overrides GridViewTemplate.PostProcessEventCore(GridViewEvent)

Pre-processes grid events, particularly current row change events, to determine if the event should continue processing or be canceled.

Declaration

protected override GridViewEventResult PreProcessEventCore(GridViewEvent eventData)

Parameters

Returns

Overrides GridViewTemplate.PreProcessEventCore(GridViewEvent)

Processes core grid events including current row changes, template data source initialization, and column collection changes.

Declaration

protected override GridViewEventResult ProcessEventCore(GridViewEvent eventData)

Parameters

Returns

Overrides GridViewTemplate.ProcessEventCore(GridViewEvent)

Resets the master template to its default state by clearing all child templates, relations, columns, and resetting the data source and AutoGenerateHierarchy property.

Declaration

public void Reset()

Resets the current row.

Declaration

protected override void ResetCurrentRow()

Overrides GridViewTemplate.ResetCurrentRow()

Sets the current position in the grid by changing the active row and column, with optional validation of the row change.

Declaration

protected bool SetPosition(GridViewRowInfo row, GridViewColumn column, bool validateRowChange)

Parameters

Returns

Performs the core logic for setting the current position, including event handling, current row/column changes, and UI updates.

Declaration

protected virtual bool SetPositionCore(GridViewRowInfo newRow, GridViewColumn newColumn, GridViewRowInfo oldRow, GridViewColumn oldColumn, bool validateRowChange)

Parameters

Returns

Unsubscribes from internal events to prevent memory leaks when the master template is being disposed.

Declaration

protected override void UnwireEvents()

Overrides GridViewTemplate.UnwireEvents()

Subscribes to internal events required for the master template functionality, including paging events from the data view.

Declaration

protected override void WireEvents()

Overrides GridViewTemplate.WireEvents()