ComboList Objec Plugin Help File

Welcome

ComboList Objec Plugin Help File

Plugin Name:

ComboList Objec Plugin

Current Version:

1.0.0.0

Description:

Combo browser for autoplay media studio, made with Skelton (Lukas the duck)

Licence:

Free

Author:

raf@xplayer

Requirements:

Require Memory Plugin

Install Notes:

Copy folder plugin in AMS Directory Plugins/Objects

ComboList.StartEvents

ComboList.StartEvents (

(string) ObjectName = "Plugin1",

(string) ObjectName = "Plugin1" )

Description

Start Events in the Objects

Note: ( MAX 4 objects)

Parameters

ObjectName

(string) Name of te Combo object

ObjectName

(string) Name of te Combo object

ObjectName

(string) Name of te Combo object

ObjectName

(string) Name of te Combo object

Returns

This action dose not return any value.

Example

Eixample 1 object
ComboList.StartEvents("Plugin1")
2 Objects..
ComboList.StartEvents("Plugin1","Plugin2")
3 Objects..
ComboList.StartEvents("Plugin1","Plugin2","Plugin3")

ComboList.CreateObject

ComboList.CreateObject (

(string) ObjectName = "Plugin1",

(string) Path = "" )

Description

Create the object

Parameters

ObjectName

(string) Name of the Como object

Path

(string) Path to select the ini

Returns

This action dose not return any value.

Example

ComboList.CreateObject("Plugin1"._DesktopFolder)

ComboList.SetSelectedFolder

ComboList.SetSelectedFolder (

(string) ObjectName = "Plugin1",

(string) Path = "C:\\DestDir\\" )

Description

Set item folder

Parameters

ObjectName

(string) Name of the Combo object

Path

(string) Path of item selected

Returns

This action dose not return any value.

Example

ComboList.SetSelectedFolder("Plugin1",_DesktopFolder)

ComboList.GetSelectedFolder

(string) ComboList.GetSelectedFolder (

(string) ObjectName = "Plugin1" )

Description

Get Path of item selected

Parameters

ObjectName

(string) Name of the Combo object

Returns

(string)

Example

xPath = ComboList.GetSelectedFolder("Plugin1")

ComboList.GetSelectedItemIndex

(number) ComboList.GetSelectedItemIndex (

(string) ObjectName = "Plugin1" )

Description

Get the index o item selcted

Parameters

ObjectName

(string) Name of the Combo Object

Returns

(number)

Example

