Class
PropertyGridItem

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

cs-api-definition
public class PropertyGridItem : PropertyGridItemBase, INotifyPropertyChanged, IDataItem, ITypeDescriptorContext, IServiceProvider

Inheritance: objectPropertyGridItemBasePropertyGridItem

Implements: IDataItemINotifyPropertyChangedIServiceProviderITypeDescriptorContext

Inherited Members PropertyGridItemBase.SuspendNotificationsStatePropertyGridItemBase.IsExpandedStatePropertyGridItemBase.IsVisibleStatePropertyGridItemBase.IsEnableStatePropertyGridItemBase.IsModifiedStatePropertyGridItemBase.statePropertyGridItemBase.textPropertyGridItemBase.Expand()PropertyGridItemBase.Collapse()PropertyGridItemBase.EnsureVisible()PropertyGridItemBase.Select()PropertyGridItemBase.SetBooleanProperty(string, int, bool)PropertyGridItemBase.Update(PropertyGridTableElement.UpdateActions)PropertyGridItemBase.SuspendPropertyNotifications()PropertyGridItemBase.ResumePropertyNotifications()PropertyGridItemBase.OnNotifyPropertyChanged(string)PropertyGridItemBase.OnNotifyPropertyChanged(PropertyChangedEventArgs)PropertyGridItemBase.PropertyGridTableElementPropertyGridItemBase.VisiblePropertyGridItemBase.SelectedPropertyGridItemBase.ExpandedPropertyGridItemBase.EnabledPropertyGridItemBase.ItemHeightPropertyGridItemBase.ImagePropertyGridItemBase.ImageIndexPropertyGridItemBase.ImageKeyPropertyGridItemBase.ToolTipTextPropertyGridItemBase.ContextMenuPropertyGridItemBase.TagPropertyGridItemBase.LevelPropertyGridItemBase.PropertyChanged

Constructors

PropertyGridItem(PropertyGridTableElement)

Declaration

cs-api-definition
public PropertyGridItem(PropertyGridTableElement propertyGridElement)

Parameters

propertyGridElement

PropertyGridTableElement

PropertyGridItem(PropertyGridTableElement, PropertyGridItem)

Declaration

cs-api-definition
public PropertyGridItem(PropertyGridTableElement propertyGridElement, PropertyGridItem parentItem)

Parameters

propertyGridElement

PropertyGridTableElement

parentItem

PropertyGridItem

Fields

cachedValue

Declaration

cs-api-definition
protected object cachedValue

Field Value

object

Properties

Accessor

Gets the item accessor for this property item.

Declaration

cs-api-definition
public IItemAccessor Accessor { get; }

Property Value

IItemAccessor

Attributes

Gets a collection of the attributes applied to the property.

Declaration

cs-api-definition
public virtual AttributeCollection Attributes { get; }

Property Value

AttributeCollection

Category

Gets the category of the property from its CategoryAttribute or returns "Other" if no category is specified.

Declaration

cs-api-definition
public virtual string Category { get; }

Property Value

string

Container

Declaration

cs-api-definition
public IContainer Container { get; }

Property Value

IContainer

Implements ITypeDescriptorContext.Container

DataBoundItem

Declaration

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

Property Value

object

Implements IDataItem.DataBoundItem

DefaultSortOrder

Declaration

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

Property Value

bool

Description

Gets or sets the description associated with this item.

Declaration

cs-api-definition
public override string Description { get; set; }

Property Value

string

Overrides PropertyGridItemBase.Description

ErrorMessage

Gets or sets an error message to be displayed when property value validation fails.

Declaration

cs-api-definition
public virtual string ErrorMessage { get; set; }

Property Value

string

Expandable

Gets a value indicating whether this is a complex property.

Declaration

cs-api-definition
public override bool Expandable { get; }

Property Value

bool

Overrides PropertyGridItemBase.Expandable

FieldCount

Declaration

cs-api-definition
public int FieldCount { get; }

Property Value

int

Implements IDataItem.FieldCount

FormattedValue

Gets the value of the property as a string using its TypeConverter.

Declaration

cs-api-definition
public virtual string FormattedValue { get; set; }

Property Value

string

GridItems

Gets the sub items of the current if it is composed of several subitems.

Declaration

cs-api-definition
public override PropertyGridItemCollection GridItems { get; }

Property Value

PropertyGridItemCollection

Overrides PropertyGridItemBase.GridItems

Instance

Declaration

cs-api-definition
public object Instance { get; }

Property Value

object

Implements ITypeDescriptorContext.Instance

IsModified

Gets a value indicating whether the property value is modified.

Declaration

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

