Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Collapse]DevExpress.Snap.Extensions
   [Collapse]SnapDockManager Class
     SnapDockManager Members
    [Expand]SnapDockManager Constructor
    [Expand]SnapDockManager Properties
    [Expand]SnapDockManager Methods
   [Expand]SnapDocumentManager Class
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Expand]DevExpress.XtraEditors.Controls
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

SnapDockManager Members

Provides dock panels for a Snap application.

Expanded Public Constructors

Show: Inherited
  Name Description
Public method SnapDockManager Overloaded. Initializes a new instance of the SnapDockManager class with default settings.
Top

Expanded Public Properties

Show: Inherited
  Name Description
Public property ActivePanel Gets or sets the active dock panel. (Inherited from DockManager)
Public property ActivePanelID Gets or sets the index of the active dock panel. (Inherited from DockManager)
Public property AllowGlyphSkinning Gets or sets whether all DockPanels within the SnapDockManager should paint their icons in the panel's foreground colors. (Inherited from DockManager)
Public property AutoHiddenPanelCaptionShowMode Gets or sets how panel captions are displayed within an auto-hide container when these panels are combined into an auto-hidden tab container. (Inherited from DockManager)
Public property AutoHiddenPanelShowMode Gets or sets whether auto-hidden panels within the current SnapDockManager are shown during mouse hover, or only during a mouse click. (Inherited from DockManager)
Public property AutoHideContainers Provides access to the auto hide containers and thus to the panels whose auto hide functionality is enabled. (Inherited from DockManager)
Public property AutoHideSpeed Gets or sets a value that specifies the auto-hide speed of dock panels. (Inherited from DockManager)
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Controller Gets or sets the BarAndDockingController that will provide the default appearance options for the dock panels belonging to the current dock manager. (Inherited from DockManager)
Public property Count Gets the total number of panels that belong to the dock manager. (Inherited from DockManager)
Public property DockController Gets an IDockController that performs docking operations on panels within the current SnapDockManager. (Inherited from DockManager)
Public property DockingOptions Provides access to the settings that affect the behavior of dock panels. (Inherited from DockManager)
Public property DockMode Gets or sets the dock style. (Inherited from DockManager)
Public property DockModeVS2005FadeFramesCount Gets or sets the number of frames in the fading animation effect that are applied when displaying dock visualizers (markers) in VS2005 dock style. (Inherited from DockManager)
Public property DockModeVS2005FadeSpeed Gets or sets a value that specifies the speed of fade effects. (Inherited from DockManager)
Public property DocumentManager Gets a DocumentManager associated with this SnapDockManager. (Inherited from DockManager)
Public property Form Gets or sets the container control (form or user control) which displays the dock panels owned by the current dock manager. (Inherited from DockManager)
Public property HiddenPanels Provides access to a collection of hidden dock panels. (Inherited from DockManager)
Public property Images Gets or sets the image source whose images are used by dock panels. (Inherited from DockManager)
Public property IsDeserializing Indicates whether the docking layout is being loaded. (Inherited from DockManager)
Public property IsInitialized Indicates whether the dock manager has been initialized. (Inherited from DockManager)
Public property Item Overloaded. Provides indexed access to the panels which belong to the dock manager. (Inherited from DockManager)
Public property LayoutVersion Gets or sets the version of the layout of dock windows. (Inherited from DockManager)
Public property MenuManager Gets or sets an object that controls the look and feel of the SnapDockManager's popup menus. (Inherited from DockManager)
Public property Panels Provides access to all the dock panels owned by the dock manager. (Inherited from DockManager)
Public property RootPanels Provides access to the collection of visible panels which are not owned by other panels. (Inherited from DockManager)
Public property SerializationInProgress This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from DockManager)
Public property SerializationOptions Provides options which control how a layout of dock panels is stored to/restored from a data store (a stream, xml file or system registry). (Inherited from DockManager)
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property SnapControl Specifies the SnapControl that is associated with the SnapDockManager.
Public property ToolTipController Gets or sets the tooltip controller component that controls the appearance, position and content of the hints displayed by the dock panels. (Inherited from DockManager)
Public property TopZIndexControls Gets the string collection that stores the full names of the controls which have the top (high) indexes in the z-order and thus are positioned closest to the form's edges. (Inherited from DockManager)
Public property ValidateDockPanelOnDeactivate Gets or sets whether the Validate method is forcibly called on a dock panel when switching from this dock panel to another one. (Inherited from DockManager)
Public property ValidateFloatFormChildrenOnDeactivate Gets or sets whether a float dock panel's controls are validated when the panel is deactivated. (Inherited from DockManager)
Public property ValidateFormChildrenOnDeactivate Gets or sets whether the ValidateChildren method is forcibly called on a DockManager parent Form when switching from one dock panel to another. (Inherited from DockManager)
Public property XtraSerializableScreenConfiguration This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from DockManager)
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public methodStatic member About Activates the dock manager's About dialog box. (Inherited from DockManager)
Public method AddPanel Overloaded. Creates a new dock panel and floats it at the specified point. (Inherited from DockManager)
Public method BeginInit Notifies the component that the initialization has started. (Inherited from DockManager)
Public method BeginUpdate Locks the DockManager object by preventing visual updates of the object and its elements until the EndUpdate method is called. (Inherited from DockManager)
Public method Clear Destroys all panels. (Inherited from DockManager)
Public method CreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
Public method CreateVs2005DockStyleVisualizers Creates a helper object that manages dock visualizers for the VS2005 dock style. (Inherited from DockManager)
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method EndInit Notifies the control that the initialization has been completed. (Inherited from DockManager)
Public method EndUpdate Unlocks the DockManager object after a call to the BeginUpdate method and causes an immediate visual update. (Inherited from DockManager)
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (Inherited from System.Object)
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method ForceInitialize Forces the dock manager to finish its initialization. (Inherited from DockManager)
Public method GetDockPanelAtPos Returns the panel located under the specified point. (Inherited from DockManager)
Public method GetHashCode Serves as a hash function for a particular type. System.Object.GetHashCode is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from System.Object)
Public method GetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method GetLogicalChildren This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from DockManager)
Public method GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method InitializeCore Performs basic initialization of the created SnapDockManager object and assigns the specified Design Surface to it.
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method LockWindowUpdate (Inherited from DockManager)
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method RemovePanel Destroys the specified panel. (Inherited from DockManager)
Public method RestoreFromRegistry Restores the layout stored at the specified system registry path to the dock panels. (Inherited from DockManager)
Public method RestoreFromStream Restores the layout in the specified stream to the dock panels. (Inherited from DockManager)
Public method RestoreFromXml Restores the layout of dock controls from the specified XML file. (Inherited from DockManager)
Public method RestoreLayoutFromRegistry Restores the layout of dock panels from the specified system registry path. (Inherited from DockManager)
Public method RestoreLayoutFromStream Restores the layout of dock panels from the specified stream. (Inherited from DockManager)
Public method RestoreLayoutFromXml Restores the layout of dock panels from the specified XML file. (Inherited from DockManager)
Public method SaveLayoutToRegistry Saves the layout of dock panels to the specified system registry path. (Inherited from DockManager)
Public method SaveLayoutToStream Saves the layout of dock panels to a stream. (Inherited from DockManager)
Public method SaveLayoutToXml Saves the layout of dock panels to an XML file. (Inherited from DockManager)
Public method SaveToRegistry Saves the layout of the dock panels to the registry. (Inherited from DockManager)
Public method SaveToStream Saves the layout of dock panels to a stream. (Inherited from DockManager)
Public method SaveToXml Saves the layout of dock panels to an XML file. (Inherited from DockManager)
Public method ToString Returns a System.String containing the name of the System.ComponentModel.Component, if any. This method should not be overridden. (Inherited from System.ComponentModel.Component)
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event ActiveChildChanged Fires after the panel's active child has been changed. (Inherited from DockManager)
Public event ActivePanelChanged Fires after the active dock panel has been changed. (Inherited from DockManager)
Public event BeforeLoadLayout Occurs before a layout is restored from storage (a stream, xml file or the system registry). (Inherited from DockManager)
Public event ClosedPanel Occurs after a panel has been closed. (Inherited from DockManager)
Public event ClosingPanel Occurs when a panel is closing. (Inherited from DockManager)
Public event Collapsed Occurs when any auto-hide DockPanel within the current SnapDockManager is completely hidden. (Inherited from DockManager)
Public event Collapsing Occurs when any auto-hide DockPanel within the current SnapDockManager is about to hide. (Inherited from DockManager)
Public event CreateAutoHideContainer Fires after an auto hide container has been created. (Inherited from DockManager)
Public event CreateResizeZone Allows you to prevent dock panels from being resized using the mouse at specific borders and corners. (Inherited from DockManager)
Public event DestroyAutoHideContainer Fires before an auto hide container has been destroyed. (Inherited from DockManager)
Public event Disposed Occurs when the component is disposed by a call to the System.ComponentModel.Component.Dispose method. (Inherited from System.ComponentModel.Component)
Public event Docking Fires repeatedly while a dock panel is being dragged. (Inherited from DockManager)
Public event EndDocking Fires immediately after a docking operation on a dock panel has finished. (Inherited from DockManager)
Public event EndSizing Fires after a resize operation on a dock panel has finished. (Inherited from DockManager)
Public event Expanded Occurs when any auto-hide DockPanel within the current SnapDockManager is completely shown. (Inherited from DockManager)
Public event Expanding Occurs when any auto-hide DockPanel within the current SnapDockManager is about to be displayed. (Inherited from DockManager)
Public event LayoutUpgrade Occurs after a layout whose version doesn't match the current layout's version has been loaded from storage (a stream, xml file or system registry). (Inherited from DockManager)
Public event Load Fires after the docking layout has been loaded. (Inherited from DockManager)
Public event PopupMenuShowing Occurs when a context menu is about to be displayed. (Inherited from DockManager)
Public event RegisterDockPanel Occurs when a new panel is registered within the dock manager. (Inherited from DockManager)
Public event ShowingDockGuides Occurs each time an end-user drags a DockPanel into another panel and allows you to hide specific dock hints and guides. This event is in effect when the DockManager is coupled with the DocumentManager component. (Inherited from DockManager)
Public event Sizing Fires when the dock panel is being resized. (Inherited from DockManager)
Public event StartDocking Fires when a docking operation starts. (Inherited from DockManager)
Public event StartSizing Enables specifying whether end-users can resize the dock panels. (Inherited from DockManager)
Public event TabbedChanged Occurs when a panel's DockPanel.Tabbed property is changed. (Inherited from DockManager)
Public event TabsPositionChanged Fires after a dock panel's DockPanel.TabsPosition property has been changed. (Inherited from DockManager)
Public event TabsScrollChanged Occurs when a panel's DockPanel.TabsScroll property is changed. (Inherited from DockManager)
Public event UnregisterDockPanel Occurs when a panel is removed from the dock manager. (Inherited from DockManager)
Public event VisibilityChanged Fires after the visible state of any dock panel owned by the dock manager has been changed. (Inherited from DockManager)
Top

Expanded See Also

How would you rate this topic?​​​​​​​