[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
  [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.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.Base
  [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
  [Collapse]DevExpress.XtraBars.Docking2010.Views.WindowsUI
   [Expand]BaseContentContainer Class
   [Expand]BaseNavigationEventArgs Class
   [Expand]BaseTile Class
   [Collapse]Document Class
     Document Members
    [Expand]Document Constructor
    [Expand]Document Properties
   [Expand]DocumentAction Class
   [Expand]DocumentCheckAction Class
   [Expand]DocumentGroup Class
   [Expand]Flyout Class
   [Expand]FlyoutAction Class
   [Expand]FlyoutCommand Class
   [Expand]FlyoutResultEventArgs Class
    FlyoutStyle Enumeration
   [Expand]IBaseTileProperties Interface
   [Expand]IContentContainerAction Interface
   [Expand]IContentContainerDefaultProperties Interface
   [Expand]IContentContainerProperties Interface
   [Expand]IDocumentActionsArgs Interface
   [Expand]IDocumentSelectorDefaultProperties Interface
   [Expand]IDocumentSelectorProperties Interface
   [Expand]IFlyoutDefaultProperties Interface
   [Expand]IFlyoutProperties Interface
   [Expand]IPageGroupDefaultProperties Interface
   [Expand]IPageGroupProperties Interface
   [Expand]ISlideGroupDefaultProperties Interface
   [Expand]ISlideGroupProperties Interface
   [Expand]ISupportDocumentActions Interface
   [Expand]ISupportNavigation Interface
   [Expand]ITabbedGroupDefaultProperties Interface
   [Expand]ITabbedGroupProperties Interface
   [Expand]ITileContainerDefaultProperties Interface
   [Expand]ITileContainerProperties Interface
   [Expand]IWindowsUIViewController Interface
   [Expand]NavigationEventArgs Class
    NavigationMode Enumeration
   [Expand]OverviewContainerDefaultProperties Class
   [Expand]OverviewContainerProperties Class
   [Expand]Page Class
   [Expand]PageGroup Class
   [Expand]SlideGroup Class
   [Expand]SplitGroup Class
   [Expand]TabbedGroup Class
   [Expand]Tile Class
   [Expand]TileContainer Class
   [Expand]UIActionPropertiesCore Class
   [Expand]WindowsUIView Class
  [Expand]DevExpress.XtraBars.FluentDesignSystem
  [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.Docking
  [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.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.GoogleCalendar
  [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.XtraTreeMap.Printing
  [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]Office File API
[Expand]Reporting
[Expand]Report and Dashboard Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

Document Members

A Document within a WindowsUIView.

Expanded Public Constructors

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

Expanded Public Properties

Show: Inherited
  Name Description
Public property ActionCaption Gets or sets the caption for the navigation action related to the current Document.
Public property ActionImage Gets or sets the icon for the navigation action related to the current Document.
Public property ActionImageOptions Provides access to properties that allow you to set up raster and vector images for the default navigation button associated with this Document.
Public property ActionImageUri Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this Document as its action image.
Public property ActualActionImage Returns the icon displayed by a default navigation action that activates this Document. This default button is shown inside Navigation Bars for the SlideGroup and SplitGroup containers.
Public property ActualImage Returns the currently displayed document image. (Inherited from BaseDocument)
Public property Caption Gets or sets the document's caption. (Inherited from BaseDocument)
Public property Container Gets the System.ComponentModel.IContainer that contains the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Control Gets the control displayed within the current document. (Inherited from BaseDocument)
Public property ControlName Gets or sets the name of a control that will be passed to the current Document as content. (Inherited from BaseDocument)
Public property ControlTypeName Gets or sets the type of a control that will be passed to the current Document as content. (Inherited from BaseDocument)
Public property DocumentContainerActions Provides access to the current Document's custom actions.
Public property ExcludeFromSearch Gets or sets whether this Document should be removed from the list of places where the Search Panel looks for the entered text.
Public property FloatLocation Gets or sets the current Document's top left corner coordinates according to which the document will be arranged when made floating. (Inherited from BaseDocument)
Public property FloatSize Gets or sets the size that the current Document will gain when made floating. (Inherited from BaseDocument)
Public property Footer Gets or sets the current document's footer. (Inherited from BaseDocument)
Public property Form Gets the form that displays the document's contents when the document is floating. (Inherited from BaseDocument)
Public property Header Gets or sets the current document's header. (Inherited from BaseDocument)
Public property Image Gets or sets the image associated with the current document. (Inherited from BaseDocument)
Public property ImageIndex Gets or sets the index of an image within the DocumentManager.Images collection. (Inherited from BaseDocument)
Public property ImageOptions Provides access to properties that allow you to set up raster and vector images for this document. (Inherited from BaseDocument)
Public property ImageUri Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this Document. (Inherited from BaseDocument)
Public property IsActive Gets whether the document is active. (Inherited from BaseDocument)
Public property IsDeferredControlLoad Gets if the current Document is loaded in the Deferred Load mode. (Inherited from BaseDocument)
Public property IsDisposing Gets whether the Document object is currently being disposed of. (Inherited from BaseComponent)
Public property IsDockPanel Gets if the current document displays a DockPanel. (Inherited from BaseDocument)
Public property IsEnabled Gets whether the document is enabled. (Inherited from BaseDocument)
Public property IsFloating Gets whether the document is floating. (Inherited from BaseDocument)
Public property IsInitialized Indicates whether or not the Document object has been fully initialized. (Inherited from BaseComponent)
Public property IsInitializing Returns whether or not the Document object is currently being initialized. (Inherited from BaseComponent)
Public property IsMaximized Gets whether the Document is currently maximized. (Inherited from BaseDocument)
Public property IsUpdateLocked Returns whether or not this Document is currently locked, which prevents any visual updates. (Inherited from BaseComponent)
Public property IsVisible Gets whether the document is visible. (Inherited from BaseDocument)
Public property Manager Gets a DocumentManager that owns the current document. (Inherited from BaseDocument)
Public property Properties Provides access to the current document's properties. (Inherited from BaseDocument)
Public property SearchTags Gets or sets the collection of string tags for this Document. The Search Panel will check these tags for the desired text.
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property Tag Gets or sets an object that contains data on the current Document object. (Inherited from BaseDocument)
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method BeginUpdate Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. (Inherited from BaseComponent)
Public method CancelUpdate Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. (Inherited from 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 Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. (Inherited from 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 GetLogicalChildren This member supports the internal infrastructure, and is not intended to be used directly from your code. (Inherited from BaseDocument)
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 Updates the element. (Inherited from BaseComponent)
Public methodStatic member ReferenceEquals Determines whether the specified System.Object instances are the same instance. (Inherited from System.Object)
Public method ResetProperties Resets settings of the BaseDocument.Properties object to their default values. (Inherited from BaseDocument)
Public method ShouldSerializeProperties Returns whether settings of the BaseDocument.Properties object should be serialized. (Inherited from BaseDocument)
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 Disposed Occurs when the component is disposed by a call to the System.ComponentModel.Component.Dispose method. (Inherited from System.ComponentModel.Component)
Top

Expanded See Also

Is this topic helpful?​​​​​​​