ComponentChangingEventArgs
Class
Definition
Provides data for the ComponentChanging event. This class cannot be inherited.
[System.Runtime.InteropServices.ComVisible(true)]
public sealed class ComponentChangingEventArgs : EventArgs
- Inheritance
- Attributes
Inherited Members
System.EventArgs
System.Object
Examples
The following example demonstrates creating a ComponentChangingEventArgs.
public:
// This example method creates a ComponentChangingEventArgs using the specified arguments.
// Typically, this type of event args is created by a design mode subsystem.
ComponentChangingEventArgs^ CreateComponentChangingEventArgs( Object^ component, MemberDescriptor^ member )
{
// The component that is about to change: args.Component
// The member that is about to change: args.Member
return gcnew ComponentChangingEventArgs( component,member );
}
// This example method creates a ComponentChangingEventArgs using the specified arguments.
// Typically, this type of event args is created by a design mode subsystem.
public ComponentChangingEventArgs CreateComponentChangingEventArgs(object component, MemberDescriptor member)
{
ComponentChangingEventArgs args = new ComponentChangingEventArgs(component, member);
// The component that is about to change: args.Component
// The member that is about to change: args.Member
return args;
}
' This example method creates a ComponentChangingEventArgs using the specified arguments.
' Typically, this type of event args is created by a design mode subsystem.
Public Function CreateComponentChangingEventArgs(ByVal component As Object, ByVal member As MemberDescriptor) As ComponentChangingEventArgs
Dim args As New ComponentChangingEventArgs(component, member)
' The component that is about to change: args.Component
' The member that is about to change: args.Member
Return args
End Function
Remarks
ComponentChangingEventArgs provides data about a ComponentChanging event. The ComponentChanging event notifies the IComponentChangeService and registered event handlers that a particular component in the current design document is about to be changed. This event provides a widely accessible method to prevent a component from changing.
A ComponentChanging event is raised before a component is changed. This event provides an opportunity for a designer to abort the change. Component designers typically raise the ComponentChanging event automatically. If a property cannot be changed, the method that handles the event can throw an exception. For example, if a designer file is checked into source code control, the handler of this event typically throws an exception if the user refuses to check out the file.
A ComponentChangingEventArgs provides the following information:
A
Componentproperty that indicates the component that is about to be modified.A
Memberproperty that indicates the member that is about to be changed.
Constructors
| ComponentChangingEventArgs(Object, MemberDescriptor) |
Initializes a new instance of the ComponentChangingEventArgs class. |
Properties
| Component |
Gets the component that is about to be changed or the component that is the parent container of the member that is about to be changed. |
| Member |
Gets the member that is about to be changed. |