Class GridViewRowInfo

This class contains logical information about a row of tabular data which is presented in the RadGridView.

Inheritance
System.Object
GridViewRowInfo
GridViewDataRowInfo
GridViewDetailsRowInfo
GridViewGroupRowInfo
GridViewSystemRowInfo
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.GridView.dll

Syntax

public abstract class GridViewRowInfo : IDataItem, IHierarchicalRow, INotifyPropertyChanged, INotifyPropertyChangingEx, IDisposable

Constructors

GridViewRowInfo(GridViewInfo)

Initializes a new instance of the GridViewRowInfo.

Declaration
public GridViewRowInfo(GridViewInfo viewInfo)
Parameters
GridViewInfo viewInfo

An instance of GridViewInfo which the current row belongs to.

Fields

AllowResizeState

Declaration
protected const int AllowResizeState = 64
Field Value
System.Int32

IsAttachedState

Declaration
protected const int IsAttachedState = 1
Field Value
System.Int32

IsCurrentState

Declaration
protected const int IsCurrentState = 4
Field Value
System.Int32

IsExpandedState

Declaration
protected const int IsExpandedState = 16
Field Value
System.Int32

IsInitializedState

Declaration
protected const int IsInitializedState = 256
Field Value
System.Int32

IsModifiedState

Declaration
protected const int IsModifiedState = 2
Field Value
System.Int32

IsSelectedState

Declaration
protected const int IsSelectedState = 8
Field Value
System.Int32

IsVisibleState

Declaration
protected const int IsVisibleState = 32
Field Value
System.Int32

LastRowInfoState

Declaration
protected const int LastRowInfoState = 256
Field Value
System.Int32

state

Declaration
protected BitVector32 state
Field Value
System.Collections.Specialized.BitVector32

SuspendNotificationsState

Declaration
protected const int SuspendNotificationsState = 128
Field Value
System.Int32

Properties

AllowedStates

Gets the allowed states that this row can be in, determining what operations are permitted.

Declaration
public virtual AllowedGridViewRowInfoStates AllowedStates { get; }
Property Value
AllowedGridViewRowInfoStates

AllowResize

Gets or sets a value indicating whether the user can resize this row by dragging its border.

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

Cells

Gets the collection of GridViewCellInfo objects that represent the cells in this row.

Declaration
public GridViewCellInfoCollection Cells { get; }
Property Value
GridViewCellInfoCollection

ChildRows

Gets the collection of child rows for this row in hierarchical structures.

Declaration
public virtual GridViewChildRowCollection ChildRows { get; }
Property Value
GridViewChildRowCollection

Implements

DataBoundItem

Gets the data-bound object that populated the row.

Declaration
public virtual object DataBoundItem { get; }
Property Value
System.Object

ErrorText

Gets or sets the error message text for row-level validation errors.

Declaration
public string ErrorText { get; set; }
Property Value
System.String

Group

Gets the DataGroup that contains this row when data is grouped.

Declaration
public virtual DataGroup Group { get; }
Property Value
DataGroup

HasChildViews

Gets a value indicating whether this row has expandable child views in hierarchical structures.

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

Implements

Height

Gets or sets the current height of the row in pixels.

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

HierarchyLevel

Gets the hierarchical level of this row in nested structures.

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

Implements

Index

Gets the zero-based index of the row in the GridViewRowCollection.

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

IsCurrent

Gets a value indicating whether this row contains the currently selected cell in the RadGridView.

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

IsEditable

This property is not relevant for this class.

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

IsExpanded

Gets or sets a value indicating whether this row is expanded in hierarchical or grouped views.

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

IsModified

This property is not relevant for this class.

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

IsOdd

Gets a value indicating whether this row's index is odd, which is used for alternating row coloring.

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

IsPinned

Gets or sets a value indicating whether this row is pinned and remains in a fixed position during vertical scrolling.

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

IsSelected

Gets or sets a value indicating whether the row is selected.

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

IsSystem

Determines whether the row is internally created by RadGridView and is used for displaying some dynamic information.

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

IsVisible

Gets or sets a value indicating whether the row is visible.

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

MaxHeight

Gets or sets the maximum height of the row in pixels.

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

MinHeight

Gets or sets the minimum height of the row in pixels.

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

Parent

Gets the parent row in the hierarchical structure.

Declaration
public virtual IHierarchicalRow Parent { get; }
Property Value
IHierarchicalRow

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
PinnedRowPosition

RowElementType

Gets the type of the GridRowElement that will be used to visually represent this row.

Declaration
public virtual Type RowElementType { get; }
Property Value
System.Type

SearchCache

This property is not relevant for this class.

Declaration
public Hashtable SearchCache { get; }
Property Value
System.Collections.Hashtable

Tag

Gets or sets custom data associated with this row.

Declaration
public object Tag { get; set; }
Property Value
System.Object

ViewInfo

Gets the instance of GridViewInfo which the row belongs to.

