Document Members

A document within a TabbedView.

Constructors

Name Description
Document() Initializes a new instance of the Document class.
Document(IDocumentProperties) Initializes a new instance of the Document class with the specified properties.
Document(IContainer) Initializes a new instance of the Document class with the specified container.

Properties

Name Description
ActualImage Returns the currently displayed document image. Inherited from BaseDocument.
Appearance Provides access to appearance settings for the current Document.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Caption Gets or sets the document's caption. Inherited from BaseDocument.
Container Gets the IContainer that contains the Component. Inherited from Component.
Control Gets the control displayed within the current document. Inherited from BaseDocument.
ControlName Gets or sets the name of a control that will be passed to the current Document as content. Inherited from BaseDocument.
ControlTypeName Gets or sets the type of a control that will be passed to the current Document as content. Inherited from BaseDocument.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FloatLocation Gets or sets the current BaseDocument's top left corner coordinates according to which the document will be arranged when made floating. Inherited from BaseDocument.
FloatSize Gets or sets the size that the current BaseDocument will gain when made floating. Inherited from BaseDocument.
Footer Gets or sets the current document's footer. Inherited from BaseDocument.
Form Gets the form that displays the document's contents when the document is floating. Inherited from BaseDocument.
Header Gets or sets the current document's header. Inherited from BaseDocument.
Image Gets or sets the image associated with the current document. Inherited from BaseDocument.
ImageIndex Gets or sets the index of an image within the DocumentManager.Images collection. Inherited from BaseDocument.
ImageOptions Provides access to properties that allow you to set and customize raster and vector images.
ImageUri Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseDocument. Inherited from BaseDocument.
IsActive Gets whether the document is active. Inherited from BaseDocument.
IsAnimated Gets if a Document's tab icon is currently animated.
IsDeferredControlLoad Gets if the current BaseDocument is loaded in the Deferred Load mode. Inherited from BaseDocument.
IsDisposing Gets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsDockPanel Gets if the current document displays a DockPanel. Inherited from BaseDocument.
IsEnabled Gets whether the document is enabled. Inherited from BaseDocument.
IsFloating Gets whether the document is floating. Inherited from BaseDocument.
IsInitialized Indicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializing Returns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsMaximized Gets whether the BaseDocument is currently maximized. Inherited from BaseDocument.
IsSelected Gets whether the current document is selected in the group where it is displayed.
IsUpdateLocked Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
IsUpdateNeeded Inherited from BaseDocument.
IsVisible Gets whether the document is visible. Inherited from BaseDocument.
Manager Gets a DocumentManager that owns the current document. Inherited from BaseDocument.
Parent Gets the group where the current document is displayed.
Pinned Gets or sets whether the Document is currently pinned.
Properties Provides access to the current document's properties.
Site Gets or sets the ISite of the Component. Inherited from Component.
SuperTip Gets or sets a SuperToolTip for the current control.
Tag Gets or sets an object that contains data on the current BaseDocument object. Inherited from BaseDocument.
Tooltip Gets or sets a regular tooltip's content.
TooltipIconType Gets or sets the type of the tooltip icon.
TooltipTitle Gets or sets a regular tooltip's title.

Methods

Name Description
BeginUpdate() Locks the BaseComponent, preventing visual updates of the object and its elements until the EndUpdate or CancelUpdate method is called. Inherited from BaseComponent.
CancelUpdate() Unlocks the BaseComponent object after it has been locked by the BeginUpdate method, without causing an immediate visual update. Inherited from BaseComponent.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndUpdate() Unlocks the BaseComponent object after a call to the BeginUpdate method and causes an immediate visual update. Inherited from BaseComponent.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetLogicalChildren() This member supports the internal infrastructure, and is not intended to be used directly from your code. Inherited from BaseDocument.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
LayoutChanged() Updates the element. Inherited from BaseComponent.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
ResetProperties() Resets settings of the BaseDocument.Properties object to their default values. Inherited from BaseDocument.
ShouldSerializeProperties() Returns whether settings of the BaseDocument.Properties object should be serialized. Inherited from BaseDocument.
StartAnimation() Starts a Document's icon animation.
StopAnimation() Stops icon animation for the current Document.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
IsSelectedChanged Occurs when the current Document's selected state has changed.
ParentChanged Occurs when the current Document changes its parent DocumentGroup.
See Also