CanResetValue Method

PropertyDescriptor.CanResetValue Method (Object)

 

When overridden in a derived class, returns whether resetting an object changes its value.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

public abstract bool CanResetValue(
	object component
)

Parameters

component
Type: System.Object

The component to test for reset capability.

Return Value

Type: System.Boolean

true if resetting the component changes its value; otherwise, false.

Typically, this method is implemented through reflection.

Notes to Inheritors:

When overridden in a derived class, this method looks for a DefaultValueAttribute. If it finds one, it compares the value of the attribute with the property's current value. It returns true when the default value does not match the property's current value. If this method cannot find a DefaultValueAttribute, it looks for a "ShouldPersistMyProperty" method that you need to implement yourself. If this is found, CanResetValue returns what "ShouldPersistMyProperty" returns. Otherwise, it looks for a "ResetMyProperty" method that you need to implement yourself. If this is found, CanResetValue returns true. If it cannot find a DefaultValueAttribute, a "ShouldPersistMyProperty" method, or a "ResetMyProperty" method, then it returns false.

.NET Framework
Available since 1.1
Return to top
Show:
© 2016 Microsoft