DockControllerBase.CreateCommand<T>(BaseLayoutItem) Method

Creates the specified dock command for the specified item/pane.

Namespace: DevExpress.Xpf.Docking

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

NuGet Package: DevExpress.Wpf.Docking

Declaration

C#

public T CreateCommand<T>(
    BaseLayoutItem item
)
    where T : DockControllerCommand, new()

VB.NET

Public Function CreateCommand(Of T As {DockControllerCommand, New})(
    item As BaseLayoutItem
) As T

Parameters

Name	Type	Description
item	BaseLayoutItem	A BaseLayoutItem descendant with which the created command is associated.

Type Parameters

Name
T

Returns

Type	Description
T	The created command.

Remarks

There exist several dock commands provided by the DXDocking library supporting the dock functionality. You can bind commands to buttons. As a result, clicking the button will invoke the corresponding dock functionality. The following are the available dock commands, declared in the DevExpress.Xpf.Docking namespace:

• ActivateCommand - Activates a panel. The method equivalent to this command is DockControllerBase.Activate.
• CloseCommand - Closes (hides) a panel. The method equivalent to this command is DockControllerBase.Close.
• DockCommand - Docks a panel to the root panel. The method equivalent to this command is DockControllerBase.Dock.
• FloatCommand - Makes the panel floating. The method equivalent to this command is DockControllerBase.Float.
• HideCommand - Enables the auto-hide feature for the panel. The method equivalent to this command is DockControllerBase.Hide.
• RestoreCommand - Restores a panel from the closed (hidden) state, making it visible. The method equivalent to this command is DockControllerBase.Restore.

C#

buttonUndo.Command = DockLayoutManager1.DockController.CreateCommand
    <DevExpress.Xpf.Docking.ActivateCommand>(paneMessages);

For more information on commands, see the Commanding Overview topic in MSDN.

Implements

CreateCommand<T>(BaseLayoutItem)