Class DescriptorBasePropertyDescriptor

A custom PropertyDescriptor that adds design-time support for descriptor collections in the grouping engine. DescriptorBasePropertyDescriptor objects help with adding support for expanding a collection similar to an expandable object in a property grid.

Inheritance

System.Object

DescriptorBasePropertyDescriptor

Namespace: Syncfusion.Grouping

Assembly: Syncfusion.Grouping.Base.dll

Syntax

public class DescriptorBasePropertyDescriptor : PropertyDescriptor

Constructors

DescriptorBasePropertyDescriptor(String, DescriptorBase, Attribute[], Type)

Initializes a new instance for DescriptorBasePropertyDescriptor class.

Declaration

public DescriptorBasePropertyDescriptor(string name, DescriptorBase columnDescriptor, Attribute[] attributes, Type componentType)

Parameters

Type	Name	Description
System.String	name	The name of the property.
DescriptorBase	columnDescriptor	The descriptor element.
System.Attribute[]	attributes	Property attributes (passed through to PropertyDescriptor constructor).
System.Type	componentType	The component type (passed through to PropertyDescriptor constructor).

Properties

ComponentType

Retrieves the type of the component this PropertyDescriptor is bound to.

Declaration

public override Type ComponentType { get; }

Property Value

Type	Description
System.Type	The type of component.

DisplayName

Gets the display name of the property. This is the name that will be displayed in a property browser. This will be the same as the property name for most properties.

Declaration

public override string DisplayName { get; }

Property Value

Type	Description
System.String	A string containing the name to display in the property browser. System.ComponentModel.PropertyDescriptor

IsReadOnly

Gets if the property can be written to.

Declaration

public override bool IsReadOnly { get; }

Property Value

Type	Description
System.Boolean	True if the property can be written to. System.ComponentModel.PropertyDescriptor

PropertyType

Gets the data type of the property.

Declaration

public override Type PropertyType { get; }

Property Value

Type	Description
System.Type	A class representing the data type of the property. System.ComponentModel.PropertyDescriptor

Methods

CanResetValue(Object)

Determines if the the component will allow its value to be reset.

Declaration

public override bool CanResetValue(object comp)

Parameters

Type	Name	Description
System.Object	comp	The component to reset.

Returns

Type	Description
System.Boolean	True if the component supports resetting its value. System.ComponentModel.PropertyDescriptor

GetValue(Object)

Retrieves the value of the property for the given component. This will throw an exception if the component does not have this property.

Declaration

public override object GetValue(object comp)

Parameters

Type	Name	Description
System.Object	comp	The component.

Returns

Type	Description
System.Object	The value of the property on comp. This can be cast to the property type. System.ComponentModel.PropertyDescriptor

ResetValue(Object)

Resets the value of this property on comp to the default value.

Declaration

public override void ResetValue(object comp)

Parameters

Type	Name	Description
System.Object	comp	The component whose property is to be reset.

See Also

System.ComponentModel.PropertyDescriptor

SetValue(Object, Object)

Sets the value of this property on the given component.

Declaration

public override void SetValue(object comp, object value)

Parameters

Type	Name	Description
System.Object	comp	The component whose property is to be set.
System.Object	value	The new value of the property.

See Also

System.ComponentModel.PropertyDescriptor

ShouldSerializeValue(Object)

Determines if this property should be persisted. A property is to be persisted if it is marked as persist able through a PersistableAttribute and if the property contains something other than the default value. Note, however, that this method will return True for design-time properties as well, so callers should also check to see if a property is design-time only before persisting to run-time storage.

Declaration

public override bool ShouldSerializeValue(object comp)

Parameters

Type	Name	Description
System.Object	comp	The component on which the property resides.

Returns

Type	Description
System.Boolean	True if the property should be persisted to either design-time or run-time storage.