| Home | Translations | Download | Forum | Bug Tracker

|  | v1.3.7

List
Normal listbox control.
Control Styles
These control styles are available when creating a List control. Remember that the general styles disabled, group, notheme, tabstop and transparent apply to all DCX controls.
alpha | Control is alpha blended.
extsel | Allows multiple items to be selected.
multi | Turns string selection on or off each time the user clicks or double-clicks a string in the list box. The user can select any number of strings.
nointegral | Specifies that the size of the list box is exactly the size specified by the application when it created the list box. Normally, the system sizes a list box so that the list box does not display partial items.
noscroll | Shows a disabled vertical scroll bar for the list box when the box does not contain enough items to scroll. If you do not specify this style, the scroll bar is hidden when the list box does not contain enough items.
nosel | Specifies that the list box contains items that can be viewed but not selected.
vsbar | Specifies that the list box should display a vertical scrollbar when it overflows.
/xdid flags
Control commands are input to the control with the /xdid command.
/xdid -a
This command lets you add a new item to the listbox.
Syntax: | /xdid -a [DNAME] [ID] [N] [Item Text]
Example: | /xdid -a dcx 4 0 New Item
Note. You can use 0 for N to insert at the end of the listbox.
/xdid -c
This command lets you select items in the listbox.
Syntax: | /xdid -c [DNAME] [ID] [N(,N,...)]
Example: | /xdid -c dcx 4 1,2,3
Note. In a single line listbox, you only provide the line number to select.
/xdid -d
This command lets you delete an item in the listbox.
Syntax: | /xdid -d [DNAME] [ID] [N]
Example: | /xdid -d dcx 4 1
/xdid -o
This command lets you overwrite an item in the listbox.
Syntax: | /xdid -o [DNAME] [ID] [N] [Item Text]
Example: | /xdid -o dcx 4 1 New Text
/xdid -r
This command lets you clear the listbox contents.
Syntax: | /xdid -r [DNAME] [ID]
Example: | /xdid -r dcx 4
/xdid -u
This command lets you unselect items the listbox.
Syntax: | /xdid -u [DNAME] [ID]
Example: | /xdid -u dcx 4
$xdid() Properties
The $xdid identifier is a given mIRC alias that communicates with the DCX DLL to extract information in DCX controls.
$xdid().num
This property lets you retreive the number of listbox items.
Syntax: | $xdid(dialog, ID).num
Example: | $xdid(dcx, 4).num
$xdid().sel
This property lets you retreive the indexes of selected items in the list.
Syntax: | $xdid(dialog, ID, (N)).sel
Example: | $xdid(dcx, 4, 2).sel
Parameters:
N | Optional parameter allowing you to obtain the Nth selected index.
Note. If the list is multi, and N is not supplied, then this command will return a comma-separated list of the selected indexes. If N is 0, then this will return the number of lines selected. When using this property without N, the result is limited to 900 characters. This is due to an implementation that mIRC has imposed on DLL communication, so it is advised to use the N parameter to prevent inaccurate results.
$xdid().tbitem
This property lets you retreive top and bottom visible item indexes.
Syntax: | $xdid(dialog, ID).tbitem
Example: | $xdid(dcx, 4).tbitem
$xdid().text
This property lets you retreive the Nth listbox item text.
Syntax: | $xdid(dialog, ID, N).text
Example: | $xdid(dcx, 4, 2).text
List Events
These events are fired when activity occurs in the List control.
dclick
When an item is double-clicked in the listbox.
Syntax: | /cb_alias DNAME dclick ID ITEM
Example: | /cb_alias dcx dclick 4
Parameters:
ITEM | Item number where the event was triggered.
dragbegin
Triggers when one or more files are dropped onto the control.
Syntax: | /cb_alias DNAME dragbegin ID COUNT
Example: | /cb_alias dcx dragbegin 4 3
Parameters:
COUNT | Total number of files dragged into the control.
Return | cancel to stop the drag drop events from occuring.
dragfile
The filename of the file that has
Syntax: | /cb_alias DNAME dragfile ID FILENAME
Example: | /cb_alias dcx dragfile 4 C:\mIRC\blah.txt
dragfinish
Event triggered when processing of drag drop is complete.
Syntax: | /cb_alias DNAME dragfinish ID
Example: | /cb_alias dcx dragfinish 4
help
Launched when you click on a control using the ? contexthelp button.
Syntax: | /cb_alias DNAME help ID
Example: | /cb_alias dcx help 4
rclick
When you right-click on the list.
Syntax: | /cb_alias DNAME rclick ID
Example: | /cb_alias dcx rclick 4
sclick
When an item is selected in the listbox.
Syntax: | /cb_alias DNAME sclick ID ITEM
Example: | /cb_alias dcx sclick 4
Parameters:
ITEM | Item number where the event was triggered.
scrollend
Event triggered when the list has finished scrolling.
Syntax: | /cb_alias DNAME scrollend ID
Example: | /cb_alias dcx scrollend 4
| Control Styles alpha extsel multi nointegral noscroll nosel vsbar /xdid Flags -a -c -d -o -r -u $xdid() Properties num sel tbitem text Events dclick dragbegin dragfile dragfinish help rclick sclick scrollend

Contact | © 2005-2006 | Last Updated: 14th January, 07