Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ComponentChangedEventArgs Class

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

System.Object
  System.EventArgs
    System.ComponentModel.Design.ComponentChangedEventArgs

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

'Declaration
<ComVisibleAttribute(True)> _
<PermissionSetAttribute(SecurityAction.LinkDemand, Name := "FullTrust")> _
<HostProtectionAttribute(SecurityAction.LinkDemand, SharedState := True)> _
Public NotInheritable Class ComponentChangedEventArgs _
	Inherits EventArgs

The ComponentChangedEventArgs type exposes the following members.

  NameDescription
Public methodComponentChangedEventArgsInitializes a new instance of the ComponentChangedEventArgs class.
Top

  NameDescription
Public propertyComponentGets the component that was modified.
Public propertyMemberGets the member that has been changed.
Public propertyNewValueGets the new value of the changed member.
Public propertyOldValueGets the old value of the changed member.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: SharedState. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

Notes to Inheritors

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

The following example demonstrates creating a ComponentChangedEventArgs.

' 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

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft