Class PropertyDefinition

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

Inheritance
System.Object
PropertyDefinition
LookupPropertyDefinition
Namespace: Telerik.Windows.Controls.Data.PropertyGrid
Assembly: Telerik.Windows.Controls.Data.dll

Syntax

public class PropertyDefinition : DependencyObject, INotifyPropertyChanged, ITypeDescriptorContext, IServiceProvider

Constructors

PropertyDefinition()

Initializes a new instance of the PropertyDefinition class.

Declaration
public PropertyDefinition()

PropertyDefinition(ItemPropertyInfo)

Initializes a new instance of the PropertyDefinition class.

Declaration
public PropertyDefinition(ItemPropertyInfo propertyInfo)
Parameters
ItemPropertyInfo propertyInfo

Fields

DescriptionProperty

Represents the Description dependency property.

Declaration
public static readonly DependencyProperty DescriptionProperty
Field Value
System.Windows.DependencyProperty

DisplayNameProperty

Represents the DisplayName dependency property.

Declaration
public static readonly DependencyProperty DisplayNameProperty
Field Value
System.Windows.DependencyProperty

EditorTemplateProperty

Represents the EditorTemplate dependency property.

Declaration
public static readonly DependencyProperty EditorTemplateProperty
Field Value
System.Windows.DependencyProperty

GroupNameProperty

Represents the GroupName dependency property.

Declaration
public static readonly DependencyProperty GroupNameProperty
Field Value
System.Windows.DependencyProperty

IsCurrentProperty

Represents the IsCurrent dependency property.

Declaration
public static readonly DependencyProperty IsCurrentProperty
Field Value
System.Windows.DependencyProperty

IsExpandedProperty

Represents the IsExpanded dependency property.

Declaration
public static readonly DependencyProperty IsExpandedProperty
Field Value
System.Windows.DependencyProperty

IsReadOnlyProperty

Represents the IsReadOnly dependency property.

Declaration
public static readonly DependencyProperty IsReadOnlyProperty
Field Value
System.Windows.DependencyProperty

IsSelectedProperty

Represents the IsSelected dependency property.

Declaration
public static readonly DependencyProperty IsSelectedProperty
Field Value
System.Windows.DependencyProperty

LabelStyleProperty

Represents the LabelStyle dependency property.

Declaration
public static readonly DependencyProperty LabelStyleProperty
Field Value
System.Windows.DependencyProperty

OrderIndexProperty

Represents the OrderIndex dependency property.

Declaration
public static readonly DependencyProperty OrderIndexProperty
Field Value
System.Windows.DependencyProperty

VisibilityProperty

Represents the Visibility dependency property.

Declaration
public static readonly DependencyProperty VisibilityProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoGeneratedPath

Gets the auto generated path.

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

Binding

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

Declaration
public BindingBase Binding { get; set; }
Property Value
System.Windows.Data.BindingBase

The data member binding.

Container

Gets the container representing this TypeDescriptor request.

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

Description

Gets or sets the description of a property.

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

DisplayName

Gets or sets the DisplayName.

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

EditorTemplate

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

Declaration
public DataTemplate EditorTemplate { get; set; }
Property Value
System.Windows.DataTemplate

GroupName

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

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

HasNestedProperties

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

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

Instance

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

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

IsCurrent

Gets the current state of a property definition.

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

IsExpanded

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

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

The is expanded.

IsFiltered

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

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

true if this instance is filtered; otherwise, false.

IsReadOnly

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

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

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

IsReadOnlyComposite

Gets a value indicating whether PropertyDefinition is read-only.

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

The is read only composite.

IsSelected

Gets or sets the selected state of a property definition.

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

LabelStyle

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

Declaration
public Style LabelStyle { get; set; }
Property Value
System.Windows.Style

NestedProperties

Gets or sets the collection of nested properties.

Declaration
public PropertyDefinitionCollection NestedProperties { get; }
Property Value
PropertyDefinitionCollection

OrderIndex

Gets or sets an index that describes PropertyDefinitions display order.

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

The index of the order.

ParentProperty

Gets or sets the parent property of this property definition.

Declaration
public PropertyDefinition ParentProperty { get; set; }
Property Value
PropertyDefinition

PropertyDescriptor

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

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

SearchString

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

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

SourceProperty

Gets the property's ItemPropertyInfo.

Declaration
public ItemPropertyInfo SourceProperty { get; }
Property Value
ItemPropertyInfo

Value

Gets or sets the value.

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

The value.

Visibility

Gets or sets the visibility.

Declaration
public Visibility Visibility { get; set; }
Property Value
System.Windows.Visibility

The visibility.

Methods

GetService(Type)

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

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

Returns
System.Object

OnComponentChanged()

Raises the ComponentChanged event.

Declaration
public void OnComponentChanged()

OnComponentChanging()

Raises the ComponentChanging event.

Declaration
public bool OnComponentChanging()
Returns
System.Boolean

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

OnDescriptionChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the Description property is changed.

Declaration
protected static void OnDescriptionChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnEditorTemplateChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the EditorTemplate property is changed.

Declaration
protected static void OnEditorTemplateChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnGroupNamePropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the GroupName property is changed.

Declaration
protected static void OnGroupNamePropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnIsExpandedPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the IsExpanded property gets its value changed.

Declaration
protected static void OnIsExpandedPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnIsReadOnlyPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the IsReadOnly DependencyProperty gets changed.

Declaration
protected static void OnIsReadOnlyPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnOrderIndexChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the OrderIndex property is changed.

Declaration
protected static void OnOrderIndexChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

OnPropertyChanged(String)

Called when a property value gets changed.

Declaration
protected void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

Name of the property.

OnVisibilityPropertyChanged(DependencyObject, DependencyPropertyChangedEventArgs)

Called when the Visibility property is changed.

Declaration
protected static void OnVisibilityPropertyChanged(DependencyObject sender, DependencyPropertyChangedEventArgs args)
Parameters
System.Windows.DependencyObject sender

The sender.
System.Windows.DependencyPropertyChangedEventArgs args

The System.Windows.DependencyPropertyChangedEventArgs instance containing the event data.

Events

PropertyChanged

Occurs when a property value changes.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
System.ComponentModel.PropertyChangedEventHandler

Extension Methods