ListBox.TopIndex ListBox.TopIndex ListBox.TopIndex ListBox.TopIndex Property

定義

ListBox に最初に表示される項目のインデックスを取得または設定します。Gets or sets the index of the first visible item in the ListBox.

public:
 property int TopIndex { int get(); void set(int value); };
[System.ComponentModel.Browsable(false)]
public int TopIndex { get; set; }
member this.TopIndex : int with get, set
Public Property TopIndex As Integer

プロパティ値

コントロールに最初に表示される項目の 0 から始まるインデックス番号。The zero-based index of the first visible item in the control.

プロパティをSelectedIndex TopIndexプロパティと共に使用して、 ListBox現在選択されている項目をの表示領域内の項目リストの先頭に移動する方法を次のコード例に示します。The following code example demonstrates how to use the SelectedIndex property with the TopIndex property to move the currently selected item to the top of the list of items in the display area of the ListBox. この例では、 RemoveAt System.Windows.Forms.ListBox.ObjectCollectionクラスのメソッドを使用して項目を削除する方法と、 ClearSelectedメソッドを使用してすべての項目選択をクリアする方法についてさらに説明します。The example further demonstrates how to remove items using the RemoveAt method of the System.Windows.Forms.ListBox.ObjectCollection class, and how to clear all item selection using the ClearSelected method. コードはまず、 ListBox内の現在選択されている項目をリストの先頭に移動します。The code first moves the currently selected item in the ListBox to the top of the list. 次に、現在選択されている項目の前にあるすべてのListBox項目を削除し、で選択した項目をすべてクリアします。The code then removes all items before the currently selected item and clears all selections in the ListBox. この例ListBox ListBoxでは、を含むアイテムがフォームに追加されていること、およびでアイテムが現在選択されていることが必要です。This example requires that a ListBox containing items is added to a form and that an item is currently selected in the ListBox.

private:
   void RemoveTopItems()
   {
      // Determine if the currently selected item in the ListBox 
      // is the item displayed at the top in the ListBox.
      if ( listBox1->TopIndex != listBox1->SelectedIndex )

      // Make the currently selected item the top item in the ListBox.
      listBox1->TopIndex = listBox1->SelectedIndex;

      // Remove all items before the top item in the ListBox.
      for ( int x = (listBox1->SelectedIndex - 1); x >= 0; x-- )
      {
         listBox1->Items->RemoveAt( x );
      }

      // Clear all selections in the ListBox.
      listBox1->ClearSelected();
   }
private void RemoveTopItems()
{
   // Determine if the currently selected item in the ListBox 
   // is the item displayed at the top in the ListBox.
   if (listBox1.TopIndex != listBox1.SelectedIndex)
      // Make the currently selected item the top item in the ListBox.
      listBox1.TopIndex = listBox1.SelectedIndex;

   // Remove all items before the top item in the ListBox.
   for (int x = (listBox1.SelectedIndex -1); x >= 0; x--)
   {
      listBox1.Items.RemoveAt(x);
   }

   // Clear all selections in the ListBox.
   listBox1.ClearSelected();
}
Private Sub RemoveTopItems()
   ' Determine if the currently selected item in the ListBox 
   ' is the item displayed at the top in the ListBox.
   If listBox1.TopIndex <> listBox1.SelectedIndex Then
      ' Make the currently selected item the top item in the ListBox.
      listBox1.TopIndex = listBox1.SelectedIndex
   End If
   ' Remove all items before the top item in the ListBox.
   Dim x As Integer
   For x = listBox1.SelectedIndex - 1 To 0 Step -1
      listBox1.Items.RemoveAt(x)
   Next x

   ' Clear all selections in the ListBox.
   listBox1.ClearSelected()
End Sub 'RemoveTopItems

注釈

初期状態では、インデックス位置がゼロ (0) の項目は、 ListBoxの可視領域の最上位にあります。Initially, the item with the index position zero (0) is at the top of the visible region of the ListBox. ListBox内容がスクロールされている場合は、コントロールの表示領域の上部に別の項目が表示されることがあります。If the contents of the ListBox have been scrolled, another item might be at the top of the control's display area. このプロパティを使用すると、 ListBox.ObjectCollection ListBoxコントロールの可視領域の上部に現在配置されている項目のの内のインデックスを取得できます。You can use this property to obtain the index within the ListBox.ObjectCollection for the ListBox of the item that is currently positioned at the top of the visible region of the control. このプロパティを使用して、コントロールの表示領域の上部にあるリストに項目を配置することもできます。You can also use this property to position an item in the list at the top of the visible region of the control.

適用対象