Welcome
ListIcon Action Plugin
1.1.0.2
Adds a powerful yet easy to use ListIcon object to your AMS projects.
Commercial Software
Dean Hall (AKA) RizlaUK
luadevils.com
rizlauk@luadevils.com
Explorer objects require AMSWaves 'Memory' plugin for its call backsystem.
Memory Plugin
Copyright © 2010 Lua Devils
Copy folder 'ListIcon' to your AMS install directory '\Plugins\Actions'
ListIcon.AddColumn
ListIcon.AddRow
ListIcon.CellStringWidth
ListIcon.ClearRows
ListIcon.CountCheckedRows
ListIcon.CountColumns
ListIcon.CountRows
ListIcon.CountSelectedRows
ListIcon.Create
ListIcon.DeleteColumn
ListIcon.DeleteRow
ListIcon.EnsureVisible
ListIcon.ExtensionIcon
ListIcon.ExtractIcon
ListIcon.Find
ListIcon.GetCellText
ListIcon.GetColumnText
ListIcon.GetEnabled
ListIcon.GetPos
ListIcon.GetRowChecked
ListIcon.GetRowSelected
ListIcon.GetSelected
ListIcon.GetSize
ListIcon.GetUnpackPath
ListIcon.GetUpdate
ListIcon.GetVisible
ListIcon.InsertColumn
ListIcon.InsertRow
ListIcon.LoadImage
ListIcon.MessageBarGetButtonVisible
ListIcon.MessageBarGetIcon
ListIcon.MessageBarGetIconVisible
ListIcon.MessageBarGetText
ListIcon.MessageBarGetVisible
ListIcon.MessageBarSetButtonVisible
ListIcon.MessageBarSetIcon
ListIcon.MessageBarSetIconVisible
ListIcon.MessageBarSetText
ListIcon.MessageBarSetVisible
ListIcon.Redraw
ListIcon.SetCellText
ListIcon.SetColumnText
ListIcon.SetEnabled
ListIcon.SetMode
ListIcon.SetPos
ListIcon.SetRowChecked
ListIcon.SetRowSelected
ListIcon.SetSelected
ListIcon.SetSize
ListIcon.SetUnpackPath
ListIcon.SetUpdate
ListIcon.SetVisible
ListIcon.Update
ListIcon.EnterKey
ListIcon.AddColumn ( | (number) ListIconID, (string) Text, (number) Width ) |
Adds a column to the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(string) The text caption to be displayed in the column header.
(number) The width of the column.
This action dose not return any value.
ListIcon.AddRow ( | (number) ListIconID, (string) Text, (number) IconIndex = nil ) |
Adds a row to the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(string) The text that will be displayed in this row, use ("|") to seperate columns EG: ("Item 1|Item 2|Item 3")
(number) The index of the icon.
This action dose not return any value.
(number) ListIcon.CellStringWidth ( | (number) ListIconID, (number) Row, (number) Column ) |
Determines the width of the string in a specified cell.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The row that the cell is on.
(number) The column that the cell is on.
(number) The the exact width, in pixels, of the text contained in the indecated cell,
If you use the returned string width as the column width in the LuistIcon.SetColumnWidth, the string will be truncated.
To retrieve the column width that can contain the string without truncating it, you must add padding to the returned string width.
ListIcon.ClearRows ( | (number) ListIconID ) |
Clears all rows from the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
This action dose not return any value.
(number) ListIcon.CountCheckedRows ( | (number) ListIconID ) |
Count the checked rows.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The number of rows that are currently checked, or 0 if any error.
(number) ListIcon.CountColumns ( | (number) ListIconID ) |
Counts the number of comumns in a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The number of columns the the ListIcon contains, or 0 if any error.
(number) ListIcon.CountRows ( | (number) ListIconID ) |
Counts the number of rows in the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The number of rows the the ListIcon contains, or 0 if any error.
(number) ListIcon.CountSelectedRows ( | (number) ListIconID ) |
Count the selected rows.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The number of rows that are currently selected, or 0 if any error.
(number) ListIcon.Create ( | (number) X, (number) Y, (number) Width, (number) Height, (string) Text, (number) ColumnWidth, (table) Flags = nil ) |
Creates a ListIcon object with the given arguments.
(number) The X position of the ListIcon.
(number) The Y position of the ListIcon.
(number) The Width of the ListIcon.
(number) The Height of the ListIcon.
(string) The title of the 1st column.
(number) The width of the 1st column.
(table) Define optional flags table.
CONSTANT | VALUE | DESCRIPTION |
CheckBoxes | Boolean | Display checkboxes in the first column. |
MultiSelect | Boolean | Enable multiple selection. |
GridLines | Boolean | Display separator lines between rows and columns. |
FullRowSelect | Boolean | The selection covers the full row instead of the first column. |
HeaderDragDrop | Boolean | The order of columns can be changed using drag'n'drop. |
AlwaysShowSelection | Boolean | The selection is still visible, even when the gadget is not activated. |
ObjectHost | Humber (Hwnd) | The host object that will house the listicon, if set (X,Y,W,H) are ignored and host size is used. |
(number) Returns a numeric ID for the ListIcon object, this id should be used in function caalls to the object, if any error nil is returned.
-- creation flags
tFlags={}
tFlags.CheckBoxes = true -- Display checkboxes in the first column.
tFlags.MultiSelect = true -- Enable multiple selection.
tFlags.GridLines = true -- Display separator lines between rows and columns.
tFlags.FullRowSelect = true -- The selection covers the full row instead of the first column.
tFlags.HeaderDragDrop = true -- The order of columns can be changed using drag'n'drop.
tFlags.AlwaysShowSelection = true -- The selection is still visible, even when the gadget is not activated.
tFlags.ObjectHost = ListBox.GetProperties("ListBox1").WindowHandle
-- The host object that will house the listicon, if set (X,Y,W,H) are ignored and host size is used.
-- For ease of use, when a ListIcon is hosted inside a AMS object the resizeing will de done by the AMS host object
-- also, setting the host objects visible and enable actions will affect the ListIcon
-- If useing a multi page application it is recomended the you embed the ListIcon into a AMS host object.
nListIconID=ListIcon.Create(0,0,0,0,"Column 0",100,tFlags)
ListIcon.DeleteColumn ( | (number) ListIconID, (number) Index ) |
Deletes a column from the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the column to remove.
This action dose not return any value.
ListIcon.DeleteRow ( | (number) ListIconID, (number) Index ) |
Removes a row from the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to remove
This action dose not return any value.
ListIcon.EnsureVisible ( | (number) ListIconID, (number) Row ) |
Ensure that a certen row is visible.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The row that the cell is on.
This action dose not return any value.
(number) ListIcon.ExtensionIcon ( | (string) Extension ) |
Loads the default system icon for the indecated extension.
(string) The extension for which you want to get the system default icon.
(number) A image ID that can be used in other functions, or nil if any error.
(number) ListIcon.ExtractIcon ( | (string) Filepath, (number) Index ) |
Extracts an icon from a dll or exe file and loads it into memory.
(string) Path to the file that contains the icon.
(number) The index of the icon inside the external resource.
(number) A image ID that can be used in other functions, or nil if any error.
(number) ListIcon.Find ( | (number) ListIconID, (number) StartRow, (string) Text, (boolean) PartialMatch = false ) |
Searches for the specified text.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the item after which to begin the search, or -1 to start from the beginning.
(string) The text to search for.
(boolean) Checks to see if the item text begins with the string, else the item text of the matching item must exactly match the Text argument. However, the search is case-insensitive.
(number) The index of the first row that contains a match for the search pattern, or -1 if the pattern was not found or if any error.
(string) ListIcon.GetCellText ( | (number) ListIconID, (number) Row, (number) Column ) |
Gets the text of the indecated cell.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The row that the cell is on.
(number) The column that the cell is on.
(string) The text string from the indecated cell, or a blank string ("") if any error.
(string) ListIcon.GetColumnText ( | (number) ListIconID, (number) Column ) |
Gets the text of the indecated column.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The column that the cell is on.
(string) The text string from the indecated column, or a blank string ("") if any error.
(boolean) ListIcon.GetEnabled ( | (number) ListIconID ) |
Gets the enabled state of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True if the object is visible, false if it's invisible. If an error occurs, false will be returned.
(table) ListIcon.GetPos ( | (number) ListIconID ) |
Gets the position of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(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.
(boolean) ListIcon.GetRowChecked ( | (number) ListIconID, (number) Index ) |
Gets a rows checked state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to check.
(boolean) True if the indecated row is checked, flase if not or if any error.
(boolean) ListIcon.GetRowSelected ( | (number) ListIconID, (number) Index ) |
Gets a rows selection state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to check.
(boolean) True if the indecated row is selected, flase if not or if any error.
(number) ListIcon.GetSelected ( | (number) ListIconID ) |
Gets the first selected row in a listicon.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the selecrted row, or -1 if any error.
(table) ListIcon.GetSize ( | (number) ListIconID ) |
Gets the size of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(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.
(string) ListIcon.GetUnpackPath () |
Gets the unpack path for the plugins external resources.
(string) The path to the folder where the internal support files will be extracted.
(boolean) ListIcon.GetUpdate ( | (number) ListIconID ) |
Gets the update state of a listicon.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True if the ListIcon is able to update, flase if not or if any error.
(boolean) ListIcon.GetVisible ( | (number) ListIconID ) |
Gets the visible state of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True if the object is visible, false if it's invisible. If an error occurs, false will be returned.
ListIcon.InsertColumn ( | (number) ListIconID, (number) Index, (string) Text, (number) Width ) |
Inserts a column to the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index where to insert the new column.
(string) The text caption to be displayed in the column header.
(number) The width of the column.
This action dose not return any value.
ListIcon.InsertRow ( | (number) ListIconID, (number) Index, (string) Text, (number) IconIndex = nil ) |
Inserts a row to the listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index where to insert the new row.
(string) The text that will be displayed in this row, use ("|") to seperate columns EG: ("Item 1|Item 2|Item 3")
(number) The index of the icon.
This action dose not return any value.
(number) ListIcon.LoadImage ( | (string) Filepath ) |
Loads an image file into memory.
(string) Path to an image file (.bmp, .png, .jpg and .ico supported)
(number) A image ID that can be used in other functions, or nil if any error.
(boolean) ListIcon.MessageBarGetButtonVisible ( | (number) ListIconID ) |
Gets the visible state of the message bar close button.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True if the messagebar close button is visible, false if it's invisible. If an error occurs, false will be returned.
(number) ListIcon.MessageBarGetIcon ( | (number) ListIconID ) |
Gets icon image on the message bar.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) A image ID that can be used in other functions, or nil if any error.
(boolean) ListIcon.MessageBarGetIconVisible ( | (number) ListIconID ) |
Gets the visible state of the message bar icon.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True if the messagebar icon is visible, false if it's invisible. If an error occurs, false will be returned.
(string) ListIcon.MessageBarGetText ( | (number) ListIconID ) |
Gets a ListIcons message bar text.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(string) The text string contained in the messagebar, or a blank string("") if any error.
ListIcon.MessageBarGetVisible ( | (number) ListIconID ) |
Gets a ListIcons message bars visible state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
This action dose not return any value.
ListIcon.MessageBarSetButtonVisible ( | (number) ListIconID, (boolean) Visible ) |
Sets the visible state of the message bar close button.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True to show the close button, false to hide it.
This action dose not return any value.
ListIcon.MessageBarSetIcon ( | (number) ListIconID, (number) IconIndex ) |
Sets icon image on the message bar.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the icon.
This action dose not return any value.
ListIcon.MessageBarSetIconVisible ( | (number) ListIconID, (boolean) Visible ) |
Sets the visible state of the message bar icon.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True to show the icon, false to hide it.
This action dose not return any value.
ListIcon.MessageBarSetText ( | (number) ListIconID, (string) Text ) |
Sets a ListIcons message bar text.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(string) The text to be displayed in the message bar.
This action dose not return any value.
ListIcon.MessageBarSetVisible ( | (number) ListIconID, (boolean) Visible ) |
Sets a ListIcons message bars visible state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True to set the message bar visible.
This action dose not return any value.
ListIcon.Redraw ( | (number) ListIconID ) |
Redraws the ListIcons host area.
Note: This function redraws the whole ListIcon area ikncluding the messagebar, to redraw the client area (where rows are added) use ListIcon.Update
(number) The numeric ID of the listicon as returned with ListIcon.Create
This action dose not return any value.
ListIcon.SetCellText ( | (number) ListIconID, (number) Row, (number) Column, (string) Text ) |
Sets the text of the indecated cell.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The row that the cell is on.
(number) The column that the cell is on.
(string) The new text for the cell.
This action dose not return any value.
ListIcon.SetColumnText ( | (number) ListIconID, (number) Column, (string) Text ) |
Sets the text of the indecated column.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The column that the cell is on.
(string) The new text for the cell.
This action dose not return any value.
ListIcon.SetEnabled ( | (number) ListIconID, (boolean) Enabled ) |
Sets the enabled state of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True to enable the object, false to disable it.
This action dose not return any value.
ListIcon.SetMode ( | (number) ListIconID, (number) Mode ) |
Sets the ListIcons display mode.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The mode to set.
CONSTANT | VALUE | DESCRIPTION |
ListIcon_LargeIcon | 0 | Large icon mode |
ListIcon_SmallIcon | 1 | Small icon mode |
ListIcon_List | 2 | List icon mode |
ListIcon_Report | 3 | Report mode (columns, Default mode) |
This action dose not return any value.
ListIcon.SetPos ( | (number) ListIconID, (number) X, (number) Y ) |
Sets the position of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The X position of the ListIcon.
(number) The Y position of the ListIcon.
This action dose not return any value.
ListIcon.SetRowChecked ( | (number) ListIconID, (number) Index, (boolean) State ) |
Sets a rows checked state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to check/uncheck.
(boolean) True to check the row, fasle to uncheck it.
This action dose not return any value.
ListIcon.SetRowSelected ( | (number) ListIconID, (number) Index, (boolean) State ) |
Sets a rows selection state.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to select.
(boolean) True to select the row, fasle to deselect it.
This action dose not return any value.
ListIcon.SetSelected ( | (number) ListIconID, (number) Index ) |
Selects a single row in a listicon.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The index of the row to select.
This action dose not return any value.
ListIcon.SetSize ( | (number) ListIconID, (number) Width, (number) Height ) |
Sets the size of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(number) The width of the ListIcon.
(number) The height of the ListIcon.
This action dose not return any value.
ListIcon.SetUnpackPath ( | (number) FolderPath ) |
Sets the unpack path for the plugins external resources.
Note: Only use this if you have problems unpacking the resources.
(number) Path to a folder to extract the external resources to.
This action dose not return any value.
ListIcon.SetUpdate ( | (number) ListIconID, (boolean) bUpdate ) |
Sets the update state of a listicon.
Note: Setting this to false will disable the redrawing of the ListIconClient area, use this when adding lots of rows.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) Treu to allow the ListIcon to update (redraw)
This action dose not return any value.
ListIcon.SetVisible ( | (number) ListIconID, (boolean) Visible ) |
Sets the visible state of a listicon object.
(number) The numeric ID of the listicon as returned with ListIcon.Create
(boolean) True to show the object, false to hide it.
This action dose not return any value.
ListIcon.Update ( | (number) ListIconID ) |
Updates (redraws) the ListIcon object.
Note: This function updates the ListIcon client area, use this function to update after adding a row.
(number) The numeric ID of the listicon as returned with ListIcon.Create
This action dose not return any value.
ListIcon.EnterKey ( | (number) Key ) |
Unlocks the nag window.
(number) The key you received when you purchased this plugin.
This action dose not return any value.
Copyright © 2010 Lua Devils
This File Was Generated With AMS ActionFile Editor