CheckList Action Plugin Help File

CheckList Action Plugin Help File

Plugin Name:

CheckList Action Plugin

Current Version:

1.0.0.0

Licence:

Freeware

Author:

RizlaUK


Table of Contents

CheckList.SetChecked
CheckList.GetChecked
CheckList.SetText
CheckList.GetText
CheckList.Init
CheckList.AddItem
CheckList.GetEnabled
CheckList.SetEnabled
CheckList.GetVisible
CheckList.SetVisible

CheckList.SetChecked


CheckList.SetChecked ( 

(number) ListItemID,

(boolean) Checked )

Description

Sets the checklist items checked state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Checked

(boolean) True if the item should be checked.

Returns

This action dose not return any value.


CheckList.GetChecked


(boolean) CheckList.GetChecked ( 

(number) ListItemID )

Description

Gets the checklist items checked state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Returns

(boolean)


CheckList.SetText


CheckList.SetText ( 

(number) ListItemID,

(string) Text )

Description

Sets the checklist items text.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Text

(string) The new text for the item.

Returns

This action dose not return any value.


CheckList.GetText


(string) CheckList.GetText ( 

(number) ListItemID )

Description

Gets the checklist items text.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Returns

(string)


CheckList.Init


CheckList.Init ( 

(number) HostHandle,

(number) ListID,

(number) BackColor = 16777215,

(number) Border = 0 )

Description

Creates the CheckList object

Parameters

HostHandle

(number) The window handle of the host container (ListBox)

ListID

(number) This is the ID of the list, used later to perform actions on the list.

BackColor

(number) The color of the list background.

Border

(number) The list border type.

CONSTANT

VALUE

DESCRIPTION

CL_BorderLess

0

Without any border (Default).

CL_Flat

1

Flat frame.

CL_Raised

2

Raised frame.

CL_Single

4

Single sunken frame.

CL_Double

8

Double sunken frame.

Returns

This action dose not return any value.


CheckList.AddItem


CheckList.AddItem ( 

(number) ListID,

(number) ListItemID,

(string) Text,

(number) TextColor = 0,

(number) Align = 0 )

Description

Adds a checkbox item to the in memory checklist.

Parameters

ListID

(number) This is the ID of the list, used later to perform actions on the list.

ListItemID

(number) The numeric ID of the checklist item.

Note: CheckList items always start from a index of 1 above the ListID, so a ListID of 100 will have items 101, 102, 103 etc)

Text

(string) The text to be displayed next to the checkbox.

TextColor

(number) The color of the checkbox text.

Align

(number) Align the text for the checkbox.

CONSTANT

VALUE

DESCRIPTION

CL_Right

512

Aligns the text To right.

CL_Center

768

Centers the text to the center.

Returns

This action dose not return any value.


CheckList.GetEnabled


(boolean) CheckList.GetEnabled ( 

(number) ListItemID )

Description

Gets the checklist items enabled state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Returns

(boolean)


CheckList.SetEnabled


CheckList.SetEnabled ( 

(number) ListItemID,

(boolean) Enabled )

Description

Sets the checklist items enabled state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Enabled

(boolean) True if the item should be enabled.

Returns

This action dose not return any value.


CheckList.GetVisible


(boolean) CheckList.GetVisible ( 

(number) ListItemID )

Description

Gets the checklist items visible state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Returns

(boolean)


CheckList.SetVisible


CheckList.SetVisible ( 

(number) ListItemID,

(boolean) Visible )

Description

Sets the checklist items visible state.

Parameters

ListItemID

(number) The numeric ID of the checklist item.

Visible

(boolean) True if the item should be made visible.

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor