ClassGridViewRowInfo
This class contains logical information about a row of tabular data which is presented in the RadGridView.
Definition
Namespace:Telerik.WinControls.UI
Assembly:Telerik.WinControls.GridView.dll
Syntax:
[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class GridViewRowInfo : IDataItem, IHierarchicalRow, INotifyPropertyChanged, INotifyPropertyChangingEx, IDisposable
Inheritance: objectGridViewRowInfo
Derived Classes:
Implements:
Constructors
GridViewRowInfo(GridViewInfo)
Initializes a new instance of the GridViewRowInfo.
Declaration
public GridViewRowInfo(GridViewInfo viewInfo)
Parameters
viewInfo
An instance of GridViewInfo which the current row belongs to.
Fields
Properties
AllowResize
Gets or sets a value indicating whether the user can resize this row by dragging its border.
AllowedStates
Gets the allowed states that this row can be in, determining what operations are permitted.
Declaration
public virtual AllowedGridViewRowInfoStates AllowedStates { get; }
Property Value
Cells
Gets the collection of GridViewCellInfo objects that represent the cells in this row.
Declaration
public GridViewCellInfoCollection Cells { get; }
Property Value
ChildRows
Gets the collection of child rows for this row in hierarchical structures.
Declaration
public virtual GridViewChildRowCollection ChildRows { get; }
Property Value
Implements
DataBoundItem
Gets the data-bound object that populated the row.
ErrorText
Gets or sets the error message text for row-level validation errors.
HasChildViews
Gets a value indicating whether this row has expandable child views in hierarchical structures.
Declaration
public virtual bool HasChildViews { get; }
Property Value
Implements
Height
Gets or sets the current height of the row in pixels.
HierarchyLevel
Gets the hierarchical level of this row in nested structures.
Declaration
public virtual int HierarchyLevel { get; }
Property Value
Implements
Index
Gets the zero-based index of the row in the GridViewRowCollection.
IsCurrent
Gets a value indicating whether this row contains the currently selected cell in the RadGridView.
IsExpanded
Gets or sets a value indicating whether this row is expanded in hierarchical or grouped views.
IsOdd
Gets a value indicating whether this row's index is odd, which is used for alternating row coloring.
IsPinned
Gets or sets a value indicating whether this row is pinned and remains in a fixed position during vertical scrolling.
IsSelected
Gets or sets a value indicating whether the row is selected.
IsSystem
Determines whether the row is internally created by RadGridView and is used for displaying some dynamic information.
Declaration
[Browsable(false)]
public virtual bool IsSystem { get; }
Property Value
IsVisible
Gets or sets a value indicating whether the row is visible.
MaxHeight
Gets or sets the maximum height of the row in pixels.
MinHeight
Gets or sets the minimum height of the row in pixels.
Parent
Gets the parent row in the hierarchical structure.
Declaration
public virtual IHierarchicalRow Parent { get; }
Property Value
Implements
PinPosition
Gets or sets the pin position that determines where the row is positioned when pinned during vertical scrolling.
Declaration
public virtual PinnedRowPosition PinPosition { get; set; }
Property Value
RowElementType
Gets the type of the GridRowElement that will be used to visually represent this row.
Tag
Gets or sets custom data associated with this row.
ViewInfo
Gets the instance of GridViewInfo which the row belongs to.
Declaration
public virtual GridViewInfo ViewInfo { get; }
Property Value
ViewTemplate
Gets the GridViewTemplate that this row belongs to.
Declaration
public GridViewTemplate ViewTemplate { get; }
Property Value
Methods
ClearCache()
Clears the cached values for this row.
Declaration
protected virtual void ClearCache()
Delete()
Removes this row from the GridViewRowCollection.
Declaration
public virtual void Delete()
DispatchEvent(KnownEvents, GridEventType, GridEventDispatchMode, object, object[])
Dispatches an event through the grid view's event system.
Declaration
protected virtual void DispatchEvent(KnownEvents id, GridEventType type, GridEventDispatchMode dispatchMode, object originator, object[] arguments)
Parameters
id
The event identifier.
type
The event type.
dispatchMode
The dispatch mode.
originator
The event originator.
arguments
object[]
The event arguments.
Dispose()
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Declaration
public void Dispose()
Implements
EnsureVisible()
Scrolls the grid view to make this row visible if it is currently outside the viewport.
Declaration
public void EnsureVisible()
EnsureVisible(bool)
Scrolls the grid view to make this row visible, with an option to expand parent rows.
Declaration
public void EnsureVisible(bool expandParentRows)
Parameters
expandParentRows
If set to true, expands all parent rows to make this row accessible.
FindParent<T>()
Searches up the hierarchy to find the first parent of the specified type.
Declaration
public T FindParent<T>() where T : IHierarchicalRow
Returns
T
The first parent of type T, or the default value if no such parent is found.
GetActualHeight(IGridView)
Calculates and returns the actual rendered height of the row.
GetErrorText(string)
Gets the error text associated with the specified cell in this row.
GetEventInfo(GridPropertyChangedEventArgs, out GridEventDispatchMode)
Gets event information for property changes and determines the dispatch mode.
Declaration
protected virtual GridEventType GetEventInfo(GridPropertyChangedEventArgs property, out GridEventDispatchMode dispatchMode)
Parameters
property
The property change event arguments.
dispatchMode
The dispatch mode to use for the event.
Returns
The event type for the property change.
HasChildRows()
Determines whether this row has any child rows in hierarchical structures.
Declaration
public virtual bool HasChildRows()
Returns
true if this row has child rows; otherwise, false.
InvalidateRow()
Forces the visual representation of this row to be refreshed and redrawn.
Declaration
public virtual void InvalidateRow()
OnBeginEdit()
Called when an edit operation begins on this row.
Declaration
protected virtual bool OnBeginEdit()
Returns
true if the edit operation can proceed; otherwise, false.
OnEndEdit()
Called when an edit operation ends on this row.
Declaration
protected virtual bool OnEndEdit()
Returns
true if the edit operation completed successfully; otherwise, false.
OnPropertyChanged(PropertyChangedEventArgs)
Declaration
protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)
Parameters
args
OnPropertyChanging(PropertyChangingEventArgsEx)
Declaration
protected virtual void OnPropertyChanging(PropertyChangingEventArgsEx args)
Parameters
args
ResumePropertyNotifications()
Resumes property change notifications after they were suspended by SuspendPropertyNotifications().
Declaration
public void ResumePropertyNotifications()
SetBooleanProperty(string, int, bool)
Sets a boolean property value and handles change notifications.
Declaration
protected virtual bool SetBooleanProperty(string propertyName, int propertyKey, bool value)
Parameters
propertyName
The name of the property being changed.
propertyKey
The bit vector key for the property state.
value
The new boolean value to set.
Returns
true if the property was successfully changed; otherwise, false.
SetParent(GridViewRowInfo)
Sets the parent row for this row in the hierarchical structure.
Declaration
protected void SetParent(GridViewRowInfo parent)
Parameters
parent
The parent row to set.
SetRowStateProperty<T>(string, ref T, T)
Sets a property value in the row state and handles change notifications.
Declaration
protected virtual bool SetRowStateProperty<T>(string propertyName, ref T propertyField, T value)
Parameters
propertyName
The name of the property being changed.
propertyField
T
A reference to the property field to update.
value
T
The new value to set.
Returns
true if the property was successfully changed; otherwise, false.
SuspendPropertyNotifications()
Temporarily suspends property change notifications for this row.
Declaration
public void SuspendPropertyNotifications()
Events
PropertyChanged
Occurs when a property value has changed.
Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Value
Implements
PropertyChanging
Occurs when a property value is changing and can be cancelled.
Declaration
public event PropertyChangingEventHandlerEx PropertyChanging
Event Value
Implements