Document Members
A Document within a WidgetView.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 the specified settings. |
| Document(IContainer) | Initializes a new instance of the Document class with the specified settings. |
Properties
| Name | Description |
|---|---|
| ActualImage | Returns the currently displayed document image. Inherited from BaseDocument. |
| AllowCaptionColorBlending | Gets or sets whether this individual document should blend its caption fore color. |
| AppearanceActiveCaption | Provides access to appearance settings used to paint this Document‘s caption when the document is active (selected). |
| AppearanceCaption | Provides access to appearance settings used to paint this Document‘s caption when the document is not selected. |
| 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. |
| 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. |
| ColumnSpan | 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 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. |
| CustomHeaderButtons | Gets the set of Header Buttons assigned to the current Document. |
| 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. |
| FreeLayoutHeight | Provides access to a Length structure that specifies the height of this widget in Free Layout Mode. |
| FreeLayoutWidth | 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 BaseDocument. |
| Height | Gets or sets this Document‘s height. |
| 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. |
| Images | Gets a collection of images that this Document can use as its icons. |
| ImageUri | Gets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseDocument. Inherited from BaseDocument. |
| Info | Gets the detailed info about this Document. |
| 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 this Document is currently maximized. |
| IsSelected | Gets or sets whether this Document is currently selected. |
| IsUpdateLocked | Returns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent. |
| IsVisible | Gets whether the document is visible. Inherited from BaseDocument. |
| Manager | Gets a DocumentManager that owns the current document. Inherited from BaseDocument. |
| MaximizedControl | Gets or sets the control displayed within this Document in its maximized state. |
| Parent | Gets a StackGroup that owns this Document. |
| Properties | Provides access to this Document‘s properties. |
| 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. |
| RowSpan | 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. |
| SuperTip | Gets or sets a super tool-tip for this Document. |
| Tag | Gets or sets an object that contains data on the current BaseDocument object. Inherited from BaseDocument. |
| ToolTip | Gets or sets the simple hint for this Document. |
| TooltipIconType | Gets or sets one of nine standard icons to be displayed within this Document‘s tool-tip. |
| TooltipTitle | Gets or sets the title string displayed by this Document‘s hint. |
| Width | Gets or sets this Document‘s width. |
Methods
| Name | Description |
|---|---|
| AssignProperties(Document) | Clones all document properties from the target Document to this Document object. |
| 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. |
| DockTo(Document, Orientation, Boolean) | Docks this Document to either side of another Document. Additionally specifies which of these two documents should go first. |
| DockTo(Document, Orientation, Int32) | Docks this widget to another widget using the given orientation setting. |
| DockTo(Document, Orientation) | Docks this Document to either side of another Document. |
| DockTo(StackGroup, Int32) | Places this Document at a specific position within the targeted stack group. |
| DockTo(StackGroup) | Docks this Document to the desired stack group. |
| DockTo(TableGroup) | Docks this Document to the desired table group. |
| 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. |
| GetPainter() | Gets an object that paints the current Document. |
| 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. |
| Invalidate() | Invalidates the region occupied by this Document. |
| Invalidate(Rectangle) | Invalidates a specific region within this Document. |
| 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 |
|---|---|
| CustomButtonChecked | Occurs when a check Custom Header Button within this Document is checked. |
| CustomButtonClick | Occurs when an end-user clicks a regular Custom Header Button within this Document. |
| CustomButtonUnchecked | 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