Declaration
public virtual GridViewInfo ViewInfo { get; }
Property Value
GridViewInfo

ViewTemplate

Gets the GridViewTemplate that this row belongs to.

Declaration
public GridViewTemplate ViewTemplate { get; }
Property Value
GridViewTemplate

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
KnownEvents id

The event identifier.
GridEventType type

The event type.
GridEventDispatchMode dispatchMode

The dispatch mode.
System.Object originator

The event originator.
System.Object[] arguments

The event arguments.

Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration
public void Dispose()
Implements
System.IDisposable.Dispose()

EnsureVisible()

Scrolls the grid view to make this row visible if it is currently outside the viewport.

Declaration
public void EnsureVisible()

EnsureVisible(Boolean)

Scrolls the grid view to make this row visible, with an option to expand parent rows.

Declaration
public void EnsureVisible(bool expandParentRows)
Parameters
System.Boolean 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.
Type Parameters
T

The type of parent to search for.

GetActualHeight(IGridView)

Calculates and returns the actual rendered height of the row.

Declaration
public virtual int GetActualHeight(IGridView gridView)
Parameters
IGridView gridView

The grid view control that contains this row.
Returns
System.Int32

The actual height of the row in pixels.

GetErrorText(String)

Gets the error text associated with the specified cell in this row.

Declaration
public string GetErrorText(string fieldName)
Parameters
System.String fieldName

The field name that identifies the cell.
Returns
System.String

The error text for the specified cell, or empty string if no error exists.

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
GridPropertyChangedEventArgs property

The property change event arguments.
GridEventDispatchMode dispatchMode

The dispatch mode to use for the event.
Returns
GridEventType

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
System.Boolean

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
System.Boolean

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
System.Boolean

true if the edit operation completed successfully; otherwise, false.

OnPropertyChanged(PropertyChangedEventArgs)

Declaration
protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)
Parameters
System.ComponentModel.PropertyChangedEventArgs args

OnPropertyChanging(PropertyChangingEventArgsEx)

Declaration
protected virtual void OnPropertyChanging(PropertyChangingEventArgsEx args)
Parameters
PropertyChangingEventArgsEx args

ResumePropertyNotifications()

Resumes property change notifications after they were suspended by SuspendPropertyNotifications().

Declaration
public void ResumePropertyNotifications()

SetBooleanProperty(String, Int32, Boolean)

Sets a boolean property value and handles change notifications.

Declaration
protected virtual bool SetBooleanProperty(string propertyName, int propertyKey, bool value)
Parameters
System.String propertyName

The name of the property being changed.
System.Int32 propertyKey

The bit vector key for the property state.
System.Boolean value

The new boolean value to set.
Returns
System.Boolean

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
GridViewRowInfo 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
System.String propertyName

The name of the property being changed.
T propertyField

A reference to the property field to update.
T value

The new value to set.
Returns
System.Boolean

true if the property was successfully changed; otherwise, false.
Type Parameters
T

The type of the property value.

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 Type
System.ComponentModel.PropertyChangedEventHandler

PropertyChanging

Occurs when a property value is changing and can be cancelled.

Declaration
public event PropertyChangingEventHandlerEx PropertyChanging
Event Type
PropertyChangingEventHandlerEx

Implements

Explicit Interface Implementations

IDataItem.DataBoundItem

Declaration
object IDataItem.DataBoundItem { get; set; }
Returns
System.Object

Implements

IDataItem.FieldCount

Declaration
int IDataItem.FieldCount { get; }
Returns
System.Int32

Implements

IDataItem.get_Item(Int32)

Declaration
object IDataItem.get_Item(int index)
Parameters
System.Int32 index

Returns
System.Object

Implements
Telerik.WinControls.Data.IDataItem.get_Item(System.Int32)

IDataItem.get_Item(String)

Declaration
object IDataItem.get_Item(string name)
Parameters
System.String name

Returns
System.Object

Implements
Telerik.WinControls.Data.IDataItem.get_Item(System.String)

IDataItem.IndexOf(String)

Declaration
int IDataItem.IndexOf(string name)
Parameters
System.String name

Returns
System.Int32

Implements

IDataItem.Item[Int32]

Declaration
object IDataItem.this[] { get; set; }
Parameters
System.Int32 index

Returns
System.Object

Implements

IDataItem.Item[String]

Declaration
object IDataItem.this[] { get; set; }
Parameters
System.String name

Returns
System.Object

Implements

IDataItem.set_Item(Int32, Object)

Declaration
void IDataItem.set_Item(int index, object value)
Parameters
System.Int32 index

System.Object value

Implements
Telerik.WinControls.Data.IDataItem.set_Item(System.Int32, System.Object)

IDataItem.set_Item(String, Object)

Declaration
void IDataItem.set_Item(string name, object value)
Parameters
System.String name

System.Object value

Implements
Telerik.WinControls.Data.IDataItem.set_Item(System.String, System.Object)

Extension Methods