DockPanelOptions.AllowDockTop Property

Gets or sets whether the dock panel can be docked to the top edge of a form (or user control).

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v19.2.dll

Declaration

C#

[DefaultValue(true)]
[XtraSerializableProperty]
public virtual bool AllowDockTop { get; set; }

VB.NET

<DefaultValue(True)>
<XtraSerializableProperty>
Public Overridable Property AllowDockTop As Boolean

Property Value

Type	Default	Description
Boolean	**true**	true if the current panel can be docked to the top edge of a form; otherwise, false

Property Paths

You can access this nested property as listed below:

Show 14 property paths

Library	Object Type	Path to AllowDockTop
WinForms Controls	FieldListDockPanel	.Options.AllowDockTop
	ReportExplorerDockPanel	.Options.AllowDockTop
	DockPanel	.Options.AllowDockTop
	PanAndZoomDockPanel	.Options.AllowDockTop
Reporting	DesignDockPanel	.Options.AllowDockTop
	ErrorListDockPanel	.Options.AllowDockTop
	FieldListDockPanel	.Options.AllowDockTop
	GroupAndSortDockPanel	.Options.AllowDockTop
	PropertyGridDockPanel	.Options.AllowDockTop
	ReportExplorerDockPanel	.Options.AllowDockTop
	ReportGalleryDockPanel	.Options.AllowDockTop
	ToolBoxDockPanel	.Options.AllowDockTop
	TreeViewDesignDockPanel	.Options.AllowDockTop
	TypedDesignDockPanel	.Options.AllowDockTop

Remarks

This property cannot be changed if the panel is currently docked to the top edge of a form (user control).

Even if the AllowDockTop property is set to false the panel can still be docked to another panel which is docked to the top edge of the form. Handle the DockManager.Docking event to control docking operations on panels.

Use the DockPanel.Dock property to determine which edge of a dock control the current panel is docked to or if the panel is floated.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AllowDockTop property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-hide-particular-dock-zones-for-dock-panels-while-dragging-them-e3732/CS/WindowsApplication3/MyDockManager.cs#L45

    SetBoundsVisibility(GetFrame(VisualizerFormType.Right), this.viewInfoCore[VisualizerFormType.Right]);
if (panel.Options.AllowDockTop)
    SetBoundsVisibility(GetFrame(VisualizerFormType.Top), this.viewInfoCore[VisualizerFormType.Top]);

VB.NET

how-to-hide-particular-dock-zones-for-dock-panels-while-dragging-them-e3732/VB/WindowsApplication3/MyDockManager.vb#L53

End If
If panel.Options.AllowDockTop Then
    SetBoundsVisibility(GetFrame(VisualizerFormType.Top), Me.viewInfoCore(VisualizerFormType.Top))