ListBox.PreferredHeight Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

ListBox.cs

Gets the combined height of all items in the ListBox.

public:
 property int PreferredHeight { int get(); };

[System.ComponentModel.Browsable(false)]
public int PreferredHeight { get; }

[<System.ComponentModel.Browsable(false)>]
member this.PreferredHeight : int

Public ReadOnly Property PreferredHeight As Integer

Property Value

Int32

The combined height, in pixels, of all items in the control.

Attributes

BrowsableAttribute

Examples

The following code example demonstrates how to set the Size property of a ListBox based on the value of the PreferredHeight property in order to display all items in the ListBox without use of scroll bars. This example requires that a ListBox control, named listBox1, has been added to a form.

private:
   void SizeMyListBox()
   {
      // Add items to the ListBox.
      for ( int x = 0; x < 20; x++ )
      {
         listBox1->Items->Add( String::Format( "Item {0}", x ) );
      }
      listBox1->Height = listBox1->PreferredHeight;
   }

private void SizeMyListBox()
{
   // Add items to the ListBox.
   for(int x = 0; x < 20; x++)
   {
      listBox1.Items.Add("Item " + x.ToString());
   }
   // Set the height of the ListBox to the preferred height to display all items.
   listBox1.Height = listBox1.PreferredHeight;
}

Private Sub SizeMyListBox()
   ' Add items to the ListBox.
   Dim x As Integer
   For x = 0 To 19
      listBox1.Items.Add(("Item " + x.ToString()))
   Next x
   ' Set the height of the ListBox to the preferred height to display all items.
   listBox1.Height = listBox1.PreferredHeight
End Sub

Remarks

This property enables you to determine the height that the ListBox needs to be sized to, in order to display every available item in the list and to avoid displaying vertical scroll bars. If the amount of items in the ListBox is large, sizing the control using the value of the PreferredHeight property might cause the ListBox to be sized outside of the client area of the form or the ListBox container.

See also

• Height