ControlFormat.List Method

  • Article
Excel Developer Reference

Returns or sets the text entries in the specified list box or a combo box, as an array of strings, or returns or sets a single text entry. An error occurs if there are no entries in the list.

Syntax

expression.List(Index)

expression   A variable that represents a ControlFormat object.

Parameters

Name Required/Optional Data Type Description
Index Optional Variant The index number of a single text entry to be set or returned. If this argument is omitted, the entire list is returned or set as an array of strings.

Return Value
Variant

Remarks

Setting this property clears any range specified by the ListFillRange property.

Example

This example sets the entries in a list box on worksheet one. If Shapes(2) doesn’t represent a list box, this example fails.

Visual Basic for Applications 
  Worksheets(1).Shapes(2).ControlFormat.List = _
    Array("cogs", "widgets", "sprockets", "gizmos")

This example sets entry four in a list box on worksheet one. If Shapes(2) doesn’t represent a list box, this example fails.

Visual Basic for Applications 
  Worksheets(1).Shapes(2).ControlFormat.List(4) = "gadgets"

See Also