TreeList Object Plugin Help File

TreeList Object Plugin Help File

Plugin Name:

TreeList Object Plugin

Current Version:

1.0.0.0

Description:

Tree list object for Autoplay Media Studio 8

Licence:

Free

Author:

raf@xplayer

Requirements:

Require Memory plugin and ShellBrowserX.ocx

Install Notes:

Copy Folder plugin in Ams directory Plugins/Objects


Table of Contents

TreeList.CreateObject
TreeList.InvokeCommandOnSelected
TreeList.SetAutomaticRefresh
TreeList.GoUp
TreeList.CreateDir
TreeList.GetSelectedFolder
TreeList.SetSelectedFolder
TreeList.SetShowButtons
TreeList.SetExpandOnSelect
TreeList.ShowLines
TreeList.GetIndexItemselected
TreeList.ShowFiles
TreeList.Refresh
TreeList.SetBackColor
TreeList.SetFontColor
TreeList.CollapseAll
TreeList.ExpandAll
TreeList.ShowNetHoot
TreeList.ShowRecycleBin
TreeList.StartEvents
TreeList.SetRootFolder
TreeList.GetRootFolder
TreeList.SetSpecialFolder
TreeList.GetSpecialFolder
TreeList.GetEnabled
TreeList.SetEnabled
TreeList.SetFilter
TreeList.GetFilter
TreeList.SetVisible
TreeList.GetVisible

TreeList.CreateObject


(boolean) TreeList.CreateObject ( 

(string) ObjecName,

(string) PathRoot = "" )

Description

Create object

Parameters

ObjecName

(string) Object Name

PathRoot

(string) path where the tree starts

Returns

(boolean) successfully created true, else false


TreeList.InvokeCommandOnSelected


TreeList.InvokeCommandOnSelected ( 

(string) Object Name,

(string) Command )

Description

Command that runs when you select a item

Note: default Root system

Parameters

Object Name

(string) Object Name

Command

(string) Command to execute

Note: Eixamples : "delete","explore","open","propertyes"

Returns

This action dose not return any value.


TreeList.SetAutomaticRefresh


TreeList.SetAutomaticRefresh ( 

(string) ObjectName,

(boolean) Activate )

Description

Activate or not AutomaticRefresh

Parameters

ObjectName

(string) Object Name

Activate

(boolean) Activate or not

Value

Description

true

Activate

false

Not Activate

Returns

This action dose not return any value.


TreeList.GoUp


TreeList.GoUp ( 

(string) Object Name )

Description

To GoUp

Parameters

Object Name

(string) Object Name

Returns

This action dose not return any value.


TreeList.CreateDir


TreeList.CreateDir ( 

(string) ObjectName,

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

(string) Folder Name,

(boolean) Edit Mode )

Description

create directory tree

Note: default route selected in the tree

Parameters

ObjectName

(string) Object Name

Path

(string) path where the directory was created

Folder Name

(string) Name of the directory to create

Edit Mode

(boolean) Option to edit the directory

Value

Description

true

Edit

false

Not Edit

Returns

This action dose not return any value.


TreeList.GetSelectedFolder


(string) TreeList.GetSelectedFolder ( 

(string) ObjectName )

Description

Path of selected folder

Parameters

ObjectName

(string) Object Name

Returns

(string) An error occurs when selecting special items such as "Control Panel", "RedHoot" My Computer, fixed in future versions.


TreeList.SetSelectedFolder


