Back to Devexpress

DocumentManager.Images Property

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-documentmanager-454bfa74.md

latest3.0 KB
Original Source

DocumentManager.Images Property

Provides access to the collection of images that can be associated with documents.

Namespace : DevExpress.XtraBars.Docking2010

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[DefaultValue(null)]
[DXCategory("Appearance")]
public virtual object Images { get; set; }
vb
<DXCategory("Appearance")>
<DefaultValue(Nothing)>
Public Overridable Property Images As Object

Property Value

TypeDefaultDescription
Objectnull

An object that specifies an image collection.

|

Remarks

An image assigned to a document is displayed in these cases:

  • in a tab (when documents are displayed as tabs);
  • in a form’s title bar (when a document is displayed as a floating form)
  • in a menu used to switch between documents.

You can provide images for documents using one of two methods:

  • Add images to an image collection and assign the image collection to the Images property. Then, assign images by their image indexes to documents via the BaseDocument.ImageOptions.ImageIndex property.
  • Assign images to a document directly via the BaseDocument.ImageOptions.Image property. The BaseDocument.ImageOptions.Image property has a higher priority than BaseDocument.ImageOptions.ImageIndex.

The Images property accepts the following image collections:

See Also

Images

IBaseDocumentDefaultProperties.UseFormIconAsDocumentImage

IBaseDocumentProperties.UseFormIconAsDocumentImage

DocumentManager Class

DocumentManager Members

DevExpress.XtraBars.Docking2010 Namespace