Skip to main content

Document Members

A Document within a WindowsUIView.

Constructors

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

Properties

Name Description
AccessibleDescription Gets or sets the object’s description used by accessibility client applications. Inherited from BaseDocument.
AccessibleName Gets or sets the object’s name used by accessibility client applications. Inherited from BaseDocument.
AccessibleRole Gets or sets the object’s accessible role. Inherited from BaseDocument.
ActionCaption Gets or sets the caption for the navigation action related to the current Document.
ActionImage Gets or sets the icon for the navigation action related to the current Document.
ActionImageOptions Provides access to properties that allow you to set up raster and vector images for the default navigation button associated with this Document.
ActionImageUri Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this Document as its action image.
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.
ActualImage Returns the currently displayed document image. Inherited from BaseDocument.
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.
ControlType Gets or sets the type of a control passed to the 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.
DocumentContainerActions Provides access to the current Document‘s custom actions.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
ExcludeFromSearch Gets or sets whether this Document should be removed from the list of places where the Search Panel looks for the entered text.
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 up raster and vector images for this document. Inherited from BaseDocument.
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.
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.
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.
Properties Provides access to the current document’s properties. Inherited from BaseDocument.
SearchTags Gets or sets the collection of string tags for this Document. The Search Panel will check these tags for the desired text.
Site Gets or sets the ISite of the Component. Inherited from Component.
Tag Gets or sets an object that contains data on the current BaseDocument object. Inherited from BaseDocument.

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, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. 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.
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.
See Also