Accessors for class IlvStringList

Properties

Methods

Description

The IlvStringList class lets you display and manipulate lists of IlvGadgetItem objects.

The main callback manages double-click events.

TypeNameDescriptionNotes
BooleanautoLabelAlignmentSets the automatic label alignment mode. In this mode, a label offset is automatically computed to make sure that all the item's pictures are visible, and all the item's label are aligned.
Returns true if the automatic label alignment mode is enabled.
VoidaddLabel(String label)Adds a copy of the string label to the end of the list.
BooleandragdropSpecifies whether drag-and-drop operations are allowed for the list (true).
BooleaneditableSpecifies whether the list is editable (true).
BooleanexclusiveSets the exclusive selection mode for the string list (true). When the exclusive selection mode is set, only one label can be selected at a time. Returns false if more than one item can be selected.
ObjectfirstSelectedItemSets and returns the first item displayed in this list.
BooleanfullSelectionSpecifies whether the string list is in full selection mode.
ObjectgetItem(UInt index)Returns the item specified by the index parameter.
ObjectgetItemByName(String name)Returns the item whose name is specified as a parameter.
StringgetLabel(UInt index)Returns the label at the position indexth in the list.
BooleanhasTooltipsSpecifies whether the items in the list are associated with tooltips.
BooleanisSelected(UInt index)Specifies whether the label at the position index is selected.
UIntitemsCountReturns the number of strings stored in the object.
UIntitemsHeightSets the height of all the items in the list. If the height is set to 0, each item keeps its own height.
Returns the height of the items when all items are the same height. It returns 0 when the items are different heights.
UIntlabelOffsetSets the label offset. When a label offset is used, all the item's labels are aligned using the given offset.
Returns the offset used to display each item's label. It returns 0 if the list does not use an offset.
DirectionlabelPositionSets or returns the default position of the menu item labels relative to their picture.
StringArraylabelsReturns an array of count strings that includes all the items stored in the object.

The returned array is a static array, internally managed. Other Rogue Wave Views Views routines may overwrite this buffer so it should be copied in a safe place if it needs to be persistent.

VoidremoveLabel(UInt index)Removes the indexth item.
UIntArrayselectionReturns an array of strings that includes all the selected items.

The returned array is a static array, internally managed. Other Rogue Wave Views Views routines may overwrite this buffer so it should be copied in a safe place if it needs to be persistent.

IntselectionLimitGets or sets the maximum number of items that can be selected when the string list is not in exclusive mode. Set to -1 to have no limitation.
UIntselectionModeSets and returns the selection mode of the string list.
VoidsetLabel(UInt index, String label)Sets the label at the position index in the list to label.
BooleanshowLabelSpecifies whether the labels associated with the list items are displayed (true) or not (false).
BooleanshowPictureSpecifies whether the pictures associated with the list items are displayed (true) or not (false).
UIntspacingSets or gets the spacing between items.