Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.
This topic has not yet been rated - Rate this topic

ToolBar.BandIndex Property

Gets or sets the band index number that indicates the position of the toolbar on the band. This is a dependency property.

Namespace: System.Windows.Controls
Assembly: PresentationFramework (in presentationframework.dll)
XML Namespace:  http://schemas.microsoft.com/winfx/2006/xaml/presentation

public int BandIndex { get; set; }
/** @property */
public int get_BandIndex ()

/** @property */
public void set_BandIndex (int value)

public function get BandIndex () : int

public function set BandIndex (value : int)

<object BandIndex="int" .../>

Property Value

The position of a toolbar on the band of a ToolBarTray.

Identifier field

BandIndexProperty

Metadata properties set to true

None

If you do not explicitly set this property, its value is determined by the order in which the ToolBar is set in the ToolBarTray. For example, if you put two toolbars in a ToolBarTray without setting the Band and BandIndex properties, the value of Band will be 0 for both toolbars. The value of BandIndex will be 0 for the first toolbar and 1 for the second toolbar.

The position of the ToolBar in a ToolBarTray depends on the values of the ToolBarTray.Orientation, Band, and BandIndex properties. When Orientation is set to Horizontal, a band represents a row in the ToolBarTray. When Orientation is Vertical, a band represents a column of the ToolBarTray. The following table describes the relationship between Orientation, Band, and BandIndex.

Orientation

Band

BandIndex

Horizontal

Indicates the row in which the ToolBar is positioned. Toolbars that have Band set to smaller a value are above those with a larger value.

Indicates the position of the ToolBar on the Band. Toolbars that have BandIndex set to smaller a value are to the left of those with a larger value.

Vertical

Indicates the column in which the ToolBar is positioned. Toolbars that have Band set to smaller a value are to the left of those with a larger value.

Indicates the position of the ToolBar on the Band. Toolbars that have BandIndex set to smaller a value are above those with a larger value.

The following example shows how use this property to place ToolBar controls inside a ToolBarTray.

<ToolBarTray Background="White">
            <ToolBar Band="1" BandIndex="1">
                <Button><Image Source="toolbargraphics\cut.bmp" /></Button>
                <Button><Image Source="toolbargraphics\copy.bmp" /></Button>
                <Button><Image Source="toolbargraphics\paste.bmp" /></Button>
           </ToolBar>
           <ToolBar Band="2" BandIndex="1">
                <Button><Image Source="toolbargraphics\undo.bmp" /></Button>
                <Button><Image Source="toolbargraphics\redo.bmp" /></Button>
           </ToolBar>
           <ToolBar Band="2" BandIndex="2">
                <Button><Image Source="toolbargraphics\paint.bmp" /></Button>
                <Button><Image Source="toolbargraphics\spell.bmp" /></Button>
                <Separator/>
                <Button><Image Source="toolbargraphics\save.bmp" /></Button>
                <Button><Image Source="toolbargraphics\open.bmp" /></Button>
           </ToolBar>
        </ToolBarTray>

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft. All rights reserved.