ListIcon Help File

ListIcon Help File

Plugin Name:

ListIcon

Current Version:

1.0.0.0


Table of Contents

ListIcon.Create
ListIcon.AddColumn
ListIcon.RemoveColumn
ListIcon.CountColumns
ListIcon.AddRow
ListIcon.RemoveRow
ListIcon.LoadIcon
ListIcon.CountRows
ListIcon.SetSelected
ListIcon.GetSelected
ListIcon.SetItemSelected
ListIcon.GetItemSelected
ListIcon.SetItemChecked
ListIcon.GetItemChecked
ListIcon.SetDisplayType
ListIcon.Redraw

ListIcon.Create


(number) ListIcon.Create ( 

(number) ListIconID,

(number) WindowID,

(string) Title,

(number) TitleWidth,

(string) Flags )

Description

Creates a ListIcon object and embeds it into the window passed in the WindowID argument.

Note: Once a ListIcon is created, its list of items is empty.

Parameters

ListIconID

(number) The numeric ID that will be used to perform actions on this ListIcon.

WindowID

(number) The window handle of the container for the ListIcon.

Title

(string) 'Title' is the first column title

TitleWidth

(number) 'TitleWidth' its initial width (in pixels) of the first column.

Flags

(string) Set various flags.

Note: Flags are always optional.
More than one flag can be passed, join valiable flags with (..) and use direct values like 46 would set LV_FullRowSelect and LV_AlwaysShowSelection.

CONSTANT

VALUE

DESCRIPTION

LV_CheckBoxes

1

Display checkboxes in the first column.

LV_MultiSelect

2

Enable multiple selection.

LV_GridLines

3

Display separator lines between rows and columns.

LV_FullRowSelect

4

The selection covers the full row instead of the first column.

LV_HeaderDragDrop

5

The order of columns can be changed using drag'n'drop.

LV_AlwaysShowSelection

6

The selection is still visible, even when the object does not have focus.

Returns

(number)


ListIcon.AddColumn


(number) ListIcon.AddColumn ( 

(number) ListIconID,

(number) Column,

(number) Width,

(string) Title )

Description

Adds a column to the specified ListIcon

Note: When you add a column, all the old columns which are on the right of the new column will have a position which is one more than they previously had.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Column

(number) The position specifies the column index where the new item should be inserted.

Note: Column indexes start from 1, which is the leftmost column, and increase by 1 for each column to the right.

Width

(number) The initial Width of the new column.

Title

(string) The title for this new column.

Returns

(number)


ListIcon.RemoveColumn


ListIcon.RemoveColumn ( 

(number) ListIconID,

(number) Column )

Description

Removes a column from the specified ListIcon

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Column

(number) The position specifies the column index that should be removed.

Note: Column indexes start from 1, which is the leftmost column, and increase by 1 for each column to the right.

Returns

This action dose not return any value.


ListIcon.CountColumns


(number) ListIcon.CountColumns ( 

(number) ListIconID )

Description

Returns the number of columns in a listview object.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Note: Column indexes start from 1, which is the leftmost column, and increase by 1 for each column to the right.

Returns

(number)


ListIcon.AddRow


(number) ListIcon.AddRow ( 

(number) ListIconID,

(string) RowText )

Description

Adds a row of items to the specified ListIcon.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

RowText

(string) The position specifies the column index where the new item should be inserted.

Note: Column indexes start from 1, which is the leftmost column, and increase by 1 for each column to the right.

Returns

(number) If you want to add content to ListIcons with several columns using ListIcon.AddRow(), you should use the format "first column"..String.Char(10).."second one" as RowText parameter.


ListIcon.RemoveRow


ListIcon.RemoveRow ( 

(number) ListIconID,

(number) Row )

Description

Removes a row from the specified ListIcon

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) The position specifies the row index that should be removed.

Note: Row indexes start from 1, which is the first row.

Returns

This action dose not return any value.


ListIcon.LoadIcon


ListIcon.LoadIcon ( 

(string) ImagePath )

Description

Returns a image handle from the ImagePath, this image can then be displayed in the ListIcon object.

Parameters

ImagePath

(string) The full path to the image to load (.bmp, .png and .ico formats supported)

Returns

This action dose not return any value.


ListIcon.CountRows


(number) ListIcon.CountRows ( 

(number) ListIconID )

Description

Returns the number of rows in a listview object.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Returns

(number)


ListIcon.SetSelected


ListIcon.SetSelected ( 

(number) ListIconID,

(number) Row )

Description

Sets the selected row in a ListIcon object.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) The Index of the row you want to select.

Note: Row indexes start from 1, which is the first row.

Returns

This action dose not return any value.


ListIcon.GetSelected


(number) ListIcon.GetSelected ( 

(number) ListIconID )

Description

Gets the selected row in a ListIcon object.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Returns

(number)


ListIcon.SetItemSelected


ListIcon.SetItemSelected ( 

(number) ListIconID,

(number) Row,

(boolean) Selected )

Description

Sets the row selected in a ListIcon object with the LV_MultiSelect used in ListIvon.Create()

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) Row indexes start from 1, which is the first row.

Selected

(boolean) True is the row is selected.

Returns

This action dose not return any value.


ListIcon.GetItemSelected


(boolean) ListIcon.GetItemSelected ( 

(number) ListIconID,

(number) Row )

Description

Checks if a row is selected.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) The Index of the row you want to get the selected state for.

Note: Row indexes start from 1, which is the first row.

Returns

(boolean)


ListIcon.SetItemChecked


ListIcon.SetItemChecked ( 

(number) ListIconID,

(number) Row,

(boolean) Checked )

Description

Sets a row checked state in a ListIcon object with the LV_CheckBoxes used in ListIvon.Create()

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) The Index of the row you want to check.

Note: Row indexes start from 1, which is the first row.

Checked

(boolean) True is the row is checked.

Returns

This action dose not return any value.


ListIcon.GetItemChecked


(boolean) ListIcon.GetItemChecked ( 

(number) ListIconID,

(number) Row )

Description

Gets a row checked state in a ListIcon object with the LV_CheckBoxes used in ListIvon.Create()

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Row

(number) The Index of the row you want to get the checked state for.

Note: Row indexes start from 1, which is the first row.

Returns

(boolean)


ListIcon.SetDisplayType


ListIcon.SetDisplayType ( 

(number) ListIconID,

(number) DisplayType )

Description

Sets a ListIcon objects display mode,

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

DisplayType

(number) A ListIcon can have four display modes, each a little different, small icon, large icon, list and report (column).

CONSTANT

VALUE

DESCRIPTION

LV_Report

1

Report mode (columns, default mode)

LV_List

2

List mode

LV_SmallIcon

3

Small Icon mode

LV_LargeIcon

4

Large Icon mode

Returns

This action dose not return any value.


ListIcon.Redraw


ListIcon.Redraw ( 

(number) ListIconID )

Description

Redraws the listicon inside its parent container, use when resizing.

Parameters

ListIconID

(number) The numeric ID of the ListIcon object.

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor