ComponentChangingEventArgs Class

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: ComponentChangingEventArgs.cs

Source:: ComponentChangingEventArgs.cs

Source:: ComponentChangingEventArgs.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 ComponentChanging event. This class cannot be inherited.

public ref class ComponentChangingEventArgs sealed : EventArgs

public sealed class ComponentChangingEventArgs : EventArgs

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

type ComponentChangingEventArgs = class
    inherit EventArgs

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

Public NotInheritable Class ComponentChangingEventArgs
Inherits EventArgs

Inheritance: Object

EventArgs
ComponentChangingEventArgs

Attributes: ComVisibleAttribute

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 Component property that indicates the component that is about to be modified.
A Member property that indicates the member that is about to be changed.

Notes to Inheritors

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

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.

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

Deila með