PropertyDescriptor.CanResetValue(Object) Method
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
When overridden in a derived class, returns whether resetting an object changes its value.
public:
abstract bool CanResetValue(System::Object ^ component);
public abstract bool CanResetValue(object component);
abstract member CanResetValue : obj -> bool
Public MustOverride Function CanResetValue (component As Object) As Boolean
- component
- Object
The component to test for reset capability.
true
if resetting the component changes its value; otherwise, false
.
Typically, this method is implemented through reflection.
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(Object) returns what "ShouldPersistMyProperty" returns. Otherwise, it looks for a "ResetMyProperty" method that you need to implement yourself. If this is found, CanResetValue(Object) returns true
. If it cannot find a DefaultValueAttribute, a "ShouldPersistMyProperty" method, or a "ResetMyProperty" method, then it returns false
.
Product | Versions |
---|---|
.NET | Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10 |
.NET Framework | 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1 |
.NET Standard | 2.0, 2.1 |
.NET feedback
.NET is an open source project. Select a link to provide feedback: