BaseDockOptions.ShowCloseButton Property

Gets or sets whether the close button is displayed within a dock panel’s caption.

Namespace: DevExpress.XtraBars.Docking

Assembly: DevExpress.XtraBars.v18.2.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Boolean	**true**	true to show the close button within the caption of a dock panel; otherwise false.

Property Paths

You can access this nested property as listed below:

Show 17 property paths

Library	Object Type	Path to ShowCloseButton
WinForms Controls	SnapDockManager	.DockingOptions.ShowCloseButton
	FieldListDockPanel	.Options.ShowCloseButton
	ReportExplorerDockPanel	.Options.ShowCloseButton
	DockManager	.DockingOptions.ShowCloseButton
	DockPanel	.Options.ShowCloseButton
	PanAndZoomDockPanel	.Options.ShowCloseButton
Reporting	DesignDockPanel	.Options.ShowCloseButton
	ErrorListDockPanel	.Options.ShowCloseButton
	FieldListDockPanel	.Options.ShowCloseButton
	GroupAndSortDockPanel	.Options.ShowCloseButton
	PropertyGridDockPanel	.Options.ShowCloseButton
	ReportExplorerDockPanel	.Options.ShowCloseButton
	ReportGalleryDockPanel	.Options.ShowCloseButton
	ToolBoxDockPanel	.Options.ShowCloseButton
	TreeViewDesignDockPanel	.Options.ShowCloseButton
	TypedDesignDockPanel	.Options.ShowCloseButton
	XRDesignDockManager	.DockingOptions.ShowCloseButton

Remarks

Set the ShowCloseButton property to false to prevent a dock panel from being closed by an end-user using the “Close” button.

For more information on caption buttons, see the Header Buttons document.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowCloseButton 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-close-button-of-the-panel-container-depending-on-the-selected-dockpanel-e1437/CS/Q205085/Form1.cs#L29

private static void AdjustCloseButtonVisibility(DockPanel panel) {
    panel.Options.ShowCloseButton = panel.ActiveChild.Options.ShowCloseButton;
}

how-to-prevent-a-dockpanel-from-being-closed-e1105/CS/WindowsFormsApplication1/Form1.cs#L21

{
    dockPanel1.Options.ShowCloseButton = false;
}

XAF_how-to-access-the-navigation-dock-panel-in-a-winforms-application-t275956/CS/Solution43.Module.Win/Controllers/HideNavigationPanelButtonsController.cs#L22

    navigationPanel.Options.ShowAutoHideButton = false;
    navigationPanel.Options.ShowCloseButton = false;
}

VB.NET

how-to-hide-close-button-of-the-panel-container-depending-on-the-selected-dockpanel-e1437/VB/Q205085/Form1.vb#L31

Private Shared Sub AdjustCloseButtonVisibility(ByVal panel As DockPanel)
    panel.Options.ShowCloseButton = panel.ActiveChild.Options.ShowCloseButton
End Sub

how-to-prevent-a-dockpanel-from-being-closed-e1105/VB/WindowsFormsApplication1/Form1.vb#L19

Private Sub Form1_Load(ByVal sender As Object, ByVal e As EventArgs) Handles MyBase.Load
    dockPanel1.Options.ShowCloseButton = False
End Sub

XAF_how-to-access-the-navigation-dock-panel-in-a-winforms-application-t275956/VB/Solution43.Module.Win/Controllers/HideNavigationPanelButtonsController.vb#L24

    navigationPanel.Options.ShowAutoHideButton = False
    navigationPanel.Options.ShowCloseButton = False
End If