JamDriveList object Plugin Help File

 Welcome

DriveList.CreateObject(ObjectName)

Description

Create to DriveList object

Parameters

Object Name

(string) Name of the Drive List Object

Returns

This action dose not return any value.

Example

DriveList.CreateObject("Plugin1")

DriveList.SetCheckBoxes

Description

Displays or hides Checkboxes

Parameters

Object Name

(string) Name of the Drive List Object

Show

(boolean) Show or not CheckBoxes

Returns

This action dose not return any value.

Example

DriveList.SetCheckBoxes("Plugin1",true)

DriveList.SetShellContextMenu

Description

Activate or not Contex menu on Right Click

Parameters

Object Name

(string) Name of the driveList Object

Value

(boolean) Activate or not

Note: Deaful true

Returns

This action dose not return any value.

Example

check = CheckBox.GetChecked(this)
    if check then
        DriveList.SetShellContextMenu("Plugin1",true)
    else
        DriveList.SetShellContextMenu("Plugin1",false)
    end    

DriveList.AddEditableItem

Description

Add folder editable from a path in the system

Parameters

Object Name

(string) Name of the DriveList object

Path

(string) Folder Path

Editable

(boolean) Bolean value , editable Item or not

Note: Default true

Returns

This action dose not return any value.

Example

xFolder = Dialog.FolderBrowse("Please select a folder:", "AutoPlay\\Docs");
    if xFolder ~= "CANCEL" then
        DriveList.AddEditableItem("Plugin1",xFolder,true)
        CheckBox.SetChecked("CheckBox1", true);
    end    

DriveList.CheckAllItems

Description

Checking will all checkbox object

Note: If there are also hidden the checking will

Parameters

Object Name

(string) Name of the DriveList object

Check

(boolean) Check/Uncheck all items

Note: defaul false

Returns

This action dose not return any value.

Example

DriveList.CheckAllItems("Plugin1")

DriveList.SetMutiSelect

Description

Enable or not the multi selection of items

Note: default false

Parameters

Object Name

(string) Name of the Drive List Object

MultiSelect

(boolean) Enable or disable

Returns

This action dose not return any value.

Example

check = CheckBox.GetChecked(this)
    if check then
        DriveList.SetMutiSelect("Plugin1",true)
    else
        DriveList.SetMutiSelect("Plugin1",false)
    end    

DriveList.SmartRefresh

Description

Smart Refresh

Parameters

Object Name

(string) Name of the Drive List Object

Returns

This action dose not return any value.

Example

DriveList.SmartRefresh("Plugin1")

DriveList.FullRefresh

Description

Full Refersh object

Parameters

Object Name

(string) Name of the DriveList Object

Returns

This action dose not return any value.

Example

DriveList.FullRefresh("Plugin1")

DriveList.Clear

Description

Clear Object

Parameters

Object Name

(string) Name of the DriveList object

Returns

This action dose not return any value.

Example

DriveList.Clear("Plugin1")

DriveList.SelectAll

Description

Select All items of the object

Parameters

Object Name

(string) Name of the Drive List Object

Returns

This action dose not return any value.

Example

DriveList.SelectAll("Plugin1")

DriveList.SetColor

Description

Set background color

Parameters

Object Name

(string) Name of the DriveList object

Color

(number) Number of Color (Decimal value)

Returns

This action dose not return any value.

Example

local nColor = SysDialog.Color(65280);
if nColor~=nil then
    DriveList.SetColor("Plugin1",nColor.Decimal)
end

DriveList.ShowColumnHeaders

Description

Show or hide Column headers

Parameters

Object Name

(string) Name of the driveList Object

Show

(boolean) Show or Hide

Note: Default true

Returns

This action dose not return any value.

Example

check = CheckBox.GetChecked(this)
    if check then
        DriveList.ShowColumnHeaders("Plugin1",true)
    else
        DriveList.ShowColumnHeaders("Plugin1",false)
    end    

DriveList.DeleteSelected

Description

Delete Item selected

Note: No delete Files of system

Parameters

Object Name

(string) Name of the DriveList Object

Returns

This action dose not return any value.

Example

DriveList.DeleteSelected("Plugin1")

DriveList.ShowGridLines

Description

Show or Hide grid lines

Note: deaful Hide

Parameters

Object Name

(string) Name of the DriveList Object

Show

(boolean) Show or Hide lines

Returns

This action dose not return any value.

Example

DriveList.ShowGridLines("Plugin1",true)

DriveList.GetItemIndexSelected

Description

Get a number index of the selected item

Parameters

Object Name

(string) Name of the DriveList Object

Returns

(number) if an error occurs, -1 is returned

Example

index = DriveList.GetItemIndexSelected("Plugin1")
if index ~= -1 then
Dialog.Message("Item","Index : "..index)
end

DriveList.InvokeCommandOnselect

Description

Run command on select drive

Parameters

Object Name

(string) Name of the Drive List object

Returns

(boolean) if command run then true is returned , if error ,false

DriveList.GetSelectedPath

Description

Gea a selected item path

Parameters

