HierarchyRenameEventArgs Class

 

Provides data for the HierarchyInfo.OnRenaming and HierarchyInfo.OnRenamed methods. This class cannot be inherited.

Namespace:   Microsoft.Web.Management.Client
Assembly:  Microsoft.Web.Management (in Microsoft.Web.Management.dll)

System.Object
  System.EventArgs
    Microsoft.Web.Management.Client.HierarchyRenameEventArgs

[SecurityPermissionAttribute(SecurityAction.Demand, Flags = SecurityPermissionFlag.UnmanagedCode)]
public sealed class HierarchyRenameEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodHierarchyRenameEventArgs(String)

Initializes a new instance of the HierarchyRenameEventArgs class.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether the rename operation has been canceled.

System_CAPS_pubpropertyLabel

Gets or sets the new node name that is associated with the page.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

To rename a page, you must set the HierarchyInfo.SupportsRename property to true.

The HierarchyInfo.OnRenaming method is called when the user starts editing the text of the node. The HierarchyInfo.OnRenamed method is called after the user completes editing the text of the node. A HierarchyRenameEventArgs object specifies the label to change and whether the edit operation has been canceled.

The following example implements the HierarchyInfo.SupportsRename property, the HierarchyInfo.OnRenamed method, and the HierarchyInfo.OnRenaming method, which implements the T:System.Web.Management.Client.HierarchyRenameEventArgs class. This example enables the user to use the Label property to modify the name of the node.

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

Return to top
Show: