Export (0) Print
Expand All

PropertyDescriptor.ResetValue Method

When overridden in a derived class, resets the value for this property of the component to the default value.

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

public abstract void ResetValue (
	Object component
)
public abstract void ResetValue (
	Object component
)
public abstract function ResetValue (
	component : Object
)
Not applicable.

Parameters

component

The component with the property value that is to be reset to the default value.

Typically, this method is implemented through reflection.

This method determines the value to reset the property to in the following order of precedence:

  1. There is a shadowed property for this property.

  2. There is a DefaultValueAttribute for this property.

  3. There is a "ResetMyProperty" method that you have implemented, where "MyProperty" is the name of the property you pass to it.

This method creates a DesignerTransaction automatically in the following order:

  1. The method calls the IDesignerHost.CreateTransaction method to create a new DesignerTransaction to represent the changes.

  2. The method calls the IComponentChangeService.OnComponentChanging method to indicate that the transaction has begun and the changes are about to occur.

  3. The method resets the property to the value determined by this method's checking order.

  4. The method calls the IComponentChangeService.OnComponentChanged method to indicate that the changes have occurred.

  5. The method calls DesignerTransaction.Commit to indicate that the transaction is completed.

The purpose of the transaction is to support Undo and Redo functionality.

Notes to Inheritors: When overridden in a derived class, this method looks for a DefaultValueAttribute. If it finds one, it sets the value of the property to the DefaultValueAttribute it found. If this method cannot find a DefaultValueAttribute, it looks for a "ResetMyProperty" method that you need to implement. If this is found, the ResetValue method invokes it. If ResetValue cannot find a DefaultValueAttribute or a "ResetMyProperty" method that you implemented, it does not perform an operation.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0

Community Additions

ADD
Show:
© 2014 Microsoft