TreeList.SetSelectedFolder ( 

(string) ObjectName,

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

Description

Select item corresponding to the path given

Parameters

ObjectName

(string) Object Name

Path

(string) Path to select

Returns

This action dose not return any value.


TreeList.SetShowButtons


TreeList.SetShowButtons ( 

(string) ObjectName,

(boolean) Show = true )

Description

Show buttons on the tree

Parameters

ObjectName

(string) Object Name

Show

(boolean) Show or not

Note: Default Buttons enabled

Value

Description

true

(Default) Show butons

false

Not Show

Returns

This action dose not return any value.


TreeList.SetExpandOnSelect


TreeList.SetExpandOnSelect ( 

(string) ObjectName,

(string) Expand = true )

Description

Enable auto expand an item to select Do

Note: Defalut false

Parameters

ObjectName

(string) Object Name

Expand

(string) Expand or not

Value

Description

true

(Default) Expand on select

false

Not Expand

Returns

This action dose not return any value.


TreeList.ShowLines


TreeList.ShowLines ( 

(string) ObjectName,

(boolean) Show = true )

Description

Lines in the tree whether or not

Note: Deafult false

Parameters

ObjectName

(string) Object Name

Show

(boolean) Show or not

Value

Description

true

(Default) Show

false

Not Show

Returns

This action dose not return any value.


TreeList.GetIndexItemselected


(number) TreeList.GetIndexItemselected ( 

(string) ObjectName )

Description

Gets the index of the item selcted

Parameters

ObjectName

(string) Object Name

Returns

(number)


TreeList.ShowFiles


TreeList.ShowFiles ( 

(string) ObjectName,

(boolean) Show = true )

Description

display files in the tree

Parameters

ObjectName

(string) Object Name

Show

(boolean) display or not files in the tree

Note: dafault false

Value

Description

true

(Default) Show files

false

not show

Returns

This action dose not return any value.


TreeList.Refresh


TreeList.Refresh ( 

(string) ObjectName )

Description

Refresh Tree

Parameters

ObjectName

(string) Object Name

Returns

This action dose not return any value.


TreeList.SetBackColor


TreeList.SetBackColor ( 

(string) ObjectName,

(number) Color = 65280 )

Description

Set background color

Parameters

ObjectName

(string) Object Name

Color

(number) Color Decimal to background

Returns

This action dose not return any value.


TreeList.SetFontColor


TreeList.SetFontColor ( 

(string) ObjectName,

(number) Color = 65280 )

Description

Set Font color

Parameters

ObjectName

(string) Object Name

Color

(number) Color Decimal to Font

Returns

This action dose not return any value.


TreeList.CollapseAll


TreeList.CollapseAll ( 

(string) ObjectName )

Description

Collapse All items

Parameters

ObjectName

(string) Object Name

Returns

This action dose not return any value.


TreeList.ExpandAll


TreeList.ExpandAll ( 

(string) ObjectName )

Description

Expand All items

Parameters

ObjectName

(string) Object Name

Returns

This action dose not return any value.


TreeList.ShowNetHoot


TreeList.ShowNetHoot ( 

(string) ObjectName,

(boolean) Show = false )

Description

Show or not NetHoot

Parameters

ObjectName

(string) Object Name

Show

(boolean) Show or not Red Hoot

Note: deafult true

Value

Description

true

Show Red Hoot

false

(Default) Not show

Returns

This action dose not return any value.


TreeList.ShowRecycleBin


TreeList.ShowRecycleBin ( 

(string) ObjectName,

(boolean) Show = false )

Description

Show or not RecycleBin

Parameters

ObjectName

(string) Object Name

Show

(boolean) Show or not Recycle bin

Note: deafult true

Value

Description

true

Show Recycle bin

false

(Default) Not Show

Returns

This action dose not return any value.


TreeList.StartEvents


TreeList.StartEvents ( 

(string) Object Name )

Description

Start de events code of the objects

Note: Max 3 Objects suported

Parameters

Object Name

(string) Name of the object

Returns

This action dose not return any value.


Example

Max 4 Objects suported ,eixample function
1 object
TreeList.StartEvents("Plugin1")

2 objects add string Object plugin
TreeList.StartEvents("Plugin1","Plugin2")

3 objects..
TreeList.StartEvents("Plugin1","Plugin2","Plugin3")
...



TreeList.SetRootFolder


TreeList.SetRootFolder ( 

(string) Object Name,

(string) Path = "_DesktopFolder" )

Description

Set a Root Directory

Parameters

Object Name

(string) Name Of the Object

Path

(string) We set as the root directory

Returns

This action dose not return any value.


Example

local xPath = Dialog.FolderBrowse("Please select a folder:", _DesktopFolder);
if xPath ~= "CANCEL" then
TreeList.SetRootFolder("Plugin1",xPath)
Input.SetText("Input1", xPath);
end



TreeList.GetRootFolder


(string) TreeList.GetRootFolder ( 

(string) Object Name )

Description

Get set to root directory

Parameters

Object Name

(string) Name of the Object

Returns

(string)


TreeList.SetSpecialFolder


TreeList.SetSpecialFolder ( 

(string) Object Name,

(number) Special Folder )

Description

root folder set as special list

Parameters

Object Name

(string) Name of the Object

Special Folder

(number) Set Special folder

CONSTANT

VALUE

DESCRIPTION

JSL_FILESYSTEMFOLDER

0

NA

JSL_BITBUCKET

1

NA

JSL_CONTROLS

2

NA

JSL_DESKTOP

3

NA

JSL_DESKTOPDIRECTORY

4

NA

JST_DRIVES

5

NA

JST_FONTS

6

NA

JST_NETHOOD

7

NA

JST_NETWORK

8

NA

JST_PERSONAL

9

NA

JST_PRINTERS

10

NA

JST_PROGRAMS

11

NA

JST_RECENT

12

NA

JST_SENDTO

13

NA

JST_STARTMENU

14

NA

JST_STARTUP

15

NA

JST_TEMPLATES

16

NA

JST_FAVORITES

17

NA

JST_COMMON_STARTMENU

18

NA

JST_SYSTEM

19

NA

JST_COMMON_DESKTOPDIRECTORY

20

NA

JST_APPDATA

21

NA

JST_PRINTHOOD

22

NA

JST_COMMON_FAVORITES

23

NA

JST_INTERNET_CACHE

24

NA

JST_COOKIES

25

NA

JST_HISTORY

26

NA

JST_COMMON_PROGRAMS

27

NA

JST_ALTSTARTUP

28

NA

JST_COMMON_APPDATA

29

NA

JST_COMMON_DOCUMENTS

30

NA

JST_INTERNET

31

NA

JST_LOCAL_APPDATA

32

NA

JST_MYPICTURES

33

NA

JST_PROGRAM_FILES

34

NA

JST_SYSTEM

35

NA

JST_PROGRAM_FILES_COMMON

36

NA

Returns

This action dose not return any value.


Example

TreeList.SetSepecialFolder("Plugin1",JST_PROGRAMS);



TreeList.GetSpecialFolder


(number) TreeList.GetSpecialFolder ( 

(string) Object Name )

Description

Get SpecialFolder

Parameters

Object Name

(string) Name of the object

Returns

(number)


TreeList.GetEnabled


(boolean) TreeList.GetEnabled ( 

(string) Object Name )

Description

Get enabled or not

Parameters

Object Name

(string) Name of the object

Returns

(boolean)


Example

TreeList.MoveInHistory("Plugin1",JST_Forward)



TreeList.SetEnabled


TreeList.SetEnabled ( 

(string) Object Name,

(boolean) State = false )

Description

Enabled or Disabled the Object

Parameters

Object Name

(string) Name of the Object

State

(boolean) Set state

Returns

This action dose not return any value.


Example

bState = TreeList.GetEnabled("Plugin1");
if bState == true then
Dialog.Message("State","The Object is Enabled);
else
Dialog.Message("State","The Object is Disabled);
end    



TreeList.SetFilter


TreeList.SetFilter ( 

(string) Object Name,

(string) Filter = "*.avi" )

Description

Set Filter to Show Files

Note: Default true

Parameters

Object Name

(string) Name of the Object

Filter

(string) Set Filter

Note: Default true

Returns

This action dose not return any value.


Example

TreeList.SetEnabled("Plugin1",false)



TreeList.GetFilter


(string) TreeList.GetFilter ( 

(string) Object Name )

Description

Get Filter

Parameters

Object Name

(string) Name of the object

Returns

(string)


Example

TreeList.SetFilter("Plugin1","*.psd")



TreeList.SetVisible


TreeList.SetVisible ( 

(string) Object Name,

(boolean) State = false )

Description

Set Visible or not Object

Parameters

Object Name

(string) Name of the Object

State

(boolean) Is Visible or Hidden

Returns

This action dose not return any value.


Example

xFilter = TreeList.GetFilter("Plugin1");
if xFilter ~= "*" then
Dialog.Message("Plugin1",xFilter)
end



TreeList.GetVisible


(boolean) TreeList.GetVisible ( 

(string) Object Name )

Description

Get State ( Visible)

Note: Deafult true

Parameters

Object Name

(string) Name of the Object

Returns

(boolean)


Example

TreeList.SetVisible("Plugin1",false)





This File Was Generated With AMS ActionFile Editor