TreeList Action Plugin Help File

TreeList Action Plugin Help File

Plugin Name:

TreeList Action Plugin

Current Version:

1.0.0.0

Description:

Adds a powerful yet easy to use advanced Tree object to your AMS projects.

Licence:

Commerical Plugin

More Info

Author:

Dean Hall (AKA) RizlaUK

Web:

luadevils.com

E-mail:

rizlauk@luadevils.com

Requirements:

Explorer objects require AMSWaves 'Memory' plugin for its call backsystem.

Memory Plugin

Copyright:

Copyright © 2010 Lua Devils

Install Notes:

Copy folder 'TreeList' to your AMS install directory '\Plugins\Actions'


Table of Contents

TreeList.AddColumn
TreeList.AddImage
TreeList.AddRow
TreeList.ClearRows
TreeList.CountColumns
TreeList.CountRows
TreeList.Create
TreeList.EnterKey
TreeList.ExtensionIcon
TreeList.ExtractIcon
TreeList.GetCellAlign
TreeList.GetCellBackColor
TreeList.GetCellFrontColor
TreeList.GetCellText
TreeList.GetColumnWidth
TreeList.GetEnable
TreeList.GetHeaderAlign
TreeList.GetHeaderHeight
TreeList.GetHeaderResize
TreeList.GetHeaderText
TreeList.GetPos
TreeList.GetRowChecked
TreeList.GetRowExpanded
TreeList.GetSelected
TreeList.GetSize
TreeList.GetUnpackPath
TreeList.GetVisible
TreeList.InsertColumn
TreeList.InsertRow
TreeList.LoadImage
TreeList.RemoveColumn
TreeList.RemoveImage
TreeList.RowImageIndex
TreeList.RowSubLevel
TreeList.SetBackColor
TreeList.SetCellAlign
TreeList.SetCellBackColor
TreeList.SetCellFrontColor
TreeList.SetCellText
TreeList.SetColumnWidth
TreeList.SetEnable
TreeList.SetFrontColor
TreeList.SetHeaderAlign
TreeList.SetHeaderHeight
TreeList.SetHeaderResize
TreeList.SetHeaderText
TreeList.SetPos
TreeList.SetRowChecked
TreeList.SetRowExpanded
TreeList.SetSelected
TreeList.SetSize
TreeList.SetUnpackPath
TreeList.SetVisible

TreeList.AddColumn


TreeList.AddColumn ( 

(number) TreeListID,

(string) Text,

(number) Width )

Description

Add a new column to the Treelist object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Text

(string) The title text for this column

Width

(number) The width of this column.

Returns

This action dose not return any value.


TreeList.AddImage


(number) TreeList.AddImage ( 

(number) TreeListID,

(number) ImageID )

Description

Adds an image to the objects imagelist.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

ImageID

(number) The numeric ID of the image.

Returns

(number) The index of this icon in the objects imagelist. (index starts at "1") if any error, nil is returned.


TreeList.AddRow


TreeList.AddRow ( 

(number) TreeListID,

(string) Text,

(number) ImageIndex = nil,

(number) SubLevel = nil )

Description

Add a new row to the Treelist object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Text

(string) The title text for this column

ImageIndex

(number) The index of the image

Note: This is the index of the image as returned with "TreeList.AddImage"

SubLevel

(number) The 0 based index of the rows sublevel

Returns

This action dose not return any value.


TreeList.ClearRows


TreeList.ClearRows ( 

(number) TreeListID )

Description

Clears all rows.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

This action dose not return any value.


TreeList.CountColumns


(number) TreeList.CountColumns ( 

(number) TreeListID )

Description

Counts the columns.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(number) The number of columns or 0 if any error.


TreeList.CountRows


(number) TreeList.CountRows ( 

(number) TreeListID,

(boolean) OnlyVisible = false )

Description

Counts the number of rows.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

OnlyVisible

(boolean) Treu to count only visible rows.

Returns

(number) The number of rows, or 0 if any error.


TreeList.Create


(number) TreeList.Create ( 

(number) X,

(number) Y,

(number) Width,

(number) Height,

(table) Flags = nil )

Description

Creates a TreeList object.

Parameters

X

(number) The X position of the object.

Y

(number) The Y position of the object.

Width

(number) The Width of the object.

Height

(number) The Height of the object.

Flags

(table) Optional falgs table.

CONSTANT

VALUE

DESCRIPTION

CheckBoxes

Boolean

Display checkboxes in the first column

FullRowSelect

Boolean

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

GridLines

Boolean

Display separator lines between rows and columns.

AlwaysShowSelection

Boolean

The selection is still visible, even when the gadget is not activated

HeaderDragDrop

Boolean

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

NoSortHeader

Boolean

The header dose not respone or send the "TreeList_HeaderItemClicked" event.

HeaderHeight

Number

The height of the header bar (Default = 0)

ColumnText

String

The text to display in the first column header. (Default = "")

ColumnWidth

Number

The width of the first column. (Default = 100)

RowHeight

Number

The default height for the tree rows. (Default=24)

Returns

(number) A unique numeric ID for this object, else nil if any error.


TreeList.EnterKey


TreeList.EnterKey ( 

(string) Key )

Description

Enter your serial key here.

Parameters

Key

(string) Your serial key.

Returns

This action dose not return any value.


TreeList.ExtensionIcon


(number) TreeList.ExtensionIcon ( 

(string) Extension )

Description

Gets the default system icon for the given file extension.

Note: File Types (.ico, ipng and .bmp) are supported.

Parameters

Extension

(string) the extension of the icon to extract.

Returns

(number) A numeric ID for this icon, else nil if any error.


TreeList.ExtractIcon


(number) TreeList.ExtractIcon ( 

(string) FilePath,

(number) IconIndex )

Description

Extracts a icon from a binary file (exe, dll etc)

Parameters

FilePath

(string) The path to the resource file.

IconIndex

(number) The index of the icon to extract.

Returns

(number) A numeric ID for this icon, else nil if any error.


TreeList.GetCellAlign


(number) TreeList.GetCellAlign ( 

(number) TreeListID,

(number) Row,

(number) Column )

Description

Gets the text alignment of a cell.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Returns

(number) The cell alignment, if any error, 0 is returned.
0 = Left (Default)
1 = Center
2 = Right


TreeList.GetCellBackColor


(number) TreeList.GetCellBackColor ( 

(number) TreeListID,

(number) Row,

(number) Column )

Description

Gets a cell's background color.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Returns

(number) The decimal color value, else -1 if any error.


TreeList.GetCellFrontColor


(number) TreeList.GetCellFrontColor ( 

(number) TreeListID,

(number) Row,

(number) Column )

Description

Gets a cell's text color.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Returns

(number) The decimal color value, else -1 if any error.


TreeList.GetCellText


(string) TreeList.GetCellText ( 

(number) TreeListID,

(number) Row,

(number) Column )

Description

Gets the text of a cell.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Returns

(string) The text displayed in the indecated cell, else if any error a blank string ("") is returned.


TreeList.GetColumnWidth


(number) TreeList.GetColumnWidth ( 

(number) TreeListID,

(number) Index )

Description

Gets the width of a column.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Returns

(number) The width of the column, else 0 if any error.


TreeList.GetEnable


(boolean) TreeList.GetEnable ( 

(number) TreeListID )

Description

Gets the enabled state of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(boolean) True if the object is enabled, false if not or if any error.


TreeList.GetHeaderAlign


(number) TreeList.GetHeaderAlign ( 

(number) TreeListID,

(number) Row,

(number) Column )

Description

Gets the text alignment of a column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index of the Row.

Column

(number) The 0 based index of the Column.

Returns

(number) The header alignment, if any error, 0 is returned.
0 = Left (Default)
1 = Center
2 = Right


TreeList.GetHeaderHeight


(number) TreeList.GetHeaderHeight ( 

(number) TreeListID )

Description

Sets the height of the column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(number) The height of the column header bar, else 0 if any error.


TreeList.GetHeaderResize


(boolean) TreeList.GetHeaderResize ( 

(number) TreeListID )

Description

Gets wether the columns can be resized.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(boolean) Treu if the header can resize the columns, false if not or if any error.


TreeList.GetHeaderText


(string) TreeList.GetHeaderText ( 

(number) TreeListID,

(number) Index )

Description

Gets the title text of a column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Returns

(string) The text displayed in the indecated header cell, else if any error a blank string ("") is returned.


TreeList.GetPos


(table) TreeList.GetPos ( 

(number) TreeListID )

Description

Gets the position of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(table) A table containing the object's current coordinates, indexed by values X and Y. If the object cannot be found, nil will be returned.


TreeList.GetRowChecked


(boolean) TreeList.GetRowChecked ( 

(number) TreeListID,

(number) Index )

Description

Gets the checked state of a row.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the row.

Returns

(boolean) True if the row is checked, false if not or if any error.


TreeList.GetRowExpanded


(boolean) TreeList.GetRowExpanded ( 

(number) TreeListID,

(number) Row )

Description

Gets the expanded state of a row.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Returns

(boolean) True if the row is expanded, false if not or if any error.


TreeList.GetSelected


(number) TreeList.GetSelected ( 

(number) TreeListID )

Description

Gets current selected item.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(number) The o based index of the selected item, -1 if no selection or if any error.


TreeList.GetSize


(table) TreeList.GetSize ( 

(number) TreeListID )

Description

Gets the size (in pixels) of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(table) A table containing the object's pixel dimensions, indexed by values "Width" and "Height." If the object cannot be found, nil will be returned.


TreeList.GetUnpackPath


(string) TreeList.GetUnpackPath ()

Description

Gets the unpack path for the intrenal dll.

Returns

(string) The path to the folder where the internal dll will be unpacked.


TreeList.GetVisible


(boolean) TreeList.GetVisible ( 

(number) TreeListID )

Description

Gets the visible state of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Returns

(boolean) True if the object is visible, false if not or if any error.


TreeList.InsertColumn


TreeList.InsertColumn ( 

(number) TreeListID,

(number) Index,

(string) Text,

(number) Width )

Description

Inserts a new column into the Treelist object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Text

(string) The title text for this column

Width

(number) The width of this column.

Returns

This action dose not return any value.


TreeList.InsertRow


TreeList.InsertRow ( 

(number) TreeListID,

(number) Row,

(string) Text,

(number) IconIndex = nil,

(number) SubLevel = nil )

Description

Inserts a new row into the Treelist object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the position to insert.

Text

(string) The title text for this column

IconIndex

(number) This is the index of the image.

Note: This is the index of the image as returned with "TreeList.AddImage"

SubLevel

(number) The 0 based index of the rows sublevel

Returns

This action dose not return any value.


TreeList.LoadImage


(number) TreeList.LoadImage ( 

(string) ImagePath )

Description

Loads a image file into memory for later use.

Note: File Types (.ico, ipng and .bmp) are supported.

Parameters

ImagePath

(string) The path to the image file.

Returns

(number) A numeric ID for this image/icon, else nil if any error.


TreeList.RemoveColumn


TreeList.RemoveColumn ( 

(number) TreeListID,

(number) Index )

Description

Removes a column from the Treelist object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Returns

This action dose not return any value.


TreeList.RemoveImage


TreeList.RemoveImage ( 

(number) TreeListID,

(number) ImageImdex )

Description

Removes an image from the objects imagelist.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

ImageImdex

(number) The index of the image.

Returns

This action dose not return any value.


TreeList.RowImageIndex


TreeList.RowImageIndex ( 

(number) TreeListID,

(number) Row,

(number) Index )

Description

Sets imageindex for this row.

Note: Set to 0 to remove the icon for this item.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Index

(number) The image index, 0 to remove icon.

Returns

This action dose not return any value.


TreeList.RowSubLevel


(number) TreeList.RowSubLevel ( 

(number) TreeListID,

(number) Row )

Description

Gets the 0 based sublevel index of the row.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Returns

(number) The 0 based subindex of this item, 0 is the main nodes, 1 is the forst subnode, 2 is the second subnode etc...

If any error, 0 is returned.


TreeList.SetBackColor


TreeList.SetBackColor ( 

(number) TreeListID,

(number) Color )

Description

Sets the background color.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Color

(number) The decimal color value.

Returns

This action dose not return any value.


TreeList.SetCellAlign


TreeList.SetCellAlign ( 

(number) TreeListID,

(number) Row,

(number) Column,

(number) Align )

Description

Sets the text alignment of a cell.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Align

(number) The alignment for this cell

Note: If Row or Column set to -1, text allignment applys to all cells in this column.

CONSTANT

VALUE

DESCRIPTION

TL_LEFT

0

Align text to the left. (Default)

TL_CENTER

1

Align text to the center.

TL_RIGHT

2

Align text to the right.

Returns

This action dose not return any value.


TreeList.SetCellBackColor


TreeList.SetCellBackColor ( 

(number) TreeListID,

(number) Row,

(number) Column,

(number) Color )

Description

Sets a cell's background color.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Color

(number) The decimal color value.

Returns

This action dose not return any value.


TreeList.SetCellFrontColor


