ComponentChangedEventArgs Class

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: ComponentChangedEventArgs.cs

Source:: ComponentChangedEventArgs.cs

Source:: ComponentChangedEventArgs.cs

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.

Provides data for the ComponentChanged event. This class cannot be inherited.

public ref class ComponentChangedEventArgs sealed : EventArgs

public sealed class ComponentChangedEventArgs : EventArgs

[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ComponentChangedEventArgs : EventArgs

type ComponentChangedEventArgs = class
    inherit EventArgs

[<System.Runtime.InteropServices.ComVisible(true)>]
type ComponentChangedEventArgs = class
    inherit EventArgs

Public NotInheritable Class ComponentChangedEventArgs
Inherits EventArgs

Inheritance: Object

EventArgs
ComponentChangedEventArgs

Attributes: ComVisibleAttribute

Examples

The following example demonstrates creating a ComponentChangedEventArgs.

public:
   // This example method creates a ComponentChangedEventArgs using the specified arguments.
   // Typically, this type of event args is created by a design mode subsystem.
   ComponentChangedEventArgs^ CreateComponentChangedEventArgs( Object^ component, MemberDescriptor^ member, Object^ oldValue, Object^ newValue )
   {
      // Creates a component changed event args with the specified arguments.
      ComponentChangedEventArgs^ args = gcnew ComponentChangedEventArgs( component, member, oldValue, newValue );
      
      // The component that has changed:              args->Component
      // The member of the component that changed:    args->Member
      // The old value of the member:                 args->oldValue
      // The new value of the member:                 args->newValue
      return args;
   }

// This example method creates a ComponentChangedEventArgs using the specified arguments.
// Typically, this type of event args is created by a design mode subsystem.            
public ComponentChangedEventArgs CreateComponentChangedEventArgs(object component, MemberDescriptor member, object oldValue, object newValue)
{            
    // Creates a component changed event args with the specified arguments.
    ComponentChangedEventArgs args = new ComponentChangedEventArgs(component, member, oldValue, newValue);

    // The component that has changed:              args.Component
    // The member of the component that changed:    args.Member
    // The old value of the member:                 args.oldValue
    // The new value of the member:                 args.newValue

    return args;            
}

' This example method creates a ComponentChangedEventArgs using the specified arguments.
' Typically, this type of event args is created by a design mode subsystem.            
Public Function CreateComponentChangedEventArgs(ByVal component As Object, ByVal member As MemberDescriptor, ByVal oldValue As Object, ByVal newValue As Object) As ComponentChangedEventArgs
    ' Creates a component changed event args with the specified arguments.
    Dim args As New ComponentChangedEventArgs(component, member, oldValue, newValue)

    ' The component that has changed:              args.Component
    ' The member of the component that changed:    args.Member
    ' The old value of the member:                 args.oldValue
    ' The new value of the member:                 args.newValue
    Return args
End Function

Remarks

ComponentChangedEventArgs provides data for a ComponentChanged event. The ComponentChanged event notifies the IComponentChangeService and registered event handlers that a particular component in the currently active document has been changed.

A ComponentChangedEventArgs provides the following information:

A Component property that indicates the component that was modified.
A Member property that indicates the member that was changed.
A NewValue property that indicates the new value of the member.
An OldValue property that indicates the old value of the member.

Component designers typically raise the ComponentChanged event automatically when components are added, removed, or modified. A ComponentChanged event is not raised during form load and unload because changes at this time are expected. A component designer might raise the ComponentChanged event after it changes a property of the component; this ensures that the Properties window will display the updated property.

Notes to Inheritors

A compiler error occurs if this class is specified as the base class of another class.

Constructors

ComponentChangedEventArgs(Object, MemberDescriptor, Object, Object)

Initializes a new instance of the ComponentChangedEventArgs class.

Properties

Component	Gets the component that was modified.
Member	Gets the member that has been changed.
NewValue	Gets the new value of the changed member.
OldValue	Gets the old value of the changed member.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via