Class
PropertyDefinition

Contains information about a property. Used for declarative definition of item properties displayed by RadPropertyGrid.

Definition

Namespace:Telerik.Windows.Controls.Data.PropertyGrid

Assembly:Telerik.Windows.Controls.Data.dll

Syntax:

cs-api-definition
public class PropertyDefinition : DependencyObject, INotifyPropertyChanged, ITypeDescriptorContext, IServiceProvider

Inheritance: objectPropertyDefinition

Derived Classes: LookupPropertyDefinition

Implements: INotifyPropertyChangedIServiceProviderITypeDescriptorContext

Constructors

PropertyDefinition()

Initializes a new instance of the PropertyDefinition class.

Declaration

cs-api-definition
public PropertyDefinition()

PropertyDefinition(ItemPropertyInfo)

Initializes a new instance of the PropertyDefinition class.

Declaration

cs-api-definition
public PropertyDefinition(ItemPropertyInfo propertyInfo)

Parameters

propertyInfo

ItemPropertyInfo

Fields

DescriptionProperty

Represents the Description dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DescriptionProperty

Field Value

DependencyProperty

DisplayNameProperty

Represents the DisplayName dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty DisplayNameProperty

Field Value

DependencyProperty

EditorTemplateProperty

Represents the EditorTemplate dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty EditorTemplateProperty

Field Value

DependencyProperty

GroupNameProperty

Represents the GroupName dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty GroupNameProperty

Field Value

DependencyProperty

IsCurrentProperty

Represents the IsCurrent dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsCurrentProperty

Field Value

DependencyProperty

IsExpandedProperty

Represents the IsExpanded dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsExpandedProperty

Field Value

DependencyProperty

IsReadOnlyProperty

Represents the IsReadOnly dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsReadOnlyProperty

Field Value

DependencyProperty

IsSelectedProperty

Represents the IsSelected dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IsSelectedProperty

Field Value

DependencyProperty

LabelStyleProperty

Represents the LabelStyle dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty LabelStyleProperty

Field Value

DependencyProperty

OrderIndexProperty

Represents the OrderIndex dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty OrderIndexProperty

Field Value

DependencyProperty

VisibilityProperty

Represents the Visibility dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty VisibilityProperty

Field Value

DependencyProperty

Properties

AutoGeneratedPath

Gets the auto generated path.

Declaration

cs-api-definition
public string AutoGeneratedPath { get; }

Property Value

string

Binding

Gets or sets the binding which points to the data member to display/edit in the field.

Declaration

cs-api-definition
public BindingBase Binding { get; set; }

Property Value

BindingBase

The data member binding.

Container

Gets the container representing this TypeDescriptor request.

Declaration

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

Property Value

IContainer

Implements ITypeDescriptorContext.Container

Description

Gets or sets the description of a property.

Declaration

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

Property Value

string

DisplayName

Gets or sets the DisplayName.

Declaration

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

Property Value

string

EditorTemplate

Gets or sets a dataTemplate for the editor of the property. If left unset, a default editor will be generated.

Declaration

cs-api-definition
public DataTemplate EditorTemplate { get; set; }

Property Value

DataTemplate

GroupName

Gets or sets the group name used to organize properties in categories.

Declaration

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

Property Value

string

HasNestedProperties

Gets or sets a value indicating whether this property definition has nested property definitions.

Declaration

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

Property Value

bool

Instance

Gets the object that is connected with this type descriptor request.

Declaration

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

Property Value

object

Implements ITypeDescriptorContext.Instance

IsCurrent

Gets the current state of a property definition.

Declaration

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

Property Value

bool

IsExpanded

Gets or sets a value that indicates whether the property definition is expanded.

Declaration

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

Property Value

bool

The is expanded.

IsFiltered

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

Declaration

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

Property Value

bool

true if this instance is filtered; otherwise, false.

IsReadOnly

Gets or sets a value indicating whether this instance is read only.

Declaration

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

Property Value