TreeList.SetCellFrontColor ( 

(number) TreeListID,

(number) Row,

(number) Column,

(number) Color )

Description

Sets a cell's text color.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Color

(number) The decimal color value.

Returns

This action dose not return any value.


TreeList.SetCellText


TreeList.SetCellText ( 

(number) TreeListID,

(number) Row,

(number) Column,

(string) Text )

Description

Sets the text of a cell.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Column

(number) The 0 based index of the column.

Text

(string) The new text for this cell.

Returns

This action dose not return any value.


TreeList.SetColumnWidth


TreeList.SetColumnWidth ( 

(number) TreeListID,

(number) Index,

(number) Width )

Description

Sets the width of a column.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Width

(number) The new width for this column.

Returns

This action dose not return any value.


TreeList.SetEnable


TreeList.SetEnable ( 

(number) TreeListID,

(boolean) Enabled )

Description

Sets the enabled state of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Enabled

(boolean) True to enable the object.

Returns

This action dose not return any value.


TreeList.SetFrontColor


TreeList.SetFrontColor ( 

(number) TreeListID,

(number) Color )

Description

Sets the front color (text, gridlines)

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Color

(number) The decimal color value.

Returns

This action dose not return any value.


TreeList.SetHeaderAlign


TreeList.SetHeaderAlign ( 

(number) TreeListID,

(number) Row,

(number) Column,

(number) Align )

Description

Sets the text alignment of a column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index of the Row.

Column

(number) The 0 based index of the Column.

Align

(number) The text alignment

CONSTANT

VALUE

DESCRIPTION

TL_LEFT

0

Align text to the left. (Default)

TL_CENTER

1

Align text to the center.

TL_RIGHT

2

Align text to the right.

Returns

This action dose not return any value.


TreeList.SetHeaderHeight


TreeList.SetHeaderHeight ( 

(number) TreeListID,

(number) Height )

Description

Sets the height of the column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Height

(number) The new height for the header.

Returns

This action dose not return any value.


TreeList.SetHeaderResize


TreeList.SetHeaderResize ( 

(number) TreeListID,

(boolean) Resize )

Description

Sets wether the columns can be resized.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Resize

(boolean) True to enable header resizeing.

Returns

This action dose not return any value.


TreeList.SetHeaderText


TreeList.SetHeaderText ( 

(number) TreeListID,

(number) Index,

(string) Text )

Description

Sets the title text of a column header.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Index

(number) The 0 based index if the position to insert.

Text

(string) The new text for this column.

Returns

This action dose not return any value.


TreeList.SetPos


TreeList.SetPos ( 

(number) TreeListID,

(number) X,

(number) Y )

Description

Sets the position of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

X

(number) The new X position of the object.

Y

(number) The new Y position of the object.

Returns

This action dose not return any value.


TreeList.SetRowChecked


TreeList.SetRowChecked ( 

(number) TreeListID,

(number) Row,

(boolean) Checked )

Description

Sets the checked state of a row.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Checked

(boolean) True to check the row.

Returns

This action dose not return any value.


TreeList.SetRowExpanded


TreeList.SetRowExpanded ( 

(number) TreeListID,

(number) Row,

(boolean) Expaned )

Description

Sets the expanded state of a row.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Expaned

(boolean) True to expand the row.

Returns

This action dose not return any value.


TreeList.SetSelected


TreeList.SetSelected ( 

(number) TreeListID,

(number) Row )

Description

Sets current selected item.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Row

(number) The 0 based index if the row.

Note: Set Index = -1 to clear selection

Returns

This action dose not return any value.


TreeList.SetSize


TreeList.SetSize ( 

(number) TreeListID,

(number) Width,

(number) Height )

Description

Sets the size (in pixels) of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Width

(number) The new width of the object.

Height

(number) The new height of the object.

Returns

This action dose not return any value.


TreeList.SetUnpackPath


TreeList.SetUnpackPath ( 

(number) FolderPath )

Description

Sets the unpack path for the intrenal dll.

Parameters

FolderPath

(number) The path to the folder to unpack the dll to.

Returns

This action dose not return any value.


TreeList.SetVisible


TreeList.SetVisible ( 

(number) TreeListID,

(boolean) Visible )

Description

Sets the visible state of the object.

Parameters

TreeListID

(number) The numeric ID of the object as returned with "TreeList.Create".

Visible

(boolean) True to show the object.

Returns

This action dose not return any value.



Copyright © 2010 Lua Devils
This File Was Generated With AMS ActionFile Editor