HorizontalScrollbar Property

ListBox.HorizontalScrollbar Property

Gets or sets a value indicating whether a horizontal scroll bar is displayed in the control.

[Visual Basic]
Public Property HorizontalScrollbar As Boolean
[C#]
public bool HorizontalScrollbar {get; set;}
[C++]
public: __property bool get_HorizontalScrollbar();
public: __property void set_HorizontalScrollbar(bool);
[JScript]
public function get HorizontalScrollbar() : Boolean;
public function set HorizontalScrollbar(Boolean);

Property Value

true to display a horizontal scroll bar in the control; otherwise, false. The default is false.

Remarks

The HorizontalScrollbar property determines whether the ListBox should display a horizontal scroll bar when the width of items within the ListBox extend beyond the right edge of the control. When this property is set to true, the scroll bar is automatically displayed based on the width of items in the ListBox. If the ListBox is an owner-drawn list box, in order to properly display a horizontal scroll bar, you must set the HorizontalExtent property.

Example

[Visual Basic, C#, C++] The following example demonstrates how to use the HorizontalScrollbar and HorizontalExtent properties to display a horizontal scroll bar that shows all item text in the ListBox control. The example also uses the IntegralHeight property to ensure that items are not partially displayed due to the size of the ListBox control. This example assumes that a ListBox control, named listBox1, has been added to a form.

[Visual Basic] 
Private Sub DisplayHScroll()
   ' Make no partial items are displayed vertically.
   listBox1.IntegralHeight = True
   Dim x As Integer

   ' Add items that are wide to the ListBox.
   For x = 0 To 10
      listBox1.Items.Add("Item  " + x.ToString() + " is a very large value that requires scroll bars")
   Next x

   ' Display a horizontal scroll bar.
   listBox1.HorizontalScrollbar = True

   ' Create a Graphics object to use when determining the size of the largest item in the ListBox.
   Dim g As System.Drawing.Graphics = listBox1.CreateGraphics()


   ' Determine the size for HorizontalExtent using the MeasureString method using the last item in the list.
   Dim hzSize As Integer = g.MeasureString(listBox1.Items(listBox1.Items.Count - 1).ToString(), listBox1.Font).Width
   ' Set the HorizontalExtent property.
   listBox1.HorizontalExtent = hzSize
End Sub

[C#] 
private void DisplayHScroll()
{
   // Make no partial items are displayed vertically.
   listBox1.IntegralHeight = true;

   // Add items that are wide to the ListBox.
   for (int x = 0; x < 10; x++)
   {
      listBox1.Items.Add("Item  " + x.ToString() + " is a very large value that requires scroll bars");
   }

   // Display a horizontal scroll bar.
   listBox1.HorizontalScrollbar = true;

   // Create a Graphics object to use when determining the size of the largest item in the ListBox.
   Graphics g = listBox1.CreateGraphics();

   // Determine the size for HorizontalExtent using the MeasureString method using the last item in the list.
   int hzSize = (int) g.MeasureString(listBox1.Items[listBox1.Items.Count -1].ToString(),listBox1.Font).Width;
   // Set the HorizontalExtent property.
   listBox1.HorizontalExtent = hzSize;
}

[C++] 
private:
   void DisplayHScroll() {
      // Make no partial items are displayed vertically.
      listBox1->IntegralHeight = true;

      // Add items that are wide to the ListBox.
      for (int x = 0; x < 10; x++) {
         listBox1->Items->Add( String::Format( S"Item {0} is a very large value that requires scroll bars", __box(x)) );
      }

      // Display a horizontal scroll bar.
      listBox1->HorizontalScrollbar = true;

      // Create a Graphics object to use when determining the size of the largest item in the ListBox.
      Graphics* g = listBox1->CreateGraphics();

      // Determine the size for HorizontalExtent using the MeasureString method using the last item in the list.
      int hzSize = (int) g->MeasureString(dynamic_cast<String __gc *>(listBox1->Items->Item[listBox1->Items->Count -1]), listBox1->Font).Width;
      // Set the HorizontalExtent property.
      listBox1->HorizontalExtent = hzSize;
   }

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

See Also

ListBox Class | ListBox Members | System.Windows.Forms Namespace | HorizontalExtent

Show:
© 2016 Microsoft