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
   [Expand]SnapDockManager Class
   [Collapse]SnapDocumentManager Class
     SnapDocumentManager Members
    [Expand]SnapDocumentManager Constructor
  [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

SnapDocumentManager Members

Represents a DocumentManager descendant that is used along with the SnapDockManager to build the Snap application UI.

Expanded Public Constructors

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

Expanded Public Properties

Show: Inherited
  Name Description
Public property BarAndDockingController Gets or sets the BarAndDockingController that will provide default appearance options for the SnapDocumentManager's elements. (Inherited from DocumentManager)
Public property Bounds Gets the bounding rectangle of the area occupied by the SnapDocumentManager. (Inherited from DocumentManager)
Public property ClientControl Gets or sets a client control to the current SnapDocumentManager, switching it to the Non-Document Mode. (Inherited from DocumentManager)
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property ContainerControl Gets or sets a control capable of containing the current SnapDocumentManager within. (Inherited from DocumentManager)
Public property DockManager Gets a DockManager that belongs to the same container as the current SnapDocumentManager. (Inherited from DocumentManager)
Public property DocumentActivationScope Gets or sets which Documents a Document Selector will display. (Inherited from DocumentManager)
Public property Images Provides access to the collection of images that can be associated with documents. (Inherited from DocumentManager)
Public property IsDisposing (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsDocumentSelectorVisible Gets if a document selector for this SnapDocumentManager is currently visible. (Inherited from DocumentManager)
Public property IsInitialized (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsInitializing (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsUpdateLocked (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property MaxThumbnailCount Gets or sets the maximum number of Document thumbnails within the Windows Task Bar for this SnapDocumentManager. (Inherited from DocumentManager)
Public property MdiParent Gets or sets the parent MDI form. (Inherited from DocumentManager)
Public property MenuManager Gets or sets an object that controls the look and feel of the SnapDocumentManager's popup menus. (Inherited from DocumentManager)
Public propertyStatic member RecreateMdiChildHandle This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from DocumentManager)
Public property RibbonAndBarsMergeStyle Gets or sets whether Bar Managers and Ribbon Controls from this SnapDocumentManager's child Documents should be automatically merged to Bars and Ribbons in the main application form. (Inherited from DocumentManager)
Public property RightToLeftLayout Gets or sets whether right-to-left mirror placement is turned on. (Inherited from DocumentManager)
Public property ShowThumbnailsInTaskBar Gets or sets whether thumbnails for the Documents within this SnapDocumentManager should be displayed in Windows Task Bar. (Inherited from DocumentManager)
Public property ShowToolTips Gets or sets whether a tooltip should be displayed when the mouse pointer is over Document headers. (Inherited from DocumentManager)
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property SnapMode Gets or sets whether or not Documents owned by this SnapDocumentManager can stick to each other, parent forms or screen edges. (Inherited from DocumentManager)
Public property ToolTipController Gets or sets the tooltip controller component that controls the appearance, position and content of hints displayed for the current SnapDocumentManager. (Inherited from DocumentManager)
Public property View Gets or sets a View object that displays child forms(or controls) in a specific manner. (Inherited from DocumentManager)
Public property ViewCollection Provides access to a collection of BaseView descendants that can be used within the SnapDocumentManager. (Inherited from DocumentManager)
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public methodStatic member About Activates the SnapDocumentManager's About dialog box. (Inherited from DocumentManager)
Public method BeginUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public method CalcHitInfo Returns information on an object located at the specified position. (Inherited from DocumentManager)
Public method CancelUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public method ClientToScreen Converts client coordinates to screen coordinates. (Inherited from DocumentManager)
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 CreateView Creates a BaseView object for the current SnapDocumentManager. (Inherited from DocumentManager)
Public method Dispose Releases all resources used by the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public method EndUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
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 control to finish its initialization. (Inherited from DocumentManager)
Public methodStatic member FromContainer Gets a DocumentManager hosted within the specific container and control. (Inherited from DocumentManager)
Public methodStatic member FromControl Gets a SnapDocumentManager hosted within the specific control. (Inherited from DocumentManager)
Public methodStatic member FromCurrentControl Retrieves a SnapDocumentManager component from the target control. (Inherited from DocumentManager)
Public method GetDocument Returns a document that displays the specified control/dock panel/form. (Inherited from DocumentManager)
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 GetType Gets the System.Type of the current instance. (Inherited from System.Object)
Public method InitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public method Invalidate Overloaded. Invalidates the region occupied by the SnapDocumentManager (adds it to the update region that will be repainted during the next paint operation), and causes a paint message to be sent to the SnapDocumentManager. (Inherited from DocumentManager)
Public method IsReadyToPerformUIOperations This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from DocumentManager)
Public method LayoutChanged (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method ScreenToClient Converts the screen coordinates of a specified point on the screen to client-area coordinates. (Inherited from DocumentManager)
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)
Public method Update Invalidates the region occupied by the current SnapDocumentManager. (Inherited from DocumentManager)
Top

Expanded Public Events

Show: Inherited
  Name Description
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 DocumentActivate Occurs whenever a Document within this SnapDocumentManager is activated. (Inherited from DocumentManager)
Public event ViewChanged Occurs after the SnapDocumentManager has switched to another view. (Inherited from DocumentManager)
Public event ViewChanging Occurs when the current SnapDocumentManager changes its active view and allows you to respond to these changes before they are applied. (Inherited from DocumentManager)
Top

Expanded See Also

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