Class
GridViewRowInfo

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:

cs-api-definition
[TypeConverter(typeof(ExpandableObjectConverter))]
public abstract class GridViewRowInfo : IDataItem, IHierarchicalRow, INotifyPropertyChanged, INotifyPropertyChangingEx, IDisposable

Inheritance: objectGridViewRowInfo

Derived Classes: GridViewDataRowInfoGridViewDetailsRowInfoGridViewGroupRowInfoGridViewSystemRowInfo

Implements: IDataItemIDisposableIHierarchicalRowINotifyPropertyChangedINotifyPropertyChangingEx

Constructors

GridViewRowInfo(GridViewInfo)

Initializes a new instance of the GridViewRowInfo.

Declaration

cs-api-definition
public GridViewRowInfo(GridViewInfo viewInfo)

Parameters

viewInfo

GridViewInfo

An instance of GridViewInfo which the current row belongs to.

Fields

AllowResizeState

Declaration

cs-api-definition
protected const int AllowResizeState = 64

Field Value

int

IsAttachedState

Declaration

cs-api-definition
protected const int IsAttachedState = 1

Field Value

int

IsCurrentState

Declaration

cs-api-definition
protected const int IsCurrentState = 4

Field Value

int

IsExpandedState

Declaration

cs-api-definition
protected const int IsExpandedState = 16

Field Value

int

IsInitializedState

Declaration

cs-api-definition
protected const int IsInitializedState = 256

Field Value

int

IsModifiedState

Declaration

cs-api-definition
protected const int IsModifiedState = 2

Field Value

int

IsSelectedState

Declaration

cs-api-definition
protected const int IsSelectedState = 8

Field Value

int

IsVisibleState

Declaration

cs-api-definition
protected const int IsVisibleState = 32

Field Value

int

LastRowInfoState

Declaration

cs-api-definition
protected const int LastRowInfoState = 256

Field Value

int

SuspendNotificationsState

Declaration

cs-api-definition
protected const int SuspendNotificationsState = 128

Field Value

int

state

Declaration

cs-api-definition
protected BitVector32 state

Field Value

BitVector32

Properties

AllowResize

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

Declaration

cs-api-definition
public virtual bool AllowResize { get; set; }

Property Value

bool

AllowedStates

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

Declaration

cs-api-definition
public virtual AllowedGridViewRowInfoStates AllowedStates { get; }

Property Value

AllowedGridViewRowInfoStates

Cells

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

Declaration

cs-api-definition
public GridViewCellInfoCollection Cells { get; }

Property Value

GridViewCellInfoCollection

ChildRows

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

Declaration

cs-api-definition
public virtual GridViewChildRowCollection ChildRows { get; }

Property Value

GridViewChildRowCollection

Implements IHierarchicalRow.ChildRows

DataBoundItem

Gets the data-bound object that populated the row.

Declaration

cs-api-definition
public virtual object DataBoundItem { get; }

Property Value

object

ErrorText

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

Declaration

cs-api-definition
public string ErrorText { get; set; }

Property Value

string

Group

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

Declaration

cs-api-definition
public virtual DataGroup Group { get; }

Property Value

DataGroup

HasChildViews

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

Declaration

cs-api-definition
public virtual bool HasChildViews { get; }

Property Value

bool

Implements IHierarchicalRow.HasChildViews

Height

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

Declaration

cs-api-definition
public int Height { get; set; }

Property Value

int

HierarchyLevel

Gets the hierarchical level of this row in nested structures.

Declaration

cs-api-definition
public virtual int HierarchyLevel { get; }

Property Value

int

Implements IHierarchicalRow.HierarchyLevel

Index

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

Declaration

cs-api-definition
public virtual int Index { get; }

Property Value

int

IsCurrent

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

Declaration

cs-api-definition
public bool IsCurrent { get; set; }

Property Value

bool

IsExpanded

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

Declaration

cs-api-definition
public virtual bool IsExpanded { get; set; }

Property Value

bool

IsOdd

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

Declaration

cs-api-definition
public bool IsOdd { get; }

Property Value

bool

IsPinned

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

Declaration

cs-api-definition
public virtual bool IsPinned { get; set; }

Property Value

bool

IsSelected

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

Declaration

cs-api-definition
public bool IsSelected { get; set; }

Property Value

bool

IsSystem

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

Declaration

cs-api-definition
[Browsable(false)]
public virtual bool IsSystem { get; }

Property Value

bool

IsVisible

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

Declaration

cs-api-definition
public bool IsVisible { get; set; }

Property Value

bool

MaxHeight

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

Declaration

cs-api-definition
public int MaxHeight { get; set; }

Property Value

int

MinHeight

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

Declaration

cs-api-definition
public int MinHeight { get; set; }

Property Value

int

Parent

Gets the parent row in the hierarchical structure.

Declaration

cs-api-definition
public virtual IHierarchicalRow Parent { get; }

Property Value

IHierarchicalRow

Implements IHierarchicalRow.Parent

PinPosition

Gets or sets the pin position that determines where the row is positioned when pinned during vertical scrolling.

Declaration

cs-api-definition
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

cs-api-definition
public virtual Type RowElementType { get; }

Property Value

Type

Tag

Gets or sets custom data associated with this row.

Declaration

cs-api-definition
public object Tag { get; set; }

Property Value

object

ViewInfo

Gets the instance of GridViewInfo which the row belongs to.

Declaration

cs-api-definition
public virtual GridViewInfo ViewInfo { get; }

Property Value

GridViewInfo

ViewTemplate

Gets the GridViewTemplate that this row belongs to.

Declaration

cs-api-definition
public GridViewTemplate ViewTemplate { get; }

Property Value

GridViewTemplate

Methods

ClearCache()

Clears the cached values for this row.

Declaration

cs-api-definition
protected virtual void ClearCache()

Delete()

Removes this row from the GridViewRowCollection.

Declaration

cs-api-definition
public virtual void Delete()

DispatchEvent(KnownEvents, GridEventType, GridEventDispatchMode, object, object[])

Dispatches an event through the grid view's event system.

Declaration

cs-api-definition
protected virtual void DispatchEvent(KnownEvents id, GridEventType type, GridEventDispatchMode dispatchMode, object originator, object[] arguments)

Parameters

id

KnownEvents

The event identifier.

type

GridEventType

The event type.

dispatchMode

GridEventDispatchMode

The dispatch mode.

originator

object

The event originator.

arguments

object[]

The event arguments.

Dispose()

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

Declaration

cs-api-definition
public void Dispose()

Implements IDisposable.Dispose()

EnsureVisible()

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

Declaration

cs-api-definition
public void EnsureVisible()

EnsureVisible(bool)

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

Declaration

cs-api-definition
public void EnsureVisible(bool expandParentRows)

Parameters

expandParentRows

bool

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

cs-api-definition
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.

Declaration

cs-api-definition
public virtual int GetActualHeight(IGridView gridView)

Parameters

gridView

IGridView

The grid view control that contains this row.

Returns

int

The actual height of the row in pixels.

GetErrorText(string)

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

Declaration

cs-api-definition
public string GetErrorText(string fieldName)

Parameters

fieldName

string

The field name that identifies the cell.

Returns

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

cs-api-definition
protected virtual GridEventType GetEventInfo(GridPropertyChangedEventArgs property, out GridEventDispatchMode dispatchMode)

Parameters

property

GridPropertyChangedEventArgs

The property change event arguments.

dispatchMode

GridEventDispatchMode

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

cs-api-definition
public virtual bool HasChildRows()

Returns

bool

true if this row has child rows; otherwise, false.

InvalidateRow()

Forces the visual representation of this row to be refreshed and redrawn.

Declaration

cs-api-definition
public virtual void InvalidateRow()

OnBeginEdit()

Called when an edit operation begins on this row.

Declaration

cs-api-definition
protected virtual bool OnBeginEdit()

Returns

bool

true if the edit operation can proceed; otherwise, false.

OnEndEdit()

Called when an edit operation ends on this row.

Declaration

cs-api-definition
protected virtual bool OnEndEdit()

Returns

bool

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

OnPropertyChanged(PropertyChangedEventArgs)

Declaration

cs-api-definition
protected virtual void OnPropertyChanged(PropertyChangedEventArgs args)

Parameters

args

PropertyChangedEventArgs

OnPropertyChanging(PropertyChangingEventArgsEx)

Declaration

cs-api-definition
protected virtual void OnPropertyChanging(PropertyChangingEventArgsEx args)

Parameters

args

PropertyChangingEventArgsEx

ResumePropertyNotifications()

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

Declaration

cs-api-definition
public void ResumePropertyNotifications()

SetBooleanProperty(string, int, bool)

Sets a boolean property value and handles change notifications.

Declaration

cs-api-definition
protected virtual bool SetBooleanProperty(string propertyName, int propertyKey, bool value)

Parameters

propertyName

string

The name of the property being changed.

propertyKey

int

The bit vector key for the property state.

value

bool

The new boolean value to set.

Returns

bool

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

SetParent(GridViewRowInfo)

Sets the parent row for this row in the hierarchical structure.

Declaration

cs-api-definition
protected void SetParent(GridViewRowInfo parent)

Parameters

parent

GridViewRowInfo

The parent row to set.

SetRowStateProperty<T>(string, ref T, T)

Sets a property value in the row state and handles change notifications.

Declaration

cs-api-definition
protected virtual bool SetRowStateProperty<T>(string propertyName, ref T propertyField, T value)

Parameters

propertyName

string

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

bool

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

SuspendPropertyNotifications()

Temporarily suspends property change notifications for this row.

Declaration

cs-api-definition
public void SuspendPropertyNotifications()

Events

PropertyChanged

Occurs when a property value has changed.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged

PropertyChanging

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

Declaration

cs-api-definition
public event PropertyChangingEventHandlerEx PropertyChanging

Event Value

PropertyChangingEventHandlerEx

Implements INotifyPropertyChangingEx.PropertyChanging