RadObject
Serves as the foundational base class for all objects in the Telerik Presentation Framework, implementing a sophisticated dependency property system inspired by WPF's property model. RadObject provides the core infrastructure for the TPF property system with multi-layered property values, automatic change notifications, and property inheritance. The system supports multiple value sources with precedence: Local Values (highest), Style Values, Inherited Values, and Default Values. Implements INotifyPropertyChanged with enhanced RadPropertyChanged events providing detailed change information. Through ICustomTypeDescriptor, it provides custom type information for designer support and property serialization. The property system includes comprehensive APIs (GetValue, SetValue, ResetValue, ClearValue) with priority-based resolution, validation callbacks, and efficient storage. Extends DisposableObject for proper resource cleanup and serves as the foundation for all TPF classes.
Definition
Namespace:Telerik.WinControls
Assembly:Telerik.WinControls.dll
Syntax:
public class RadObject : DisposableObject, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptorInheritance: objectDisposableObjectRadObject
Derived Classes:
Implements:
Inherited Members
Constructors
Initializes a new instance of the RadObject class, setting up the property value collection and object type information.
public RadObject()Fields
public static RadProperty BindingContextPropertypublic static readonly RadObjectType RadTypeProperties
Gets or sets the BindingContext for this object, which provides the foundation for data binding operations and can be inherited from parent objects.
[Browsable(false)]
public virtual BindingContext BindingContext { get; set; }Gets or sets a Filter instance used to filter the property collection returned by GetProperties().
[Browsable(false)]
public Filter PropertyFilter { get; set; }Gets a collection containing property values.
public RadPropertyValueCollection PropertyValues { get; }Gets the RadObjectType associated with this object's system type, providing metadata and property registration information.
[Browsable(false)]
public RadObjectType RadObjectType { get; }Methods
Registers a style setting for this instance.
protected virtual ValueUpdateResult AddStylePropertySetting(IPropertySetting setting)Binds the specified property to a property of the provided binding source object.
public ValueUpdateResult BindProperty(RadProperty propertyToBind, RadObject sourceObject, RadProperty sourceProperty, PropertyBindingOptions options)Our property that is about to be bound.
sourceObjectRadObjectThe object to which source property belongs.
sourcePropertyRadPropertyThe property to which we will bind.
optionsPropertyBindingOptionsAdditional options, specifying the binding operation.
Returns:Determines whether the object can raise PropertyChanging and PropertyChanged notifications. Current implementation checks whether the object is disposing or is already disposed of.
protected virtual bool CanRaisePropertyChangeNotifications(RadPropertyValue propVal)Removes all references to external property modifiers such as property bindings, style settings, and animations to prepare for disposal.
protected virtual void ClearPropertyStore()Allows inheritors to force a coersion of the current calculated value for the given property.
protected virtual object CoerceValue(RadPropertyValue propVal, object baseValue)The property value.
baseValueobjectThe current caluclated value of the property.
Returns:Null if no coersion is needed.
Releases managed resources by clearing the property store and disposing value animators to prevent memory leaks.
protected override void DisposeManagedResources()Overrides:
Allows inheritors to provide custom default value.
protected virtual object GetDefaultValue(RadPropertyValue propVal, object baseDefaultValue)Searches up in the chain of InheritanceParents for a value for the specified property.
protected virtual object GetInheritedValue(RadProperty property)The property to examine.
Returns:Gets the RadPropertyValue structure that contains information about the specified property's effective value for this instance, including value source and composition details.
public RadPropertyValue GetPropertyValue(RadProperty property)The RadProperty for which to retrieve the property value information.
Returns:The RadPropertyValue structure, or null if no effective value is recorded.
Gets the registered RadProperty with the specified name for this object's type, enabling dynamic property access by name.
public RadProperty GetRegisteredRadProperty(string propertyName)The name of the property to retrieve.
Returns:The RadProperty with the specified name, or null if no such property is registered.
Retrieves the current effective value for the specified RadProperty, resolving through the property value composition hierarchy.
public virtual object GetValue(RadProperty property)The RadProperty for which to retrieve the current value.
Returns:The current effective value of the property, which may come from local, style, inherited, or default value sources.
Gets the ValueSource that currently provides the effective value for the specified property (Local, Style, Inherited, or Default).
public ValueSource GetValueSource(RadProperty property)The RadProperty for which to determine the value source.
Returns:A ValueSource indicating which source is providing the current effective value.
Determines whether the specified property may be canceled.
protected virtual bool IsPropertyCancelable(RadPropertyMetadata metadata)The metadata associated with the property change.
Returns:Raises the standard .NET PropertyChanged event to notify subscribers of property value changes using the provided event arguments.
protected virtual void OnNotifyPropertyChanged(PropertyChangedEventArgs e)The PropertyChangedEventArgs containing the property change information.
Raises the standard .NET PropertyChanged event with the specified property name to notify subscribers of property value changes.
protected virtual void OnNotifyPropertyChanged(string propertyName)The name of the property that changed.
Raises the RadPropertyChanged event and the standard .NET PropertyChanged event to notify subscribers of property value changes.
protected virtual void OnPropertyChanged(RadPropertyChangedEventArgs e)The RadPropertyChangedEventArgs containing information about the property change.
Raises the RadPropertyChanging event, allowing subscribers to be notified before a property value changes and potentially cancel the change.
protected virtual void OnPropertyChanging(RadPropertyChangingEventArgs args)The RadPropertyChangingEventArgs containing information about the property change.
protected virtual void OnShouldSerializeProperty(ShouldSerializePropertyEventArgs args)Replaces the default property descriptors of object properties to perform RadObject-specific tasks like checking ShouldSerialize and RadProperty default values.
protected virtual PropertyDescriptorCollection ReplaceDefaultDescriptors(PropertyDescriptorCollection props)The original PropertyDescriptorCollection to replace.
Returns:A new PropertyDescriptorCollection with custom RadObject-aware property descriptors.
Resets only the local value of the specified property while preserving other value sources like styles, inheritance, and default values.
public virtual ValueUpdateResult ResetLocalValue(RadProperty property)The RadProperty for which to reset only the local value.
Returns:A ValueUpdateResult indicating the result of the operation.
Resets the current value of the specified property using the provided flags.
public ValueUpdateResult ResetValue(RadProperty property, ValueResetFlags flags)The RadProperty that should be reset.
flagsValueResetFlagsAdditional flags that specify which effective modifiers should be reset.
Returns:The result of the operation.
Resets the current value of the specified property by removing all effective value modifiers (local, style, animation) and reverting to the inherited or default value.
public ValueUpdateResult ResetValue(RadProperty property)The RadProperty to reset to its default state.
Returns:A ValueUpdateResult indicating the result of the operation.
Resets the specified property value, using the provided reset flags.
protected virtual ValueUpdateResult ResetValueCore(RadPropertyValue propVal, ValueResetFlags flags)The result of the operation.
Resumes property change notifications after a previous SuspendPropertyNotifications() call, restoring normal notification behavior when the suspension count reaches zero.
public void ResumePropertyNotifications()Sets a default value override for the specified property, replacing the default value provided by the property's metadata with a custom value.
public ValueUpdateResult SetDefaultValueOverride(RadProperty property, object value)The RadProperty for which to set the default value override.
valueobjectThe value to use as the new default, overriding the metadata-defined default value.
Returns:A ValueUpdateResult indicating the result of the operation.
Sets a local value for the specified RadProperty, establishing the highest priority value in the property value composition hierarchy.
public ValueUpdateResult SetValue(RadProperty property, object value)The RadProperty for which to set the local value.
valueobjectThe value to set as the local value for the property.
Returns:A ValueUpdateResult indicating the result of the operation.
Performs the core logic of updating property value.
protected virtual ValueUpdateResult SetValueCore(RadPropertyValue propVal, object propModifier, object newValue, ValueSource source)The property value structure, holding property information.
propModifierobjectAdditional modifier, like IPropertySetting
newValueobjectThe actual new value to be set, valid for Local and DefaultValue sources.
sourceValueSourceSpecifies the source of the provided new value.
Returns:The result of the operation.
Determines whether the specified RadProperty should be serialized. Prevents theme and default values serialization.
public virtual bool ShouldSerializeProperty(RadProperty property)The RadProperty that is about to be serialized.
Returns:A value indicating whether to serialize the property value.
Temporarily suspends property change notifications to improve performance during bulk property updates. Must be paired with ResumePropertyNotifications() to restore normal notification behavior.
public void SuspendPropertyNotifications()Removes the property binding for the specified property, restoring the property to use local, style, inherited, or default values.
public ValueUpdateResult UnbindProperty(RadProperty boundProperty)The RadProperty for which to remove the binding.
Returns:A ValueUpdateResult indicating the result of the operation.
Forces re-evaluation of the current value for the specified property, triggering value composition and change notifications if the value changes.
public ValueUpdateResult UpdateValue(RadProperty property)The RadProperty for which to force value re-evaluation.
Returns:A ValueUpdateResult indicating the result of the operation.
Performs the core value update logic.
protected virtual ValueUpdateResult UpdateValueCore(RadPropertyValue propVal)The result of the operation.
Events
Occurs when a property value changes, providing standard .NET property change notification. For RadProperty changes, the system automatically raises this event. For non-RadProperty changes, developers must manually fire this event using the INotifyPropertyChanged API.
[Browsable(false)]
public event PropertyChangedEventHandler PropertyChangedImplements:
Occurs when a RadProperty value changes, providing enhanced property change information including old and new values, metadata, and value source details specific to the Telerik property system.
[Browsable(false)]
public event RadPropertyChangedEventHandler RadPropertyChangedOccurs before a RadProperty value changes, allowing cancellation of the property change operation and providing access to the proposed new value before it is applied.
[Browsable(false)]
public event RadPropertyChangingEventHandler RadPropertyChanging