NewDriveListBox

Description

Adds a drive listbox control to a form.

Syntax

[Set oCtl =] oFrm.NewDriveListBox

( Name, Left, Top, Width, [Container] )

Parameters

Part

Description

Set oCtl =

(optional) Store a reference to the new control in the variable oCtl. This variable can be used to access the control's properties and methods.

oFrm

A reference to a form object (see the NewForm method)

Name

The name of the control. It must be unique within the form and may not be empty or start with an asterisk (*)

Left

See the list of properties below

Top

See the list of properties below

Width

See the list of properties below

Container

(optional) The name of an existing frame control that will act as container for the listbox. If unspecified or an empty string, the Form itself will be the container. Please note that the Left and Top properties are relative to the container's left and top edges

Properties and Methods

Property

Description

BackColor

Background color (use the RGB function to assign a color value)

Drive

(string) Returns or sets the selected drive. The default is the current drive.
When setting this property only the first character of the string is significant. Selecting a drive that isn't present (anymore) causes an error. When reading this property, the drive is returned in one of the following formats :



Floppy disks
Fixed media
Network connections

"a:" or "b:", and so on
"c: [volume id]"
"x: \\server\share"

Enabled

(boolean) Determines if the control can respond to user-generated events

Fontname

The font used to display text. The default is determined by the system. Check the glossary for an explanation about setting font properties.

Fontsize

The size of the font in points. The maximum is 2160 points.

Fontbold

(boolean) Enable or disable the bold style of a font

Fontitalic

(boolean) Enable or disable the italic style of a font

Fontstrikethru

(boolean) Enable or disable the strikethru style of a font

Fontunderline

(boolean) Enable or disable the underline style of a font

ForeColor

Foreground color (use the RGB function to assign a color value)

Height

(read-only) The height of the control in twips

Left

The distance from the left edge of the specified container in twips

List (index)

(read-only) The text of an item in the list at the specified index. The first item has index 0 and the index of the last item is ListCount – 1.

ListCount

(read-only) The total number of items in the list

ListIndex

(integer) Returns or set the index of the currently selected item in the list

-1

(default) Indicates the index of the current drive when the control is created at run time

n

A number indicating the index of the currently selected item. The index of the first item is 0 and the index of the last item is ListCount – 1

Parent

(read-only) Returns the parent form, object or collection. You can use the parent property to access the properties and methods of an object's parent

TabStop

(boolean) Determines whether the TAB key can be used to move the focus

Tag

(reserved) Used internally to store the user-defined controlname

ToolTipText

Explanatory text that appears in a small rectangle below the object when you pause the mouse pointer (hover) over it for about one second

Top

The distance from the top edge of the specified container in twips

TopIndex

(integer) The index of the item displayed in the topmost position

Visible

(boolean) Determines whether the control is visible or hidden

Width

The width of the control in twips

Method

Description

Move

Parameters: left [, top [, width ]]

Only the left argument is required. However, to specify any other arguments, you must specify all arguments that appear in the syntax before the argument you want to specify. For example, you can't specify width without specifying left and top. Any trailing arguments that are unspecified remain unchanged

Refresh

Forces a complete repaint of a control

SetFocus

Moves the focus to the specified control

Event

Description

Event raised

Change

Occurs when the user selects a new drive or when you change the Drive property setting through code

Controlname

To be able to handle events you need to operate a form in callback mode.
This subject is described in the following topics:
Callback forms, ClickHandler

Example

See the NewFileListBox page for a complete, integrated example of using the three related controls; the DriveListBox , DirListBox and FileListBox controls.