ComponentRenameEventArgs Class

Provides data for the ComponentRename event.

System.Object
  System.EventArgs
    System.ComponentModel.Design.ComponentRenameEventArgs

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

[ComVisibleAttribute(true)]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
[HostProtectionAttribute(SecurityAction.LinkDemand, SharedState = true)]
[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
public class ComponentRenameEventArgs : EventArgs

The ComponentRenameEventArgs type exposes the following members.

  NameDescription
Public methodComponentRenameEventArgsInitializes a new instance of the ComponentRenameEventArgs class.
Top

  NameDescription
Public propertyComponentGets the component that is being renamed.
Public propertyNewNameGets the name of the component after the rename event.
Public propertyOldNameGets the name of the component before the rename event.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

A ComponentRenameEventArgs provides data about a ComponentRename event.

A ComponentRenameEventArgs object provides the following information:

  • A Component property that references the component being renamed.

  • An OldName property that indicates the old name of the component.

  • A NewName property that indicates the new name of the component.

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.

The following example demonstrates creating a ComponentRenameEventArgs.

// This example method creates a ComponentRenameEventArgs using the specified arguments. 
// Typically, this type of event args is created by a design mode subsystem.   
public ComponentRenameEventArgs CreateComponentRenameEventArgs(object component, string oldName, string newName)
{
    ComponentRenameEventArgs args = new ComponentRenameEventArgs(component, oldName, newName);

    // The component that was renamed:          args.Component 
    // The previous name of the component:      args.OldName 
    // The new name of the component:           args.NewName             

    return args;
}

.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.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft