Class MasterGridViewTemplate

This component represents a customizable view template for displaying flat tabular data.

Inheritance
System.Object
GridViewTemplate
MasterGridViewTemplate
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public class MasterGridViewTemplate : GridViewTemplate, IDataItemSource, IHierarchicalRow, INotifyPropertyChangingEx, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IGridViewEventListener

Constructors

MasterGridViewTemplate()

Initializes a new instance of the MasterGridViewTemplate class.

Declaration
public MasterGridViewTemplate()

Properties

AddNewBoundRowBeforeEdit

Gets or sets a value indicating whether [add new bound row before edit].

Declaration
public bool AddNewBoundRowBeforeEdit { get; set; }
Property Value
System.Boolean

true if [add new bound row before edit]; otherwise, false.

AutoGenerateHierarchy

Gets or sets a value indicating whether the RadGridView will automatically build hierarchy from DataSource.

Declaration
public bool AutoGenerateHierarchy { get; set; }
Property Value
System.Boolean

CanChangePage

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

Declaration
public virtual bool CanChangePage { get; }
Property Value
System.Boolean

true if the IPagedCollectionView.PageIndex value is allowed to change; otherwise, false.

ClipboardCopyMode

Gets or sets a value that indicates whether users can copy cell text values to the System.Windows.Forms.Clipboard and whether row and column header text is included.

Declaration
public GridViewClipboardCopyMode ClipboardCopyMode { get; set; }
Property Value
GridViewClipboardCopyMode

ClipboardCutMode

Gets or sets a value that indicates whether users can cut cell text values to the System.Windows.Forms.Clipboard and whether row and column header text is included.

Declaration
public GridViewClipboardCutMode ClipboardCutMode { get; set; }
Property Value
GridViewClipboardCutMode

ClipboardPasteMode

Gets or sets a value that indicates whether users can paste Clipboard values to the RadGridView control.

Declaration
public GridViewClipboardPasteMode ClipboardPasteMode { get; set; }
Property Value
GridViewClipboardPasteMode

CurrentRow

Gets or sets the current row for the grid.

Declaration
public GridViewRowInfo CurrentRow { get; set; }
Property Value
GridViewRowInfo

CurrentView

Gets or sets the current view.

Declaration
public GridViewInfo CurrentView { get; set; }
Property Value
GridViewInfo

EnablePaging

Gets or sets a value indicating whether the data in the current DataView can be paginated.

Declaration
public bool EnablePaging { get; set; }
Property Value
System.Boolean

EventDispatcher

Gets the event dispatcher

Declaration
public override EventDispatcher EventDispatcher { get; }
Property Value
EventDispatcher

Overrides

GridReadOnly

Gets or sets a value indicating whether RadGridView is in read only mode.

Declaration
public bool GridReadOnly { get; set; }
Property Value
System.Boolean

HierarchyDataProvider

Gets or sets the hierarchy data provider.

Declaration
public override GridViewHierarchyDataProvider HierarchyDataProvider { get; set; }
Property Value
GridViewHierarchyDataProvider

The hierarchy data provider.
Overrides

IsPageChanging

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

Declaration
public virtual bool IsPageChanging { get; }
Property Value
System.Boolean

true if the page index is changing; otherwise, false.

MasterTemplate

Gets the root template.

Declaration
public override MasterGridViewTemplate MasterTemplate { get; }
Property Value
MasterGridViewTemplate

Overrides

MultiSelect

Gets or sets a value indicating whether the user is allowed to select more than one cell, row, or column of the RadGridView at a time.

Declaration
public bool MultiSelect { get; set; }
Property Value
System.Boolean

Owner

Gets the RadGridView control associated with this template.

Declaration
public RadGridView Owner { get; }
Property Value
RadGridView

PageIndex

Gets the zero-based index of the current page.

Declaration
public virtual int PageIndex { get; }
Property Value
System.Int32

The zero-based index of the current page.

PageSize

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

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

The number of items to display on a page.

PagingBeforeGrouping

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

Declaration
public virtual bool PagingBeforeGrouping { get; set; }
Property Value
System.Boolean

true if paging is performed before grouping; otherwise, false.

Relations

Gets collection of GridViewRelation instances that represent the hierarchical structure.

Declaration
public GridViewRelationCollection Relations { get; }
Property Value
GridViewRelationCollection