bool

true if this instance is read only; otherwise, false.

IsReadOnlyComposite

Gets a value indicating whether PropertyDefinition is read-only.

Declaration

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

Property Value

bool

The is read only composite.

IsSelected

Gets or sets the selected state of a property definition.

Declaration

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

Property Value

bool

LabelStyle

Get or set a Style targeting TextBlock is applied to the TextBlock label of the PropertyGridField.

Declaration

cs-api-definition
public Style LabelStyle { get; set; }

Property Value

Style

NestedProperties

Gets or sets the collection of nested properties.

Declaration

cs-api-definition
public PropertyDefinitionCollection NestedProperties { get; }

Property Value

PropertyDefinitionCollection

OrderIndex

Gets or sets an index that describes PropertyDefinitions display order.

Declaration

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

Property Value

int

The index of the order.

ParentProperty

Gets or sets the parent property of this property definition.

Declaration

cs-api-definition
public PropertyDefinition ParentProperty { get; set; }

Property Value

PropertyDefinition

PropertyDescriptor

Gets the PropertyDescriptor that is associated with the given context item.

Declaration

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

Property Value

PropertyDescriptor

Implements ITypeDescriptorContext.PropertyDescriptor

SearchString

Gets the string used to filter properties with the search-as-you-type box.

Declaration

cs-api-definition
public string SearchString { get; }

Property Value

string

SourceProperty

Gets the property's ItemPropertyInfo.

Declaration

cs-api-definition
public ItemPropertyInfo SourceProperty { get; }

Property Value

ItemPropertyInfo

Value

Gets or sets the value.

Declaration

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

Property Value

object

The value.

Visibility

Gets or sets the visibility.

Declaration

cs-api-definition
public Visibility Visibility { get; set; }

Property Value

Visibility

The visibility.

Methods

GetService(Type)

Gets the service object of the specified type(Inherited from IServiceProvider).

Declaration

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

Parameters

serviceType

Type

Returns

object

Implements IServiceProvider.GetService(Type)

OnComponentChanged()

Raises the ComponentChanged event.

Declaration

cs-api-definition
public void OnComponentChanged()

Implements ITypeDescriptorContext.OnComponentChanged()

OnComponentChanging()

Raises the ComponentChanging event.

Declaration

cs-api-definition
public bool OnComponentChanging()

Returns

bool

true if this object can be changed; otherwise, false.

Implements ITypeDescriptorContext.OnComponentChanging()

OnDescriptionChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the Description property is changed.

Declaration

cs-api-definition
protected static void OnDescriptionChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnEditorTemplateChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the EditorTemplate property is changed.

Declaration

cs-api-definition
protected static void OnEditorTemplateChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnGroupNamePropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the GroupName property is changed.

Declaration

cs-api-definition
protected static void OnGroupNamePropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnIsExpandedPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the IsExpanded property gets its value changed.

Declaration

cs-api-definition
protected static void OnIsExpandedPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnIsReadOnlyPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the IsReadOnly DependencyProperty gets changed.

Declaration

cs-api-definition
protected static void OnIsReadOnlyPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnOrderIndexChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the OrderIndex property is changed.

Declaration

cs-api-definition
protected static void OnOrderIndexChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

OnPropertyChanged(string)

Called when a property value gets changed.

Declaration

cs-api-definition
protected void OnPropertyChanged(string propertyName)

Parameters

propertyName

string

Name of the property.

OnVisibilityPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the Visibility property is changed.

Declaration

cs-api-definition
protected static void OnVisibilityPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)

Parameters

sender

DependencyObject

The sender.

args

DependencyPropertyChangedEventArgs

The DependencyPropertyChangedEventArgs instance containing the event data.

Events

PropertyChanged

Occurs when a property value changes.

Declaration

cs-api-definition
public event PropertyChangedEventHandler PropertyChanged

Event Value

PropertyChangedEventHandler

Implements INotifyPropertyChanged.PropertyChanged