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
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Collapse]DevExpress.XtraBars.Docking2010.Views.Widget
   [Expand]BaseRelativeLengthElement Class
   [Expand]ColumnDefinition Class
   [Collapse]Document Class
     Document Members
    [Expand]Document Constructor
    [Expand]Document Properties
    [Expand]Document Events
    [Expand]Document Methods
   [Expand]DocumentAnimationProperties Class
   [Expand]FlowLayoutProperties Class
   [Expand]FreeLayoutProperties Class
   [Expand]IDocumentDefaultProperties Interface
   [Expand]IDocumentProperties Interface
   [Expand]IStackGroupDefaultProperties Interface
   [Expand]IStackGroupProperties Interface
   [Expand]IWidgetViewController Interface
    LayoutMode Enumeration
   [Expand]Length Class
    LengthUnitType Enumeration
   [Expand]RowDefinition Class
   [Expand]StackGroup Class
   [Expand]StackGroupDefaultProperties Class
   [Expand]WidgetView Class
  [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

Document Members

A Document within a WidgetView.

Expanded Public Constructors

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

Expanded Public Properties

Show: Inherited
  Name Description
Public property AllowCaptionColorBlending Gets or sets whether this individual document should blend its caption fore color.
Public property AppearanceActiveCaption Provides access to appearance settings used to paint this Document's caption when the document is active (selected).
Public property AppearanceCaption Provides access to appearance settings used to paint this Document's caption when the document is not selected.
Public property Caption Gets or sets the document's caption. (Inherited from BaseDocument)
Public property ColumnIndex Gets or sets an integer value that is the index of a column within a table layout WidgetView, in which this Document is nested.
Public property ColumnSpan Gets or sets the total number of columns that the current Document occupies.
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 CustomHeaderButtons Gets the set of Header Buttons assigned to the current Document.
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 FreeLayoutHeight Provides access to a Length structure that specifies the height of this widget in Free Layout Mode.
Public property FreeLayoutWidth Provides access to a Length structure that specifies the width of this widget in Free Layout Mode.
Public property Header Gets or sets the current document's header. (Inherited from BaseDocument)
Public property Height Gets or sets this Document's height.
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 Images Gets a collection of images that this Document can use as its icons.
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 Info Gets the detailed info about this Document.
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 (Inherited from DevExpress.XtraBars.Docking2010.Base.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 (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsInitializing (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public property IsMaximized Gets whether this Document is currently maximized.
Public property IsSelected Gets or sets whether this Document is currently selected.
Public property IsUpdateLocked (Inherited from DevExpress.XtraBars.Docking2010.Base.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 MaximizedControl Gets or sets the control displayed within this Document in its maximized state.
Public property Parent Gets a StackGroup that owns this Document.
Public property Properties Provides access to this Document's properties.
Public property RowIndex Gets or sets an integer value that is the index of a row within a table layout WidgetView, in which this Document is nested.
Public property RowSpan Gets or sets the total number of columns that the current Document occupies.
Public property Site Gets or sets the System.ComponentModel.ISite of the System.ComponentModel.Component. (Inherited from System.ComponentModel.Component)
Public property SuperTip Gets or sets a super tool-tip for this Document.
Public property Tag Gets or sets an object that contains data on the current Document object. (Inherited from BaseDocument)
Public property ToolTip Gets or sets the simple hint for this Document.
Public property TooltipIconType Gets or sets one of nine standard icons to be displayed within this Document's tool-tip.
Public property TooltipTitle Gets or sets the title string displayed by this Document's hint.
Public property Width Gets or sets this Document's width.
Top

Expanded Public Methods

Show: Inherited
  Name Description
Public method AssignProperties Clones all document properties from the target Document to this Document object.
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 DockTo Overloaded. Docks this Document to either side of another Document.
Public method EndUpdate (Inherited from DevExpress.XtraBars.Docking2010.Base.BaseComponent)
Public methodStatic member Equals Determines whether the specified System.Object instances are considered equal. (Inherited from System.Object)
Public method Equals Determines whether the specified System.Object is equal to the current System.Object. (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 GetPainter Gets an object that paints the current Document.
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 a specific region within this Document.
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 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 CustomButtonChecked Occurs when a check Custom Header Button within this Document is checked.
Public event CustomButtonClick Occurs when an end-user clicks a regular Custom Header Button within this Document.
Public event CustomButtonUnchecked Occurs when a check Custom Header Button within this Document is unchecked.
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 Maximized Occurs when this Document is maximized at runtime.
Public event Restored Occurs when this maximized Widget Document is restored to its normal state.
Top

Expanded See Also

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