SelectedCells

Gets the collection of cells selected by the user.

Declaration
public GridViewSelectedCellsCollection SelectedCells { get; }
Property Value
GridViewSelectedCellsCollection

SelectedRows

Gets the collection of rows selected by the user.

Declaration
public GridViewSelectedRowsCollection SelectedRows { get; }
Property Value
GridViewSelectedRowsCollection

SelectionMode

Gets or sets a value indicating how the cells of the RadGridView can be selected.

Declaration
public GridViewSelectionMode SelectionMode { get; set; }
Property Value
GridViewSelectionMode

SelfReferenceExpanderColumn

Gets or sets the columns the cells of which will contain the self-reference expander items.

Declaration
public GridViewColumn SelfReferenceExpanderColumn { get; set; }
Property Value
GridViewColumn

SynchronizationService

Gets the GridViewSynchronizationService instance, used to dispatch internal grid events.

Declaration
public GridViewSynchronizationService SynchronizationService { get; }
Property Value
GridViewSynchronizationService

ThrowExceptionOnDataOperationInVirtualMode

Gets or sets a value indicating whether an exception will be thrown of one attemps to sort, filter or group in virtual mode.

Declaration
public bool ThrowExceptionOnDataOperationInVirtualMode { get; set; }
Property Value
System.Boolean

TotalPages

Gets the total number of pages.

Declaration
public virtual int TotalPages { get; }
Property Value
System.Int32

VirtualMode

Gets or sets a value indicating whether you have provided your own data-management operations for the RadGridView control.

Declaration
public bool VirtualMode { get; set; }
Property Value
System.Boolean

Methods

AnalyzeQueueCore(List<GridViewEvent>)

Declaration
protected override bool AnalyzeQueueCore(List<GridViewEvent> events)
Parameters
System.Collections.Generic.List<GridViewEvent> events

Returns
System.Boolean

Overrides

BeginCellCopy()

Begins the cell copy.

Declaration
public void BeginCellCopy()

BeginRowCopy()

Begins the row copy.

Declaration
public void BeginRowCopy()

BeginUpdate()

Begins the update.

Declaration
public override void BeginUpdate()
Overrides

ClearSelectedRowsOrCells()

Declaration
protected virtual void ClearSelectedRowsOrCells()

Copy()

Copy the formatted values that represent the contents of the selected cells to the System.Windows.Forms.Clipboard.

Declaration
public virtual void Copy()

CreateBindingContext()

Creates the binding context.

Declaration
protected override BindingContext CreateBindingContext()
Returns
System.Windows.Forms.BindingContext

Overrides

CreateListSource()

Creates the list source.

Declaration
protected override GridViewListSource CreateListSource()
Returns
GridViewListSource

Overrides

Cut()

Moves the current selection in the to the Clipboard.

Declaration
public virtual void Cut()

Dispose(Boolean)

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

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.
Overrides

EndCellCopy()

Ends the cell copy.

Declaration
public void EndCellCopy()

EndInit()

Ends view template initialization.

Declaration
public override void EndInit()
Overrides

EndRowCopy()

Ends the row copy.

Declaration
public void EndRowCopy()

EndUpdate(Boolean, DataViewChangedEventArgs)

Ends the update.

Declaration
public override void EndUpdate(bool notify, DataViewChangedEventArgs e)
Parameters
System.Boolean notify

DataViewChangedEventArgs e

Overrides

GetClipboardContent()

Retrieves the formatted values that represent the contents of the selected cells for copying to the System.Windows.Forms.Clipboard.

Declaration
public virtual DataObject GetClipboardContent()
Returns
System.Windows.Forms.DataObject

GetClipboardData()

Gets the clipboard data.

Declaration
protected virtual List<List<string>> GetClipboardData()
Returns
System.Collections.Generic.List<System.Collections.Generic.List<System.String>>

GetEventListenerPirotiy()

Declaration
protected override EventListenerPriority GetEventListenerPirotiy()
Returns
EventListenerPriority

Overrides

GetEventProcessMode()

Gets the event process mode.

Declaration
protected override GridEventProcessMode GetEventProcessMode()
Returns
GridEventProcessMode

Overrides

GetRowsToPasteIn(Int32)

Gets the rows to paste in.

Declaration
protected virtual List<GridViewRowInfo> GetRowsToPasteIn(int numberOfRowsToGet)
Parameters
System.Int32 numberOfRowsToGet

