Back to Devexpress

BaseDocument.ImageIndex Property

windowsforms-devexpress-dot-xtrabars-dot-docking2010-dot-views-dot-basedocument-4ee7d790.md

latest3.0 KB
Original Source

BaseDocument.ImageIndex Property

Gets or sets the index of an image within the DocumentManager.Images collection. This property is obsolete. Use the BaseDocument.ImageOptions.ImageIndex property instead.

Namespace : DevExpress.XtraBars.Docking2010.Views

Assembly : DevExpress.XtraBars.v25.2.dll

NuGet Package : DevExpress.Win.Navigation

Declaration

csharp
[Browsable(false)]
[DefaultValue(-1)]
[EditorBrowsable(EditorBrowsableState.Never)]
public int ImageIndex { get; set; }
vb
<Browsable(False)>
<EditorBrowsable(EditorBrowsableState.Never)>
<DefaultValue(-1)>
Public Property ImageIndex As Integer

Property Value

TypeDefaultDescription
Int32-1

A zero-based index of an image in the DocumentManager.Images collection.

|

Remarks

See DocumentManager.Images to learn more.

Tip

You can also assign an image by its name in the collection.

csharp
// The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1["technology_32x32"]; 
// Assign an SVG image in the SvgCollection
// barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];
vb
' The image collection is created and populated with images at design time.
barItem.ImageOptions.Image = imageCollection1("technology_32x32")
' Assign an SVG image in the SvgCollection
' barItem.ImageOptions.SvgImage = svgCollection1["technology_32x32"];

Read the following help topic for more information: Access and Use DevExpress Icons in Code.

See Also

Images

IBaseDocumentDefaultProperties.UseFormIconAsDocumentImage

IBaseDocumentProperties.UseFormIconAsDocumentImage

BaseDocument Class

BaseDocument Members

DevExpress.XtraBars.Docking2010.Views Namespace