Export (0) Print
Expand All

ComponentChangingEventArgs Class

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

System::Object
  System::EventArgs
    System.ComponentModel.Design::ComponentChangingEventArgs

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

[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction::LinkDemand, Name = L"FullTrust")]
[HostProtectionAttribute(SecurityAction::LinkDemand, SharedState = true)]
public ref class ComponentChangingEventArgs sealed : public EventArgs

The ComponentChangingEventArgs type exposes the following members.

  NameDescription
Public methodComponentChangingEventArgsInitializes a new instance of the ComponentChangingEventArgs class.
Top

  NameDescription
Public propertyComponentGets 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.
Public propertyMemberGets the member that is about to be changed.
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

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.

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 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 );
   }

.NET Framework

Supported in: 4.6, 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