DockLayoutManager.Rename(BaseLayoutItem) Method

Starts item renaming.

Namespace: DevExpress.Xpf.Docking

Assembly: DevExpress.Xpf.Docking.v24.1.dll

NuGet Package: DevExpress.Wpf.Docking

Declaration

C#

public bool Rename(
    BaseLayoutItem item
)

VB.NET

Public Function Rename(
    item As BaseLayoutItem
) As Boolean

Parameters

Name	Type	Description
item	BaseLayoutItem	A BaseLayoutItem to be renamed.

Returns

Type	Description
Boolean	true if item renaming has been initiated; otherwise, false.

Remarks

The Rename method opens a text box allowing an end-user to rename the specified item’s caption. The method is in effect if item renaming is enabled. See the DockLayoutManager.AllowLayoutItemRename and DockLayoutManager.AllowDockItemRename options.

It’s possible to prevent a specific item from being renamed via the BaseLayoutItem.AllowRename property.