Class
RadListDataItem

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class RadListDataItem : RadObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, IDataItem

Inheritance: objectDisposableObjectRadObjectRadListDataItem

Derived Classes: CommandBarItemsListDataItemCommandBarStripsListDataItemDescriptionTextListDataItemRadCheckedListDataItem

Implements: ICustomTypeDescriptorIDataItemIDisposableINotifyPropertyChanged

Inherited Members RadObject.BindingContextPropertyRadObject.RadTypeRadObject.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadObject.DisposeManagedResources()RadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.GetValue(RadProperty)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.SetValueCore(RadPropertyValue, object, object, ValueSource)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.CanRaisePropertyChangeNotifications(RadPropertyValue)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.AddStylePropertySetting(IPropertySetting)RadObject.GetInheritedValue(RadProperty)RadObject.OnPropertyChanging(RadPropertyChangingEventArgs)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.IsPropertyCancelable(RadPropertyMetadata)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.PerformDispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing

Constructors

RadListDataItem()

Declaration

cs-api-definition
public RadListDataItem()

RadListDataItem(string)

Declaration

cs-api-definition
public RadListDataItem(string text)

Parameters

text

string

RadListDataItem(string, object)

Declaration

cs-api-definition
public RadListDataItem(string text, object value)

Parameters

text

string

value

object

Fields

ActiveProperty

Declaration

cs-api-definition
public static readonly RadProperty ActiveProperty

Field Value

RadProperty

HeightProperty

Declaration

cs-api-definition
public static readonly RadProperty HeightProperty

Field Value

RadProperty

SelectedProperty

Declaration

cs-api-definition
public static readonly RadProperty SelectedProperty

Field Value

RadProperty

ValueProperty

Declaration

cs-api-definition
public static readonly RadProperty ValueProperty

Field Value

RadProperty

dataLayer

Declaration

cs-api-definition
protected ListDataLayer dataLayer

Field Value

ListDataLayer

ownerElement

Declaration

cs-api-definition
protected RadListElement ownerElement

Field Value

RadListElement

Properties

Active

Declaration

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

Property Value

bool

DataBoundItem

Gets or sets a value that represents the raw data item that this RadListDataItem is associated with. This property will be non null when the item is created via RadListControl's data binding and will contain the underlaying data item. Setting this property explicitly will have no effect in unbound mode and will throw an InvalidOperationException in bound mode.

Declaration

cs-api-definition
[Browsable(false)]
public object DataBoundItem { get; set; }

Property Value

object

Implements IDataItem.DataBoundItem

DisplayValue

Gets a value that will be used in the visual representation of this item.

Declaration

cs-api-definition
[Browsable(false)]
public object DisplayValue { get; }

Property Value

object

Enabled

Gets or sets whether this item responds to GUI events.

Declaration

cs-api-definition
[Browsable(true)]
public bool Enabled { get; set; }

Property Value

bool

Font

Gets or sets the font for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public Font Font { get; set; }

Property Value

Font

ForeColor

Gets or sets the text color for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public Color ForeColor { get; set; }

Property Value

Color

Height

Gets or sets the visual height of this item. This property can be set only when AutoSizeItems of the parent RadListControl is true.

Declaration

cs-api-definition
[Browsable(true)]
public int Height { get; set; }

Property Value

int

Image

Gets or sets an image for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public Image Image { get; set; }

Property Value

Image

ImageAlignment

Gets or sets the image alignment for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public ContentAlignment ImageAlignment { get; set; }

Property Value

ContentAlignment

Index

Gets the index of item in GridViewRowCollection.

Declaration

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

Property Value

int

The index.

IsDataBound

Gets a value indicating whether this data item is data bound.

Declaration

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

Property Value

bool

IsVisible

Gets a value that indicates if this item is currently visible.

Declaration

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

Property Value

bool

MeasuredSize

Gets or sets the preferred size for the element which will present this item.

Declaration

cs-api-definition
[Browsable(false)]
public SizeF MeasuredSize { get; set; }

Property Value

SizeF

Owner

Gets a value representing the owner RadListElement of this data item.

Declaration

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

Property Value

RadListElement

OwnerControl

Gets a value representing the owner control of this data item.

Declaration

cs-api-definition
[Browsable(false)]
public Control OwnerControl { get; }

Property Value

Control

RowIndex

Gets the index of this data item in the Items collection of RadListControl.

Declaration

cs-api-definition
[Browsable(false)]
public int RowIndex { get; }

Property Value

int

Selected

Gets or sets a value that indicates if this item is selected. Setting this property will cause the selection events of the owner list control to fire if there is one.

Declaration

cs-api-definition
[Browsable(true)]
public virtual bool Selected { get; set; }

Property Value

bool

SvgImage

Gets or sets a vector image for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public RadSvgImage SvgImage { get; set; }

Property Value

RadSvgImage

Tag

Declaration

cs-api-definition
[Bindable(true)]
[TypeConverter(typeof(StringConverter))]
public object Tag { get; set; }

Property Value

object

Text

Gets or sets the text for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public virtual string Text { get; set; }

Property Value

string

TextAlignment

Gets or sets the text alignment for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public ContentAlignment TextAlignment { get; set; }

Property Value

ContentAlignment

TextImageRelation

Gets or sets the text-image relation for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public TextImageRelation TextImageRelation { get; set; }

Property Value

TextImageRelation

TextOrientation

Gets or sets the text orientation for this RadListDataItem instance.

Declaration

cs-api-definition
[Browsable(true)]
public Orientation TextOrientation { get; set; }

Property Value

Orientation

TextWrap

Declaration

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

Property Value

bool

Value

Gets or sets a value for the property indicated by ValueMember if in bound mode, and private value in unbound mode. Trying to explicitly set this property in bound mode will result in an InvalidOperationException.

Declaration

cs-api-definition
[Browsable(false)]
public virtual object Value { get; set; }

Property Value

object

VisualItem

Gets a value that visually represents this data item. If the item is not visible, this property returns null. The visual item returned should be used only to get information about a particular item. Since visual items are shared between different data items, properties must not be set directly on the visual item in order to avoid uncustomizable or unwanted behavior. For example if properties are set directly to the visual item the themes may not work correctly.

Declaration

cs-api-definition
[Browsable(false)]
public RadListVisualItem VisualItem { get; }

Property Value

RadListVisualItem

Methods

GetBoundValue()

Gets a value for the Value property while in bound mode.

Declaration

cs-api-definition
protected virtual object GetBoundValue()

Returns

object

Gets an object reference pointing to the value of the Value property in bound mode.

GetUnboundValue()

Gets a value for the Value property in unbound mode.

Declaration

cs-api-definition
protected virtual object GetUnboundValue()

Returns

object

Returns an object reference pointing to the value of the Value property in unbound mode.

OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.

Declaration

cs-api-definition
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)

Parameters

e

RadPropertyChangedEventArgs

The RadPropertyChangedEventArgs containing information about the property change.

Overrides RadObject.OnPropertyChanged(RadPropertyChangedEventArgs)

SetDataBoundItem(bool, object)

This method is used to assign the DataBoundItem property of this RadListDataItem. If a user attempts to set DataBoundItem while in bound mode, an exception should be thrown. In unbound mode this property can be set to any value and will not affect the behavior of this RadListDataItem.

Declaration

cs-api-definition
protected virtual void SetDataBoundItem(bool dataBinding, object value)

Parameters

dataBinding

bool

A flag that indicates if the data bound item is being set from the data binding engine or by the user. true means it is being set by the data binding engine.

value

object

The value that will be assigned to the DataBoundItem property.

SetUnboundValue(object)

This method is called when setting the Value property of a RadListDataItem when it is in unbound mode.

Declaration

cs-api-definition
protected virtual void SetUnboundValue(object value)

Parameters

value

object

The value to set the Value property to.

ToString()

Declaration

cs-api-definition
public override string ToString()

Returns

string

Overrides object.ToString()