The number of rows to get.
Returns
System.Collections.Generic.List<GridViewRowInfo>

MoveToFirstPage()

Sets the first page as the current page.

Declaration
public virtual bool MoveToFirstPage()
Returns
System.Boolean

true if the operation was successful; otherwise, false.

MoveToLastPage()

Sets the last page as the current page.

Declaration
public virtual bool MoveToLastPage()
Returns
System.Boolean

true if the operation was successful; otherwise, false.

MoveToNextPage()

Moves to the page after the current page.

Declaration
public virtual bool MoveToNextPage()
Returns
System.Boolean

true if the operation was successful; otherwise, false.

MoveToPage(Int32)

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

Declaration
public virtual bool MoveToPage(int pageIndex)
Parameters
System.Int32 pageIndex

The zero-based index of the page to move to.
Returns
System.Boolean

true if the operation was successful; otherwise, false.

MoveToPreviousPage()

Moves to the page before the current page.

Declaration
public virtual bool MoveToPreviousPage()
Returns
System.Boolean

true if the operation was successful; otherwise, false.

OnNotifyPropertyChanged(PropertyChangedEventArgs)

Declaration
protected override void OnNotifyPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

Overrides

OnPageChanged(Object, EventArgs)

Called when the page is changed.

Declaration
protected virtual void OnPageChanged(object sender, EventArgs e)
Parameters
System.Object sender

The sender.
System.EventArgs e

The System.EventArgs instance containing the event data.

OnPageChanging(Object, PageChangingEventArgs)

Called when the page is changing.

Declaration
protected virtual void OnPageChanging(object sender, PageChangingEventArgs e)
Parameters
System.Object sender

The sender.
PageChangingEventArgs e

The PageChangingEventArgs instance containing the event data.

OnViewChanged(Object, DataViewChangedEventArgs)

Called when the view is changed.

Declaration
protected override void OnViewChanged(object sender, DataViewChangedEventArgs e)
Parameters
System.Object sender

The sender.
DataViewChangedEventArgs e

The DataViewChangedEventArgs instance containing the event data.
Overrides

Paste()

Paste the contents of the System.Windows.Forms.Clipboard to the current view.

Declaration
public virtual void Paste()

PasteDataToNewRow(List<String>)

Pastes the data to new row.

Declaration
protected virtual void PasteDataToNewRow(List<string> rowData)
Parameters
System.Collections.Generic.List<System.String> rowData

The row data.

PasteDataToRow(List<String>, GridViewRowInfo)

Pastes the data to row.

Declaration
protected virtual void PasteDataToRow(List<string> rowData, GridViewRowInfo row)
Parameters
System.Collections.Generic.List<System.String> rowData

The row data.
GridViewRowInfo row

The row.

PostProcessEventCore(GridViewEvent)

Declaration
protected override GridViewEventResult PostProcessEventCore(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Overrides

PreProcessEventCore(GridViewEvent)

Declaration
protected override GridViewEventResult PreProcessEventCore(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Overrides

ProcessEventCore(GridViewEvent)

Declaration
protected override GridViewEventResult ProcessEventCore(GridViewEvent eventData)
Parameters
GridViewEvent eventData

Returns
GridViewEventResult

Overrides

Reset()

Clears the Child templates, Relations, Columns, reset DataSource to null and AutoGenerateHierarchy property to its default value.

Declaration
public void Reset()

ResetCurrentRow()

Resets the current row.

Declaration
protected override void ResetCurrentRow()
Overrides

SetPosition(GridViewRowInfo, GridViewColumn, Boolean)

Sets the position.

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

The row.
GridViewColumn column

The column.
System.Boolean validateRowChange

The validate row change.
Returns
System.Boolean

SetPositionCore(GridViewRowInfo, GridViewColumn, GridViewRowInfo, GridViewColumn, Boolean)

Sets the position core.

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

The new row.
GridViewColumn newColumn

The new column.
GridViewRowInfo oldRow

The old row.
GridViewColumn oldColumn

The old column.
System.Boolean validateRowChange

The validate row change.
Returns
System.Boolean

UnwireEvents()

Declaration
protected override void UnwireEvents()
Overrides

WireEvents()

Declaration
protected override void WireEvents()
Overrides

Extension Methods