BaseView.ShowingDockGuides Event

Allows you to hide dock guides and hints that appear when a user drags a Document or a DockPanel.

Namespace: DevExpress.XtraBars.Docking2010.Views

Assembly: DevExpress.XtraBars.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public event ShowingDockGuidesEventHandler ShowingDockGuides

VB.NET

Public Event ShowingDockGuides As ShowingDockGuidesEventHandler

Event Data

The ShowingDockGuides event's data class is DevExpress.XtraBars.Docking2010.Views.ShowingDockGuidesEventArgs.

Remarks

The figure below illustrates all hints displayed when a user drags a panel.

When a user drags a Document, only 5 central hints appear (hints #1, 2, 3, 4 and 5) since unlike panels, Documents cannot be docked anywhere but the DocumentManager.

All hints are stored inside guides. The are 5 global guides - a central guide that stores hints 1 to 9 (1 to 5 if a user drags a Document), and four side guides that store hints 10, 11, 12 and 13.

The ShowingDockGuidesEventArgs arguments class provides the Configuration property that exposes various public methods. These methods allow you to hide individual hints or guides that include multiple dock hints.

Dock hint 1

C#

e.Configuration.Disable(DockHint.Center);

VB.NET

e.Configuration.Disable(DockHint.Center)

Dock hints 2, 3, 4 and 5

C#

e.Configuration.Disable(DockHint.CenterLeft); //hint #2
e.Configuration.Disable(DockHint.CenterTop); //hint #3
e.Configuration.Disable(DockHint.CenterRight); //hint #4
e.Configuration.Disable(DockHint.CenterBottom); //hint #5

VB.NET

e.Configuration.Disable(DockHint.CenterLeft) 'hint #2
e.Configuration.Disable(DockHint.CenterTop) 'hint #3
e.Configuration.Disable(DockHint.CenterRight) 'hint #4
e.Configuration.Disable(DockHint.CenterBottom) 'hint #5

Dock hints 6, 7, 8 and 9

C#

e.Configuration.Disable(DockHint.CenterSideLeft); //hint #6
e.Configuration.Disable(DockHint.CenterSideTop); //hint #7
e.Configuration.Disable(DockHint.CenterSideRight); //hint #8
e.Configuration.Disable(DockHint.CenterSideBottom); //hint #9

VB.NET

e.Configuration.Disable(DockHint.CenterSideLeft) 'hint #6
e.Configuration.Disable(DockHint.CenterSideTop) 'hint #7
e.Configuration.Disable(DockHint.CenterSideRight) 'hint #8
e.Configuration.Disable(DockHint.CenterSideBottom) 'hint #9

Dock hints 10, 11, 12 and 13

C#

e.Configuration.Disable(DockHint.SideLeft); //hint #10
e.Configuration.Disable(DockHint.SideTop); //hint #11
e.Configuration.Disable(DockHint.SideRight); //hint #12
e.Configuration.Disable(DockHint.SideBottom); //hint #13

VB.NET

e.Configuration.Disable(DockHint.SideLeft) 'hint #10
e.Configuration.Disable(DockHint.SideTop) 'hint #11
e.Configuration.Disable(DockHint.SideRight) 'hint #12
e.Configuration.Disable(DockHint.SideBottom) 'hint #13

All outer side hints for panels (hints 6 to 13)

C#

e.Configuration.DisableSideHints();

VB.NET

e.Configuration.DisableSideHints()

Central guide for Documents only (includes hints 1 to 5)

C#

e.Configuration.Disable(DockGuide.Center);

VB.NET

e.Configuration.Disable(DockGuide.Center)

Central guide for panels only (includes hints 1 to 9)

C#

e.Configuration.Disable(DockGuide.CenterDock);

VB.NET

e.Configuration.Disable(DockGuide.CenterDock)

Side guides for panels (includes hints 10 to 13)

C#

e.Configuration.DisableSideGuides();

VB.NET

e.Configuration.DisableSideGuides()

Snap guides

These guides appear when you drag a Document or a panel to the edge of a screen.

C#

e.Configuration.Disable(DockGuide.SnapLeft);
e.Configuration.Disable(DockGuide.SnapTop);
e.Configuration.Disable(DockGuide.SnapRight);
e.Configuration.Disable(DockGuide.SnapBottom);
//or
e.Configuration.DisableSnapGuides();

VB.NET

e.Configuration.Disable(DockGuide.SnapLeft)
e.Configuration.Disable(DockGuide.SnapTop)
e.Configuration.Disable(DockGuide.SnapRight)
e.Configuration.Disable(DockGuide.SnapBottom)
'or
e.Configuration.DisableSnapGuides()