Object Name

(string) Name of the DriveList Object

Returns

(string)

Example

path = DriveList.GetSelectedPath("Plugin1")
Dialog.Message("Path",path)

DriveList.AutomaticRefresh

Description

Is automatically updated with changes

Parameters

Object Name

(string) Name of the driveList Object

Aut.

(boolean) refresh autmatic or not

Note: default false

Returns

This action dose not return any value.

Example

DriveList.AutomaticRefresh("Plugin1",true)

DriveList.SetSelectItemIndex

Description

Set selected item index

Note: The program applies the indices from 0, the first index = 0

Parameters

Object Name

(string) Name of the DriverList Object

Index

(number) index of the item to select

Returns

This action dose not return any value.

Example

DriveList.SelectItemIndex("Plugin1",3)

DriveList.GetSelecetdCount

Description

counts the number of selected items

Parameters

Object Name

(string) Name of the DriveList Object

Returns

(number)

Example

nCount = DriveList.GetSelecetdCount("Plugin1")
if nCoun ~= 0 then
Dialgog.Mesage("Items","Total Items : "..nCount)
end

DriveList.ShowDetails

Description

Show details or not

Parameters

Object Name

(string) Name of the DriveList Object

Show

(boolean) Show details or hide

Note: Default true

Returns

This action dose not return any value.

Example

check = CheckBox.GetChecked(this)
    if check then
        DriveList.ShowDetails("Plugin1",true)
    else
        DriveList.ShowDetails("Plugin1",false)
    end    

DriveList.ShowShellObjectNames

Description

Show or not Shell object names

Parameters

Object Name

(string) Name of the object

Show

(boolean) Show or Hide Shell names

Note: Default true

Returns

This action dose not return any value.

Example

check = CheckBox.GetChecked(this)
    if check then
        DriveList.ShowShellObjectNames("Plugin1",true)
    else
        DriveList.ShowShellObjectNames("Plugin1",false)
    end    

DriveList.SetStatusBarColor

Description

Status Bar Color

Note: Changes apply to all bars

Parameters

Object Name

(string) Name of the DriveList Object

Color

(number) Number of Color (Decimal)

Returns

This action dose not return any value.

Example

local nColor = SysDialog.Color(65280);
if nColor~=nil then

    DriveList.SetStatusBarColor("Plugin1",nColor.Decimal)
end

DriveList.SetFontColor

Description

Set font color

Parameters

Object Name

(string) Name of the Drive List Object

Color

(number) Number of color (Decimal)

Returns

This action dose not return any value.

Example

local nColor = SysDialog.Color(65280);
if nColor~=nil then

    DriveList.SetFontColor("Plugin1",nColor.Decimal)
end

DriveList.IsItemInList

Description

Find an item with the name

Parameters

Object Name

(string) Nmae of the DriveList Object

Text

(string) Text of search item

Note: Case sensitive

Returns

(boolean) if item is in list return true , else false
Case sensitive and not Shell names

Example

Text = Dialog.Input("Enter Data", "Your Drive:", "C\:", MB_ICONQUESTION);
if Text ~= "CANCEL" then
result = DriveList.IsItemInList("Plugin1",Text)
Dialog.Message("Searching",tostring(result))
end

DriveList.GetInfoDrive

Description

Info of Drive selected

Parameters

Object Name

(string) Name of the Drive List Object

Returns

(table) Index of table:
.DisplayName -- name display
.Type -- Type Hdd ( Fixed,Remobable,CD-Rom...)
.TotalSize -- The full Size of the HDD
.Usedpercent -- Percent space used in HDD
.Freepercet -- Percent Free Space in HDD
.Label -- label info
.FileSystem -- File system to HDD (NTFS,Fat..)
.Serial -- Serial number

Example

tbl_Drive = DriveList.GetInfoDrive("Plugin1")
text = "FullSize : "..tbl_Drive.TotalSize.."\r\n"
text = text .."Drive type : "..tbl_Drive.Type.."\r\n"
text = text .."Space used : "..tbl_Drive.Usedpercent.."\r\n"
text = text .."Free space : "..tbl_Drive.Freepercent.."\r\n"
text = text .."Label Info : "..tbl_Drive.Label.."\r\n"
text = text .."FileSystem Info : "..tbl_Drive.FileSystem.."\r\n"
text = text .."Serial Number : "..tbl_Drive.Serial.."\r\n"
text = text .."Info Dysplay name : "..tbl_Drive.DisplayName.."\r\n"

Dialog.Message("Info Drive",text)     

DriveList.StartEvents

Description

On the events in the objects we use ( Max 3 Objects)

Note: This function is necessary to run the plugin

Parameters

Object Name

(string) Name of the drive List Object

Returns

This action dose not return any value.

Example

-- Eixample 1 object:
DriveList.StartEvents("Plugin1")
-- 2 objects..
DriveList.StartEvents("Plugin1","Plugin2")
-- 3 objects
DriveList.StartEvents("Plugin1","Plugin2","Plugin3")

This File Was Generated With AMS ActionFile Editor