Document Members
In This Article
#Constructors
Name | Description |
---|---|
Document() | Initializes a new instance of the Document class with the default settings. |
Document |
Initializes a new instance of the Document class with the specified settings. |
Document |
Initializes a new instance of the Document class with the specified settings. |
#Properties
Name | Description |
---|---|
Accessible |
Gets or sets the object’s description used by accessibility client applications.
Inherited from Base |
Accessible |
Gets or sets the object’s name used by accessibility client applications.
Inherited from Base |
Accessible |
Gets or sets the object’s accessible role.
Inherited from Base |
Actual |
Returns the currently displayed document image.
Inherited from Base |
Allow |
Gets or sets whether this individual document should blend its caption fore color. |
Appearance |
Provides access to appearance settings used to paint this Document‘s caption when the document is active (selected). |
Appearance |
Provides access to appearance settings used to paint this Document‘s caption when the document is not selected. |
Can |
Gets a value indicating whether the component can raise an event. Inherited from Component. |
Caption |
Gets or sets the document’s caption.
Inherited from Base |
Column |
Gets or sets an integer value that is the index of a column within a table layout Widget |
Column |
Gets or sets the total number of columns that the current Document occupies. |
Container | Gets the IContainer that contains the Component. Inherited from Component. |
Control |
Gets the control displayed within the current document.
Inherited from Base |
Control |
Gets or sets the name of a control that will be passed to the current Document as content.
Inherited from Base |
Control |
Gets or sets the type of a control passed to the document as content.
Inherited from Base |
Control |
Gets or sets the type of a control that will be passed to the current Document as content.
Inherited from Base |
Custom |
Gets the set of Header Buttons assigned to the current Document. |
Design |
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. |
Float |
Gets or sets the current Base |
Float |
Gets or sets the size that the current Base |
Footer |
Gets or sets the current document‘s footer.
Inherited from Base |
Form |
Gets the form that displays the document’s contents when the document is floating.
Inherited from Base |
Free |
Provides access to a Length structure that specifies the height of this widget in Free Layout Mode. |
Free |
Provides access to a Length structure that specifies the width of this widget in Free Layout Mode. |
Header |
Gets or sets the current document‘s header.
Inherited from Base |
Height | Gets or sets this Document‘s height. |
Image |
Gets or sets the image associated with the current document. This property is obsolete. Use the Base property instead.
Inherited from Base |
Image |
Gets or sets the index of an image within the DocumentBase property instead.
Inherited from Base |
Image |
Provides access to properties that allow you to set up raster and vector images for this document.
Inherited from Base |
Images | Gets a collection of images that this Document can use as its icons. |
Image |
Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseBase property instead.
Inherited from Base |
Info | Gets the detailed info about this Document. |
Is |
Gets whether the document is active.
Inherited from Base |
Is |
Gets if the current Base |
Is |
Gets whether the Base |
Is |
Gets if the current document displays a Dock |
Is |
Gets whether the document is enabled.
Inherited from Base |
Is |
Gets whether the document is floating.
Inherited from Base |
Is |
Indicates whether or not the Base |
Is |
Returns whether or not the Base |
Is |
Gets whether this Document is currently maximized. |
Is |
Gets or sets whether this Document is currently selected. |
Is |
Returns whether or not this Base |
Is |
Inherited from Base |
Is |
Gets whether the document is visible.
Inherited from Base |
Manager |
Gets a Document |
Maximized |
Gets or sets the control displayed within this Document in its maximized state. |
Parent |
Gets a Stack |
Properties | Provides access to this Document‘s properties. |
Row |
Gets or sets an integer value that is the index of a row within a table layout Widget |
Row |
Gets or sets the total number of columns that the current Document occupies. |
Site | Gets or sets the ISite of the Component. Inherited from Component. |
Super |
Gets or sets a super tool-tip for this Document. |
Tag |
Gets or sets an object that contains data on the current Base |
Tool |
Gets or sets the simple hint for this Document. |
Tooltip |
Gets or sets one of nine standard icons to be displayed within this Document‘s tool-tip. |
Tooltip |
Gets or sets the title string displayed by this Document‘s hint. |
Width | Gets or sets this Document‘s width. |
#Methods
Name | Description |
---|---|
Assign |
Clones all document properties from the target Document to this Document object. |
Begin |
Locks the Base |
Cancel |
Unlocks the Base |
Create |
Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.
Inherited from Marshal |
Dispose() | Releases all resources used by the Component. Inherited from Component. |
Dock |
Docks this Document to either side of another Document. Additionally specifies which of these two documents should go first. |
Dock |
Docks this widget to another widget using the given orientation setting. |
Dock |
Docks this Document to either side of another Document. |
Dock |
Places this Document at a specific position within the targeted stack group. |
Dock |
Docks this Document to the desired stack group. |
Dock |
Docks this Document to the desired table group. |
End |
Unlocks the Base |
Equals |
Determines whether the specified object instances are considered equal. Inherited from Object. |
Equals |
Determines whether the specified object is equal to the current object. Inherited from Object. |
Get |
Serves as the default hash function. Inherited from Object. |
Get |
Retrieves the current lifetime service object that controls the lifetime policy for this instance.
Inherited from Marshal |
Get |
This member supports the internal infrastructure, and is not intended to be used directly from your code.
Inherited from Base |
Get |
Gets an object that paints the current Document. |
Get |
Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
Get |
Gets the Type of the current instance. Inherited from Object. |
Initialize |
Obtains a lifetime service object to control the lifetime policy for this instance.
Inherited from Marshal |
Invalidate() | Invalidates the region occupied by this Document. |
Invalidate |
Invalidates a specific region within this Document. |
Layout |
Updates the element.
Inherited from Base |
Memberwise |
Creates a shallow copy of the current Object. Inherited from Object. |
Memberwise |
Creates a shallow copy of the current Marshal |
Reference |
Determines whether the specified Object instances are the same instance. Inherited from Object. |
Reset |
Resets settings of the Base |
Should |
Returns whether settings of the Base |
To |
Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component. |
#Events
Name | Description |
---|---|
Custom |
Occurs when a check Custom Header Button within this Document is checked. |
Custom |
Occurs when an end-user clicks a regular Custom Header Button within this Document. |
Custom |
Occurs when a check Custom Header Button within this Document is unchecked. |
Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
Maximized | Occurs when this Document is maximized at runtime. |
Restored | Occurs when this maximized Widget Document is restored to its normal state. |
See Also