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
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [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
  [Collapse]DevExpress.XtraBars.Docking2010.Views
   [Expand]BaseDocument Class
   [Collapse]BaseView Class
     BaseView Members
    [Expand]BaseView Properties
    [Expand]BaseView Events
    [Expand]BaseView Methods
   [Expand]ControlReleasingEventArgs Class
    ControlReleasingEventHandler Delegate
   [Expand]CustomHeaderButtonEventArgs Class
    CustomHeaderButtonEventHandler Delegate
   [Expand]DeferredControlLoadEventArgs Class
    DeferredControlLoadEventHandler Delegate
   [Expand]DocumentCancelEventArgs Class
    DocumentCancelEventHandler Delegate
   [Expand]DocumentEventArgs Class
    DocumentEventHandler Delegate
    FloatingDocumentContainer Enumeration
   [Expand]IBaseDocumentDefaultProperties Interface
   [Expand]IBaseDocumentProperties Interface
   [Expand]IBaseViewController Interface
   [Expand]QueryControlEventArgs Class
    QueryControlEventHandler Delegate
    RibbonAndBarsMergeStyle Enumeration
   [Expand]TabbedViewPageAppearance Class
    ViewType Enumeration
  [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]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]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

BaseView Members

The base class for Views in a DocumentManager.

Expanded Public Properties

Show: Inherited
  Name Description