Property Value

bool

IsThreeState

Gets or sets a value defining whether check box editor will be three state.

Declaration

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

Property Value

bool

Label

Gets or sets the text that would be displayed for this property.

Declaration

cs-api-definition
public override string Label { get; set; }

Property Value

string

Overrides PropertyGridItemBase.Label

Name

Gets the property name

Declaration

cs-api-definition
public override string Name { get; }

Property Value

string

Overrides PropertyGridItemBase.Name

OriginalValue

Gets the original property value.

Declaration

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

Property Value

object

Parent

Gets or sets the parent of this item.

Declaration

cs-api-definition
public override PropertyGridItemBase Parent { get; }

Property Value

PropertyGridItemBase

Overrides PropertyGridItemBase.Parent

PropertyDescriptor

Gets the property descriptor for this property.

Declaration

cs-api-definition
public virtual PropertyDescriptor PropertyDescriptor { get; }

Property Value

PropertyDescriptor

Implements ITypeDescriptorContext.PropertyDescriptor

PropertyType

Gets the property type

Declaration

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

Property Value

Type

ReadOnly

Gets a value indicating whether the property is read only.

Declaration

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

Property Value

bool

SortOrder

Gets or sets a value defining the sort order of the item when no other sorting is applied.

Declaration

cs-api-definition
public virtual int SortOrder { get; set; }

Property Value

int

TypeConverter

Gets the TypeConverter associated with this property

Declaration

cs-api-definition
public virtual TypeConverter TypeConverter { get; }

Property Value

TypeConverter

UITypeEditor

Gets the UITypeEditor associated with this property

Declaration

cs-api-definition
public virtual UITypeEditor UITypeEditor { get; }

Property Value

UITypeEditor

Value

Gets or sets the item value.

Declaration

cs-api-definition
public virtual object Value { get; set; }

Property Value

object

The text.

this[int]

Declaration

cs-api-definition
public object this[int index] { get; set; }

Parameters

index

int

Property Value

object

Implements IDataItem.this[int]

this[string]

Declaration

cs-api-definition
public object this[string name] { get; set; }

Parameters

name

string

Property Value

object

Implements IDataItem.this[string]

Methods

BeginEdit()

Selects this item and puts the Property grid in edit mode.

Declaration

cs-api-definition
public virtual void BeginEdit()

ConvertToPasswordString(string)

Converts a string into a password string.

Declaration

cs-api-definition
protected virtual string ConvertToPasswordString(string input)

Parameters

input

string

The input.

Returns

string

GetChildItems(PropertyGridItem, object, Type)

Gets the child items for a given item.

Declaration

cs-api-definition
protected virtual PropertyGridItemCollection GetChildItems(PropertyGridItem parentItem, object obj, Type objType)

Parameters

parentItem

PropertyGridItem

The parent item for which to get the child items.

obj

object

The instance of the item.

objType

Type

The type of the property.

Returns

PropertyGridItemCollection

Collection of PropertyGridItem

GetService(Type)

Declaration

cs-api-definition
public object GetService(Type serviceType)

Parameters

serviceType

Type

Returns

object

Implements IServiceProvider.GetService(Type)

IndexOf(string)

Declaration

cs-api-definition
public int IndexOf(string name)

Parameters

name

string

Returns

int

Implements IDataItem.IndexOf(string)

OnComponentChanged()

Declaration

cs-api-definition
public void OnComponentChanged()

Implements ITypeDescriptorContext.OnComponentChanged()

OnComponentChanging()

Declaration

cs-api-definition
public bool OnComponentChanging()

Returns

bool

Implements ITypeDescriptorContext.OnComponentChanging()

ResetValue()

Resets the property value to its default value.

Declaration

cs-api-definition
public virtual void ResetValue()

SetParent(PropertyGridItem)

Declaration

cs-api-definition
protected virtual void SetParent(PropertyGridItem parent)

Parameters

parent

PropertyGridItem

ShouldGetChildItemsAnew(object, object)

Determines if the item should update its child items based on the types of the old value and the new one.

Declaration

cs-api-definition
protected virtual bool ShouldGetChildItemsAnew(object oldValue, object newValue)

Parameters

oldValue

object

The old value of this item.

newValue

object

The new value of this item.

Returns

bool

True if child items should be updated otherwise false.

TryGetDefaultValue(out object)

Gets the default value of the current item. A return parameter determines if the operation succeeded.

Declaration

cs-api-definition
protected virtual bool TryGetDefaultValue(out object value)

Parameters

value

object

An object where the default value will be stored if there is such.

Returns

bool

True if the item has a default value otherwise false.