Share via


ToolWindow.BitmapIndex Property

When overriden in a derived class, gets the index of the bitmap that appears next to the name of the tool window.

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (in Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Syntax

'Declaration
Protected Overridable ReadOnly Property BitmapIndex As Integer
protected virtual int BitmapIndex { get; }
protected:
virtual property int BitmapIndex {
    int get ();
}
abstract BitmapIndex : int with get 
override BitmapIndex : int with get
function get BitmapIndex () : int

Property Value

Type: System.Int32
The index of the bitmap.

Remarks

The bitmap appears only for tabbed windows. The bitmap's index must match the bitmap's resource ID, which you specify with the BitmapResource property.

Examples

The following example retrieves the index that is assigned to the bitmap that you want to use as an icon on your tool window tab.

protected override int BitmapIndex
{
     get { return 0; }
}

.NET Framework Security

See Also

Reference

ToolWindow Class

Microsoft.VisualStudio.Modeling.Shell Namespace