Public property ActiveDocument Gets the active document.
Public property ActiveFloatDocument Gets the active floating document.
Public property AllowHotkeyNavigation Gets or sets whether switching between tabbed documents using keyboard shortcuts is allowed.
Public property AllowResetLayout Gets or sets whether the current DocumentManager's layout can be reset to default.
Public property Appearance Contains appearance settings for the current View.
Public property BackgroundImage Gets or sets the current DocumentManager's background image.
Public property BackgroundImageLayoutMode Gets or sets the background image layout as defined in the ImageLayoutMode enumeration.
Public property BackgroundImageStretchMargins Gets or sets stretching margins for a DocumentManager's background image in a View.
Public property Bounds Gets the visual bounds of the current object.
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Controller Provides methods to work with documents in the current View.
Public property CustomResizeZoneThickness Gets or sets the resize zone thickness.
Public property DocumentProperties Provides access to properties common to all documents within the current View.
Public property Documents Stores all documents displayed within the View.
Public property DocumentSelectorProperties Provides access to appearance settings used for a Document Selector within the current view.
Public property FloatDocuments Provides access to floating documents.
Public property FloatingDocumentContainer Gets or sets a type of container for floating documents within the current BaseView.
Public property FloatPanels This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public property IsDisposing (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsDocumentSelectorVisible Gets if a document selector for this BaseView is currently visible.
Public property IsEmpty Gets whether a View is empty.
Public property IsFocused Gets whether any document within the current View has focus.
Public property IsInitialized (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsInitializing (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsLoaded Gets whether the current object has been loaded.
Public property IsLoading Gets whether the current object is being loaded.
Public property IsLoadingAnimationInProgress Gets whether loading indicator animation is currently running within this View.
Public property IsUpdateLocked (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property Items This member supports the internal infrastructure, and is not intended to be used directly from your code.
Public property LoadingIndicatorProperties Provides access to appearance settings used for a loading indicator within the current BaseView.
Public property Manager Gets a DocumentManager that owns the current View.
Public property OptionsLayout Gets the object containing properties related to the current View's layout.
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Type Gets the current View's type.
Public property UseDocumentSelector Gets or sets if a Document Selector is enabled for the current Document Manager.
Public property UseLoadingIndicator Gets or sets if a loading indicator for deferred load should be used.
Public property UseSnappingEmulation Gets or sets whether this BaseView uses snapping emulation for its child documents.
Public property WindowsDialogProperties Gets an object containing settings related to the current DocumentManager's Windows dialog.
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method ActivateDocument Activates the document that displays the specified control.
Public method AddDocument Overloaded. Adds an empty Document with specified BaseDocument.Caption and BaseDocument.ControlName properties to the current View.
Public method AddFloatDocument Creates a new floating document that will display the specified control/form.
Public method AddFloatingDocumentsHost Overloaded. Creates a floating documents host (container) that will contain the specific BaseDocument objects collection.
Public method AddOrActivateDocument Activates an existing document that contains the specific control. If no such document was found, a new document is created and added to this View.
Public method BeginUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public method CancelUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
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 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 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 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 ReleaseDeferredLoadControl Overloaded. Disposes a specific deferred load Document within the current View.
Public method ReleaseDeferredLoadControls Overloaded. Disposes all deferred load Documents within the current view.
Public method RemoveDocument Removes a document whose BaseDocument.Control property's value matches the specified control object.
Public method RestoreLayoutFromRegistry Restores the current layout of documents from the specified system registry path.
Public method RestoreLayoutFromStream Overloaded. Restores the View layout from a binary or text stream.
Public method RestoreLayoutFromXml Overloaded. Loads a View layout stored as XML data in a specific stream.
Public method SaveLayoutToRegistry Saves the layout of documents to the specified system registry path.
Public method SaveLayoutToStream Overloaded. Saves the current View layout in a binary or text stream.
Public method SaveLayoutToXml Overloaded. Saves the current View layout as XML data to a specific stream.
Public method ToString Gets the text representation of the BaseView object.
Top

Expanded Public Events

Show: Inherited
  Name Description
Public event BeginDocking Allows you to cancel docking a document onto the current control.
Public event BeginDocumentsHostDocking Occurs whenever a Floating Documents Container starts docking to this BaseView.
Public event BeginFloating Fires when an end-user starts to drag a docked document, so that it is transformed into a floating window.
Public event BeginSizing Occurs when a resizing of the current View's layout begins.
Public event ControlLoaded Occurs after a control has been loaded to a Document within this BaseView.
Public event ControlReleased Fires after the previously selected document is disposed.
Public event ControlReleasing Occurs when a document is deselected and allows you to unbind the document from its content and dispose of the content. This event is in effect in Deferred Load mode.
Public event ControlShown Fires when an empty document is loaded and displayed.
Public event CustomDocumentsHostWindow Fired before a host container for floating documents is created, allowing you to create your own custom floating document container.
Public event CustomDrawBackground Occurs when the current View's background becomes visible to an end-user.
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 DocumentActivated Fires when the View's ActiveDocument property changes.
Public event DocumentAdded Fires when a new document is added to the current View.
Public event DocumentClosed Fires after a document has been closed.
Public event DocumentClosing Fires when a document is about to be closed.
Public event DocumentDeactivated Fires when a document is deactivated.
Public event DocumentRemoved Fires when a document is removed from the Documents collection.
Public event DocumentSelectorCustomSortItems Allows you to manually sort documents and dock panels displayed within the Document Selector.
Public event DocumentSelectorHidden Fires when a document selector is closed.
Public event DocumentSelectorShown Fires when a document selector is displayed.
Public event EmptyDocumentsHostWindow Fires when the last floating document in the documents host window is closed or the control it contains is disposed, allowing you to specify whether to keep open the empty documents host window.
Public event EndDocking Fires after a document has been docked to the control.
Public event EndDocumentsHostDocking Occurs when a Floating Document Container with all its child Documents is docked to a View.
Public event EndFloating Fires after an end-user drops a floating document.
Public event EndSizing Occurs when resizing the current View's layout is complete.
Public event Floating Fires when a docked document becomes floating.
Public event GotFocus Fires when focus is moved to any document within the current View.
Public event Layout Occurs whenever the current DocumentManager's layout is being modified.
Public event LayoutReset Fires after a DocumentManager's layout was reset.
Public event LayoutResetting Occurs when the current BaseView's layout is to be reset.
Public event LayoutUpgrade
Public event LoadingIndicatorShowing Occurs when the loading indicator is shown within this BaseView.
Public event LostFocus Fires when focus is moved from the current View's document to any external control (for instance, to an external DockPanel).
Public event NextDocument Fires when an end-user tries to switch to the next or previous document by pressing CTRL+TAB or CTRL+SHIFT+TAB.
Public event Paint Occurs when the BaseView is redrawn.
Public event PopupMenuShowing Fires when a context menu is about to be displayed.
Public event QueryControl Occurs when a document is to be displayed and allows you to assign content to this document. This event is in effect in Deferred Load mode.
Public event RegisterDocumentsHostWindow Fires when a document is made floating and provides access to the created documents host window. This allows subscribing its DocumentManager to existing event handlers. This event is in effect in the DocumentsHost mode.
Public event ShowingDockGuides Allows you to hide and disable individual dock hints.
Public event UnregisterDocumentsHostWindow Fires when a documents host window is closed and allows you to unsubscribe event handlers from its DocumentManager.
Top

Expanded See Also

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