nIndex = ComboList.GetSelectedItemIndex("Plugin1)

ComboList.SetDisplayPanelHeight

ComboList.SetDisplayPanelHeight (

(string) ObjectName = "Plugin1",

(number) Height = 15 )

Description

Set panel Heigth in pixels

Parameters

ObjectName

(string) Name of the combo object

Height

(number) Height in pixels

Returns

This action dose not return any value.

Example

ComboList.SetDisplayPanelHeight("Plugin1",30)

ComboList.GetSelectedText

(string) ComboList.GetSelectedText (

(string) ObjectName = "Plugin1" )

Description

Get text of item selected

Parameters

ObjectName

(string) Name of the Combo Object

Returns

(string)

Example

Text = ComboList.GetSelectedText("Plugin1")
Dilaog.Message("Item","Text : "..Text)

ComboList.SetSelectedText

ComboList.SetSelectedText (

(string) ObjectName = "Plugin1",

(string) Text = "New Name" )

Description

Set tex of item selected

Parameters

ObjectName

(string) Name of the Combo Object

Text

(string) Set text

Returns

This action dose not return any value.

Example

ComboList.SetSelectedText("Plugin1","New Name")

ComboList.SetEditable

ComboList.SetEditable (

(string) ObjectName = "Plugin1",

(boolean) Editable = true )

Description

Set editable or not

Parameters

ObjectName

(string) Name of the Combo object

Editable

(boolean) Editable or not

Value	Description
true	(Default) Editable
false	not editable

Returns

This action dose not return any value.

Example

ComboList.SetEditable("Plugin1",true)

ComboList.AddFolder

(string) ComboList.AddFolder (

(string) ObjectName = "Plugin1",

(string) Folder path = "C:\\DestDir\\",

(number) Indent = 1,

(boolean) Permanent = true )

Description

Add the System folder

Parameters

ObjectName

(string) Name of the Combo object

Folder path

(string) Path of the folder to add

Indent

(number) Position Add

Permanent

(boolean) Sets whether the folder to be visible after making changes to the Combo

Value	Description
true	(Default) Permanent
false	Not

Returns

(string) Path

Example

aPath = ComboList.AddFolder("Plugin1",_SourceFolder,1,false)
bPath = ComboList.AddFolder("Plugin1",_SourceFolder.."\\Autoplay",2,false)
cPath = ComboList.AddFolder("Plugin1",_SourceFolder.."\\Autoplay\\Docs",3,false)
    if aPath and bPath and cPath then
        Dialog.Message("Create path",String.SplitPath(aPath).Filename.."\r\n"..String.SplitPath(bPath).Filename.."\r\n"..String.SplitPath(cPath).Filename)
    end

ComboList.SetColor

ComboList.SetColor (

(string) ObjectName = "Plugin1",

(number) Color = 0000 )

Description

Set color combo

Parameters

ObjectName

(string) Name of the combo object

Color

(number) Number of the Color

Note: Require Color number decimal

Returns

This action dose not return any value.

Example

-- Eixample require SysDialog Action plugin
local nColor = SysDialog.Color(65280);
if nColor~=nil then
ComboList.SetColor("Plugin1",nColor.Decimal)
end

ComboList.SetCharCase

ComboList.SetCharCase (

(string) ObjectName = "Plugin1",

(variant) Edit Char Case = Normal )

Description

Set char case of items

Parameters

ObjectName

(string) Name of the Combo Object

Edit Char Case

(variant) Char case

CONSTANT	VALUE	DESCRIPTION
Normal	0	Norma char case
UpperCase	1	UpperCase
LowerCase	2	LowerCase

Returns

This action dose not return any value.

Example

ComboList.SetCharCase("Plugin!",UpperCase)

ComboList.DeleteItemSelected

ComboList.DeleteItemSelected (

(string) ObjectName = "Plugin1" )

Description

Delete item selected

Note: No delete sistem files

Parameters

ObjectName

(string) Name of the Combo object

Returns

This action dose not return any value.

Example

ComboList.DeleteItemSelected("Plugin1")

ComboList.SetAutomaticRefresh

ComboList.SetAutomaticRefresh (

(string) ObjectName = "Plugin1",

(boolean) Automatic = true )

Description

Set automatic refresh of changes

Parameters

ObjectName

(string) Name of the Combo object

Automatic

(boolean) Sets Automatic

Value	Description
true	(Default) Automatic refresh
false	not refresh

Returns

This action dose not return any value.

Example

ComboList.SetAutomaticRefresh("Plugin1",true)

ComboList.ShowNetHood

ComboList.ShowNetHood (

(string) ObjectName = "Plugin1",

(boolean) Show = false )

Description

Show or not Net Hood item

Parameters

ObjectName

(string) Name of the Combo object

Show

(boolean) Set Show

Note: Default true

Value	Description
true	Show
false	(Default) Hidde

Returns

This action dose not return any value.

Example

ComboList.ShowNetHood("Plugin1",false)

ComboList.ShowRecycleBin

ComboList.ShowRecycleBin (

(string) ObjectName = "Plugin1",

(boolean) Show = false )

Description

Show or not Recycle Bin item

Parameters

ObjectName

(string) Name of the Combo object

Show

(boolean) Set Show

Note: Default true

Returns

This action dose not return any value.

Example

ComboList.ShowRecycleBin("Plugin1",false)

ComboList.GetItemsCount

(number) ComboList.GetItemsCount (

(string) ObjectName = "Plugin1" )

Description

Gets the number of the items

Parameters

ObjectName

(string) Name of the Combo object

Returns

(number)

Example

nItems = ComboList.GetItemsCount("Plugin1")
Dialog.Message("Items","Total : "..nItems)

ComboList.SetDropedDown

ComboList.SetDropedDown (

(string) ObjectName = "Plugin1",

(boolean) DropedDown = treu )

Description

Open panel determines whether or not

Parameters

ObjectName

(string) Name of the Combo Object

DropedDown

(boolean) Set action

Value	Description
true	Open panel
false	Close

Returns

This action dose not return any value.

Example

ComboList.SetDropedDown("Plugin1",true)

ComboList.GetDropedDown

(boolean) ComboList.GetDropedDown (

(string) ObjectName = "Plugin1" )

Description

Get state of the panel, open or closed

Parameters

ObjectName

(string) Name of the combo object

Returns

(boolean)

Example

xDrop = ComboList.GetDropedDown("Plugin1")
if xDrop then
ComboList.SetDropedDown("Plugin1",false)
end

ComboList.GetDropDownItemsCount

(number) ComboList.GetDropDownItemsCount (

(string) ObjectName = "Plugin1" )

Description

Get number of items that are opened with panel

Parameters

ObjectName

(string) Name of the Combo object

Returns

(number)

Example

nItems = ComboList.GetDropDownItemsCount("Plugin1")

ComboList.SetDropDownItemsCount

ComboList.SetDropDownItemsCount (

(string) ObjectName = "Plugin1",

(number) Nº Items = 10 )

Description

Sets the number of items that will open with the panel

Parameters

ObjectName

(string) Name of the combo object

Nº Items

(number) Number of items showing

Returns

This action dose not return any value.

Example

ComboList.SetDropDownItemsCount("Plugin1",15)

This File Was Generated With AMS ActionFile Editor

ComboList Objec Plugin Help File