Back to Devexpress

BaseDocument Members

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-basedocument-dot-underscore-members.md

latest16.6 KB
Original Source

BaseDocument Members

The base class for documents within a DocumentManager.

Properties

NameDescription
AccessibleDescriptionGets or sets the object’s description used by accessibility client applications.
AccessibleNameGets or sets the object’s name used by accessibility client applications.
AccessibleRoleGets or sets the object’s accessible role.
ActualImageReturns the currently displayed document image.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaptionGets or sets the document’s caption.
ContainerGets the IContainer that contains the Component. Inherited from Component.
ControlGets the control displayed within the current document.
ControlNameGets or sets the name of a control that will be passed to the current Document as content.
ControlTypeGets or sets the type of a control passed to the document as content.
ControlTypeNameGets or sets the type of a control that will be passed to the current Document as content.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FloatLocationGets or sets the current BaseDocument‘s top left corner coordinates according to which the document will be arranged when made floating.
FloatSizeGets or sets the size that the current BaseDocument will gain when made floating.
FooterGets or sets the current document‘s footer.
FormGets the form that displays the document’s contents when the document is floating.
HeaderGets or sets the current document‘s header.
ImageGets or sets the image associated with the current document. This property is obsolete. Use the BaseDocument.ImageOptions.Image property instead.
ImageIndexGets or sets the index of an image within the DocumentManager.Images collection. This property is obsolete. Use the BaseDocument.ImageOptions.ImageIndex property instead.
ImageOptionsProvides access to properties that allow you to set up raster and vector images for this document.
ImageUriGets or sets an image stored within the DevExpress Image Gallery that should be assigned to this BaseDocument. This property is obsolete. Use the BaseDocument.ImageOptions.ImageUri property instead.
IsActiveGets whether the document is active.
IsDeferredControlLoadGets if the current BaseDocument is loaded in the Deferred Load mode.
IsDisposingGets whether the BaseComponent object is currently being disposed of. Inherited from BaseComponent.
IsDockPanelGets if the current document displays a DockPanel.
IsEnabledGets whether the document is enabled.
IsFloatingGets whether the document is floating.
IsInitializedIndicates whether or not the BaseComponent object has been fully initialized. Inherited from BaseComponent.
IsInitializingReturns whether or not the BaseComponent object is currently being initialized. Inherited from BaseComponent.
IsMaximizedGets whether the BaseDocument is currently maximized.
IsUpdateLockedReturns whether or not this BaseComponent is currently locked, which prevents any visual updates. Inherited from BaseComponent.
IsUpdateNeeded
IsVisibleGets whether the document is visible.
ManagerGets a DocumentManager that owns the current document.
PropertiesProvides access to the current document’s properties.
SiteGets or sets the ISite of the Component. Inherited from Component.
TagGets or sets an object that contains data on the current BaseDocument object.

Methods

NameDescription
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) staticDetermines 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.
GetService(Type) protectedReturns 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() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
ResetProperties()Resets settings of the BaseDocument.Properties object to their default values.
ShouldSerializeProperties()Returns whether settings of the BaseDocument.Properties object should be serialized.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.

See Also

BaseDocument Class

DevExpress.XtraBars.Docking2010.Views Namespace