ToolBar.ToolBarButtonCollection.IndexOf メソッド

.NET Framework クラス ライブラリ リファレンス

ToolBar.ToolBarButtonCollection.IndexOf メソッド

コレクション内の指定したツール バー ボタンのインデックスを取得します。

名前空間: System.Windows.Forms
アセンブリ: System.Windows.Forms (system.windows.forms.dll 内)
構文

Visual Basic (宣言)

Public Function IndexOf ( _
    button As ToolBarButton _
) As Integer

Visual Basic (使用法)

Dim instance As ToolBarButtonCollection
Dim button As ToolBarButton
Dim returnValue As Integer

returnValue = instance.IndexOf(button)

C#

public int IndexOf (
    ToolBarButton button
)

C++

public:
int IndexOf (
    ToolBarButton^ button
)

J#

public int IndexOf (
    ToolBarButton button
)

JScript

public function IndexOf (
    button : ToolBarButton
) : int

パラメータ

button

コレクション内で検索する ToolBarButton。

戻り値
項目がコレクションに存在する場合は、その項目の 0 から始まるインデックス。それ以外の場合は -1。

解説

このメソッドにより、簡単にコレクション内の ToolBarButton のインデックス値にアクセスできます。インデックス値を使用すると、ToolBar でどの ToolBarButton をクリックするか簡単に決定できます。クリックされた ToolBarButton は、ToolBarButtonClickEventArgs.Button プロパティの IndexOf 値を評価することにより決定されます。

使用例

ToolBar と 3 つの ToolBarButton コントロールを作成するコード例を次に示します。ツール バー ボタンはボタン コレクションに割り当てられ、コレクションはツール バーに割り当てられ、ツール バーはフォームに追加されます。ツール バーの ButtonClick イベントが発生すると、ToolBarButtonClickEventArgs の Button プロパティが評価され、該当するダイアログ ボックスが開きます。このコードは、Form、OpenFileDialog、SaveFileDialog、および PrintDialog がすべて作成されていることを前提にしています。

Visual Basic

Public Sub InitializeMyToolBar()
    ' Create and initialize the ToolBar and ToolBarButton controls.
    Dim toolBar1 As New
 ToolBar()
    Dim toolBarButton1 As New
 ToolBarButton()
    Dim toolBarButton2 As New
 ToolBarButton()
    Dim toolBarButton3 As New
 ToolBarButton()
    
    ' Set the Text properties of the ToolBarButton controls.
    toolBarButton1.Text = "Open"
    toolBarButton2.Text = "Save"
    toolBarButton3.Text = "Print"
    
    ' Add the ToolBarButton controls to the ToolBar.
    toolBar1.Buttons.Add(toolBarButton1)
    toolBar1.Buttons.Add(toolBarButton2)
    toolBar1.Buttons.Add(toolBarButton3)
    
    ' Add the event-handler delegate.
    AddHandler toolBar1.ButtonClick, AddressOf
 toolBar1_ButtonClick
    
    ' Add the ToolBar to the Form.
    Controls.Add(toolBar1)
End Sub    

Private Sub toolBar1_ButtonClick(ByVal
 sender As Object, _
ByVal e As ToolBarButtonClickEventArgs)

    ' Evaluate the Button property to determine which button was clicked.
    Select Case toolBar1.Buttons.IndexOf(e.Button)
        Case 0
            openFileDialog1.ShowDialog()
            ' Insert additional code here to open the file.
        Case 1
            saveFileDialog1.ShowDialog()
            ' Insert additional code here to save the file.
        Case 2
            printDialog1.ShowDialog()
            ' Insert additional code here to print the file.    
    End Select
End Sub

C#

public void InitializeMyToolBar()
 {
    // Create and initialize the ToolBar and ToolBarButton controls.
    toolBar1 = new ToolBar();
    ToolBarButton toolBarButton1 = new ToolBarButton();
    ToolBarButton toolBarButton2 = new ToolBarButton();
    ToolBarButton toolBarButton3 = new ToolBarButton();
 
    // Set the Text properties of the ToolBarButton controls.
    toolBarButton1.Text = "Open";
    toolBarButton2.Text = "Save";
    toolBarButton3.Text = "Print";
 
    // Add the ToolBarButton controls to the ToolBar.
    toolBar1.Buttons.Add(toolBarButton1);
    toolBar1.Buttons.Add(toolBarButton2);
    toolBar1.Buttons.Add(toolBarButton3);
    
    // Add the event-handler delegate.
    toolBar1.ButtonClick += new ToolBarButtonClickEventHandler(
       toolBar1_ButtonClick);
    
    // Add the ToolBar to the Form.
    Controls.Add(toolBar1);
 }
 
 private void toolBar1_ButtonClick (
                         Object sender, 
                         ToolBarButtonClickEventArgs e)
 {
   // Evaluate the Button property to determine which button was clicked.
   switch(toolBar1.Buttons.IndexOf(e.Button))
   {
      case 0:
         openFileDialog1.ShowDialog();
         // Insert additional code here to open the file.
         break; 
      case 1:
         saveFileDialog1.ShowDialog();
         // Insert additional code here to save the file.
         break; 
      case 2:
         printDialog1.ShowDialog();
         // Insert additional code here to print the file.    
         break; 
    }
 }

C++

public:
   void InitializeMyToolBar()
   {
      // Create and initialize the ToolBar and ToolBarButton controls.
      toolBar1 = gcnew ToolBar;
      ToolBarButton^ toolBarButton1 = gcnew ToolBarButton;
      ToolBarButton^ toolBarButton2 = gcnew ToolBarButton;
      ToolBarButton^ toolBarButton3 = gcnew ToolBarButton;
      
      // Set the Text properties of the ToolBarButton controls.
      toolBarButton1->Text = "Open";
      toolBarButton2->Text = "Save";
      toolBarButton3->Text = "Print";
      
      // Add the ToolBarButton controls to the ToolBar.
      toolBar1->Buttons->Add( toolBarButton1 );
      toolBar1->Buttons->Add( toolBarButton2 );
      toolBar1->Buttons->Add( toolBarButton3 );
      
      // Add the event-handler delegate.
      toolBar1->ButtonClick += gcnew ToolBarButtonClickEventHandler(
         this, &Form1::toolBar1_ButtonClick );
      
      // Add the ToolBar to the Form.
      Controls->Add( toolBar1 );
   }

private:
   void toolBar1_ButtonClick(
      Object^ sender,
      ToolBarButtonClickEventArgs^ e )
   {
      // Evaluate the Button property to determine which button was
 clicked.
      switch ( toolBar1->Buttons->IndexOf( e->Button
 ) )
      {
         case 0:
            openFileDialog1->ShowDialog();
            // Insert additional code here to open the file.
            break;
         case 1:
            saveFileDialog1->ShowDialog();
            // Insert additional code here to save the file.
            break;
         case 2:
            printDialog1->ShowDialog();
            // Insert additional code here to print the file.    
            break;
      }
   }

プラットフォーム

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0、1.0

参照

関連項目
ToolBar.ToolBarButtonCollection クラス
ToolBar.ToolBarButtonCollection メンバ
System.Windows.Forms 名前空間
ToolBarButtonClickEventArgs