Skip to main content
PropertyDescriptorSetValue Method
 

When overridden in a derived class, sets the value of the component to a different value.

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

public abstract void SetValue(
	object component,
	object value
)
public:
virtual void SetValue(
	Object^ component,
	Object^ value
) abstract
abstract SetValue : 
        component:Object *
        value:Object -> unit
Public MustOverride Sub SetValue (
	component As Object,
	value As Object
)

Parameters

component
Type:

The component with the property value that is to be set.

value
Type:

The new value.

Typically, this method is implemented through reflection.

This method creates a DesignerTransaction automatically in the following order:

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

  2. The method calls the IComponentChangeServiceOnComponentChanging 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 IComponentChangeServiceOnComponentChanged method to indicate that the changes have occurred.

  5. The method calls DesignerTransactionCommit to indicate that the transaction is complete.

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

Notes to Inheritors:

When you override this method, it should set the value of the property by invoking the appropriate "SetMyProperty" method that you need to implement. If the value specified is not valid, the component should throw an exception, which is passed up. You should design the property so that a "GetMyProperty" method (that you have implemented) following a "SetMyProperty" method returns the value passed in when the "SetMyProperty" method does not throw an exception.

.NET Framework
Available since 1.1
Return to top