New to Telerik UI for WinForms? Start a free 30-day trial

Provides shared display state, interaction state, and change notifications for PropertyGrid items.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public abstract class PropertyGridItemBase : INotifyPropertyChanged

Inheritance: objectPropertyGridItemBase

Derived Classes: PropertyGridGroupItemPropertyGridItem

Implements: INotifyPropertyChanged

Constructors

Associates the item with the table element that owns and displays it.

C#
public PropertyGridItemBase(PropertyGridTableElement propertyGridElement)
Parameters:propertyGridElementPropertyGridTableElement

The table element that owns the item.

Fields

Bit mask for the item's enabled state.

C#
protected const int IsEnableState = 8

Bit mask for the item's expanded state.

C#
protected const int IsExpandedState = 2

Bit mask used by IsModified to track modified descriptor-backed values.

C#
protected const int IsModifiedState = 16

Bit mask for the item's visibility state.

C#
protected const int IsVisibleState = 4

Packed storage for the item's visibility, expansion, enabled, modified, and notification-suppression flags.

C#
protected BitVector32 state

Bit mask used to suppress property notifications and table updates.

C#
protected const int SuspendNotificationsState = 1

Backing text for the item label; property items use it as an override before their display name or property name.

C#
protected string text

Properties

Gets or sets the context menu associated to the item.

C#
public virtual RadContextMenu ContextMenu { get; set; }
Property Value:

Returns an instance of RadDropDownMenu that is associated with the item. The default value is null.

This property could be used to associate a custom menu and replace the property grid's default. If the context menu is invoked by right-clicking an item, the property grid's menu will not be shown and the context menu assigned to this item will be shown instead.

Gets or sets the description associated with this item.

C#
public virtual string Description { get; set; }

Gets or sets a value indicating whether the item can respond to user interaction.

C#
public virtual bool Enabled { get; set; }
Property Value:

The default value is true.

Gets a value indicating whether this item is expandable.

C#
public abstract bool Expandable { get; }

Gets or sets a value indicating whether this item is expanded.

C#
public virtual bool Expanded { get; set; }
Property Value:

true if this item is expanded; otherwise, false.

Gets the child items list associated with this item.

C#
public abstract PropertyGridItemCollection GridItems { get; }

Gets or sets the image of the node.

C#
[TypeConverter(typeof(ImageTypeConverter))]
public virtual Image Image { get; set; }

Gets or sets the left image list index value of the image displayed when the tree node is not selected.

C#
[RelatedImageList("PropertyGrid.ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.NoneExcludedImageIndexConverter, Telerik.WinControls.UI.Design, Version=2026.3.1026.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public virtual int ImageIndex { get; set; }

Gets or sets the key for the left image associated with this tree node when the node is not selected.

C#
[RelatedImageList("PropertyGrid.ImageList")]
[TypeConverter("Telerik.WinControls.UI.Design.RadImageKeyConverter, Telerik.WinControls.UI.Design, Version=2026.3.1026.48, Culture=neutral, PublicKeyToken=5bb2a467cbec794e")]
public string ImageKey { get; set; }

Gets or sets the height of the item.

C#
public int ItemHeight { get; set; }
Property Value:

A positive value overrides the table's item height; zero or a negative value uses the table height. The item-level value defaults to 0.

Gets or sets the text associated with this item.

C#
public virtual string Label { get; set; }

Gets a value indicating how deep in the hierarchy this propety is.

C#
public int Level { get; }

Gets the property name

C#
public abstract string Name { get; }

Gets the parent item for this item.

C#
public virtual PropertyGridItemBase Parent { get; }

Gets the parent property grid that the item is assigned to.

C#
public virtual PropertyGridTableElement PropertyGridTableElement { get; }

Gets or sets a value indicating whether this item is selected.

C#
public virtual bool Selected { get; set; }
Property Value:

true if this item is selected; otherwise, false.

Gets or sets the tag object that can be used to store user data, corresponding to the item.

C#
public virtual object Tag { get; set; }
Property Value:

The tag.

Gets or sets the tool tip text associated with this item.

C#
public virtual string ToolTipText { get; set; }

Gets or sets a value indicating whether this instance is visible.

C#
public virtual bool Visible { get; set; }
Property Value:

true if this instance is visible; otherwise, false.

Methods

Collapses the item.

C#
public virtual void Collapse()

Ensures that this item is visible in the content of the RadPropertyGridElement.

C#
public virtual void EnsureVisible()

Expandes the item.

C#
public virtual void Expand()

Raises PropertyChanged with the supplied event data.

C#
public virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs args)
Parameters:argsPropertyChangedEventArgs

The property-change event data.

Raises PropertyChanged for the specified property name.

C#
public virtual void OnNotifyPropertyChanged(string name)
Parameters:namestring

The name of the property that changed.

Resumes property notifications after a previous SuspendPropertyNotifications call.

C#
public void ResumePropertyNotifications()

Selects the grid tiem.

C#
public virtual void Select()

Updates a packed Boolean state and notifies listeners when its value changes.

C#
protected virtual bool SetBooleanProperty(string propertyName, int propertyKey, bool value)
Parameters:propertyNamestring

The property name reported by PropertyChanged.

propertyKeyint

The BitVector32 mask identifying the state bit.

valuebool

The new state value.

Returns:

bool

true if the state changed; otherwise, false.

Allows PropertyChanged notifications to be temporary suspended.

C#
public void SuspendPropertyNotifications()

Forwards a visual update to the owning table unless property notifications are suspended.

C#
protected virtual void Update(PropertyGridTableElement.UpdateActions updateAction)
Parameters:updateActionPropertyGridTableElement.UpdateActions

The kind of table update to perform.

Events

Occurs when this item's property state changes; notifications are suppressed while SuspendPropertyNotifications() is active.

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged