Documentation

Class PropertyGridItem

Inheritance
System.Object
PropertyGridItemBase
PropertyGridItem
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.UI.dll

Syntax

public class PropertyGridItem : PropertyGridItemBase, INotifyPropertyChanged, IDataItem, ITypeDescriptorContext, IServiceProvider

Constructors

PropertyGridItem(PropertyGridTableElement)

Declaration
public PropertyGridItem(PropertyGridTableElement propertyGridElement)
Parameters
PropertyGridTableElement propertyGridElement

PropertyGridItem(PropertyGridTableElement, PropertyGridItem)

Declaration
public PropertyGridItem(PropertyGridTableElement propertyGridElement, PropertyGridItem parentItem)
Parameters
PropertyGridTableElement propertyGridElement

PropertyGridItem parentItem

Fields

cachedValue

Declaration
protected object cachedValue
Field Value
System.Object

Properties

Accessor

Gets the item accessor for this property item.

Declaration
public IItemAccessor Accessor { get; }
Property Value
IItemAccessor

Attributes

Gets a collection of the attributes applied to the property.

Declaration
public virtual AttributeCollection Attributes { get; }
Property Value
System.ComponentModel.AttributeCollection

Category

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

Declaration
public virtual string Category { get; }
Property Value
System.String

Container

Declaration
public IContainer Container { get; }
Property Value
System.ComponentModel.IContainer

DataBoundItem

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

Implements

DefaultSortOrder

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

Description

Gets or sets the description associated with this item.

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

Overrides

ErrorMessage

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

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

Expandable

Gets a value indicating whether this is a complex property.

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

Overrides

FieldCount

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

Implements

FormattedValue

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

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

GridItems

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

Declaration
public override PropertyGridItemCollection GridItems { get; }
Property Value
PropertyGridItemCollection

Overrides

Instance

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

IsModified

Gets a value indicating whether the property value is modified.

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

IsThreeState

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

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

Item[Int32]

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

Property Value
System.Object

Implements

Item[String]

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

Property Value
System.Object

Implements

Label

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

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

Overrides

Name

Gets the property name

Declaration
public override string Name { get; }
Property Value
System.String

Overrides

OriginalValue

Gets the original property value.

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

Parent

Gets or sets the parent of this item.

Declaration
public override PropertyGridItemBase Parent { get; }
Property Value
PropertyGridItemBase

Overrides

PropertyDescriptor

Gets the property descriptor for this property.

Declaration
public virtual PropertyDescriptor PropertyDescriptor { get; }
Property Value
System.ComponentModel.PropertyDescriptor

PropertyType

Gets the property type

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

ReadOnly

Gets a value indicating whether the property is read only.

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

SortOrder

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

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

TypeConverter

Gets the TypeConverter associated with this property

Declaration
public virtual TypeConverter TypeConverter { get; }
Property Value
System.ComponentModel.TypeConverter

UITypeEditor

Gets the UITypeEditor associated with this property

Declaration
public virtual UITypeEditor UITypeEditor { get; }
Property Value
System.Drawing.Design.UITypeEditor

Value

Gets or sets the item value.

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

The text.

Methods

BeginEdit()

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

Declaration
public virtual void BeginEdit()

ConvertToPasswordString(String)

Converts a string into a password string.

Declaration
protected virtual string ConvertToPasswordString(string input)
Parameters
System.String input

The input.
Returns
System.String

GetChildItems(PropertyGridItem, Object, Type)

Gets the child items for a given item.

Declaration
protected virtual PropertyGridItemCollection GetChildItems(PropertyGridItem parentItem, object obj, Type objType)
Parameters
PropertyGridItem parentItem

The parent item for which to get the child items.
System.Object obj

The instance of the item.
System.Type objType

The type of the property.
Returns
PropertyGridItemCollection

Collection of PropertyGridItem

GetService(Type)

Declaration
public object GetService(Type serviceType)
Parameters
System.Type serviceType

Returns
System.Object

Implements
System.IServiceProvider.GetService(System.Type)

IndexOf(String)

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

Returns
System.Int32

Implements

OnComponentChanged()

Declaration
public void OnComponentChanged()

OnComponentChanging()

Declaration
public bool OnComponentChanging()
Returns
System.Boolean

ResetValue()

Resets the property value to its default value.

Declaration
public virtual void ResetValue()

SetParent(PropertyGridItem)

Declaration
protected virtual void SetParent(PropertyGridItem parent)
Parameters
PropertyGridItem parent

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
protected virtual bool ShouldGetChildItemsAnew(object oldValue, object newValue)
Parameters
System.Object oldValue

The old value of this item.
System.Object newValue

The new value of this item.
Returns
System.Boolean

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
protected virtual bool TryGetDefaultValue(out object value)
Parameters
System.Object value

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

True if the item has a default value otherwise false.

Extension Methods