Explorer Object Action Plugin Help File

Explorer Object Action Plugin Help File

Plugin Name:

Explorer Object Action Plugin

Current Version:

1.0.0.0

Description:

Explorer objects acton plugin gives you 3 powerful file explorer objects that show a listing of a directory just as Windows Explorer does, It lets the user choose a file or a folder and (if you do not prevent it by a flag) navigate through the whole directory tree.

Author:

RizlaUK


Table of Contents

Explorer.CreateList
Explorer.CreateTree
Explorer.CreateCombo
Explorer.SetSize
Explorer.GetSize
Explorer.SetPos
Explorer.GetPos
Explorer.SetPath
Explorer.GetPath
Explorer.GetSelectedType
Explorer.GetFile
Explorer.SetDisplayMode
Explorer.SetCallBack
Explorer.SetHeaderWidth
Explorer.GetHeaderWidth
Explorer.SetHeaderText
Explorer.GetHeaderText
Explorer.SetBackCol
Explorer.GetBackCol
Explorer.SetFrontCol
Explorer.GetFrontCol
Explorer.SetLineCol
Explorer.GetLineCol
Explorer.SetVisible
Explorer.IsVisible
Explorer.SetEnabled
Explorer.IsEnabled
Explorer.EnterKey
Explorer.SetUnpackPath
Explorer.SetPattern

Explorer.CreateList


(number) Explorer.CreateList ( 

(number) Hwnd,

(number) X,

(number) Y,

(number) Width,

(number) Height,

(string) DefaultDir,

(table) Flags = nil )

Description

Creates a listing of a directory just as Explorer does.

Parameters

Hwnd

(number) The handle of the host window or object.

Note: This must be a valid window handle.

X

(number) The X position of the object.

Note: This is relative to the upper left corner of the host window or object.

Y

(number) The Y position of the object.

Note: This is relative to the upper left corner of the host window or object.

Width

(number) The Width of the object in pixels.

Height

(number) The Height of the object in pixels.

DefaultDir

(string) The initial displayed directory, it can include one or multiple patterns, like "C:\*.ini;*.txt".

Note: If no pattern is included, the directory must end with a '\'. Including no directory will display the root containing the drives. Including no pattern defaults to '*.*'. So a Directory$ of "" will display the root and set '*.*' as pattern.

Flags

(table) Flags

Note: 'Flags' can be a combination of the following values:

tbListFlags.BorderLess -- Create Gadget without borders
tbListFlags.AlwaysShowSelection -- The selection is visible, even when the gadget is Not activated.
tbListFlags.MultiSelect -- Enable multiple selection of items in the gadget.
tbListFlags.GridLines -- Display separator lines between rows And columns.
tbListFlags.HeaderDragDrop -- In report view, the headers can be changed by Drag'n'Drop.
tbListFlags.FullRowSelect -- The selection covers the full row instead of the first column.
tbListFlags.NoFiles -- No files will be displayed.
tbListFlags.NoFolders -- No folders will be displayed.
tbListFlags.NoParentFolder -- There will be no [..] link To the parent folder.
tbListFlags.NoDirectoryChange -- The directory cannot be changed by the user.
tbListFlags.NoDriveRequester -- There will be no 'please insert drive X;' displayed.
tbListFlags.NoSort -- The user cannot sort the content by clicking on a column header.
tbListFlags.NoMyDocuments -- The 'My Documents' Folder will Not be displayed As a separate item.
tbListFlags.AutoSort -- The content will be sorted automatically by name.

Returns

(number) Returns a unique numeric ID for the object, or nil if any error.


Explorer.CreateTree


(number) Explorer.CreateTree ( 

(number) Hwnd,

(number) X,

(number) Y,

(number) Width,

(number) Height,

(string) DefaultDir,

(table) Flags = nil )

Description

Creates a listing of a directory just as Explorer does.

Parameters

Hwnd

(number) The handle of the host window or object.

Note: This must be a valid window handle.

X

(number) The X position of the object.

Note: This is relative to the upper left corner of the host window or object.

Y

(number) The Y position of the object.

Note: This is relative to the upper left corner of the host window or object.

Width

(number) The Width of the object in pixels.

Height

(number) The Height of the object in pixels.

DefaultDir

(string) The initial displayed directory, it can include one or multiple patterns, like "C:\*.ini;*.txt".

Note: If no pattern is included, the directory must end with a '\'. Including no directory will display the root containing the drives. Including no pattern defaults to '*.*'. So a Directory$ of "" will display the root and set '*.*' as pattern.

Flags

(table) Flags

Note: 'Flags' can be a combination of the following values:

tbTreeFlags.BorderLess -- Create Gadget without borders.
tbTreeFlags.AlwaysShowSelection -- The selection is still visible, even when the gadget is not activated.
tbTreeFlags.NoLines -- Hide the little lines between each node.
tbTreeFlags.NoButtons -- Hide the '+' node buttons.
tbTreeFlags.NoFiles -- No files will be displayed.
tbTreeFlags.NoDriveRequester -- There will be no 'please insert drive X:' displayed.
tbTreeFlags.NoMyDocuments -- The 'My Documents' Folder will not be displayed as a separate item.
tbTreeFlags.AutoSort -- The content will be sorted automatically by name.

Returns

(number) Returns a unique numeric ID for the object, or nil if any error.


Explorer.CreateCombo


(number) Explorer.CreateCombo ( 

(number) Hwnd,

(number) X,

(number) Y,

(number) Width,

(number) Height,

(string) DefaultDir,

(table) Flags = nil )

Description

Creates a listing of a directory just as Explorer does.

Parameters

Hwnd

(number) The handle of the host window or object.

Note: This must be a valid window handle.

X

(number) The X position of the object.

Note: This is relative to the upper left corner of the host window or object.

Y

(number) The Y position of the object.

Note: This is relative to the upper left corner of the host window or object.

Width

(number) The Width of the object in pixels.

Height

(number) The Height of the object in pixels.

DefaultDir

(string) the initial displayed directory (must be set as full path), an empty string specifies the root folder.

Note: If the tbComboFlags.DrivesOnly flag is set to true, DefaultDir may only be a drive letter. Everything that follows the drive letter in this case will be ignored.

Flags

(table) Flags

Note: 'Flags' can be a combination of the following values:

tbComboFlags.DrivesOnly -- The gadget will only display drives to choose from.
tbComboFlags.Editable -- The gadget will be editable with an autocomplete feature. With this flag set, it acts exactly like the one in Windows Explorer.
tbComboFlags.NoMyDocuments -- The 'My Documents' Folder will not be displayed as a separate item.

Returns

(number) Returns a unique numeric ID for the object, or nil if any error.


Explorer.SetSize


Explorer.SetSize ( 

(number) ObjectID,

(number) Width,

(number) Height )

Description

Sets the size of a object in pixels.

Parameters

ObjectID

(number) The numeric ID of the object.

Width

(number) The new width of the object in pixels.

Height

(number) The new height of the object in pixels.

Returns

This action dose not return any value.


Explorer.GetSize


(number) Explorer.GetSize ( 

(number) ObjectID )

Description

Gets the size of a object in pixels.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

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


Explorer.SetPos


Explorer.SetPos ( 

(number) ObjectID,

(number) X,

(number) Y )

Description

Sets the position of a object relative to its host windoe/object.

Parameters

ObjectID

(number) The numeric ID of the object.

X

(number) The new x position of the object.

Note: This is relative to the upper left corner of the host window or object.

Y

(number) The new y position of the object.

Note: This is relative to the upper left corner of the host window or object.

Returns

This action dose not return any value.


Explorer.GetPos


(number) Explorer.GetPos ( 

(number) ObjectID )

Description

Gets the position of a object relative to its host windoe/object.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

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


Explorer.SetPath


Explorer.SetPath ( 

(number) ObjectID,

(string) Path )

Description

Changes the currently displayed directory.

Parameters

ObjectID

(number) The numeric ID of the object.

Path

(string) The new full path to set the object.

Note: It can include one or multiple patterns, like "C:\*.ini;*.txt".

Returns

This action dose not return any value.


Explorer.GetPath


(string) Explorer.GetPath ( 

(number) ObjectID )

Description

Get the currently selected directory.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(string) Returns the full path to the selected folder or a blank string if any error.


Explorer.GetSelectedType


(number) Explorer.GetSelectedType ( 

(number) ObjectID )

Description

Check if the current selection is a directory or a file.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(number) Returns:
0 = No Selected
1= File
2 = Directory


Explorer.GetFile


(string) Explorer.GetFile ( 

(number) ObjectID )

Description

Gets the current selected file name.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(string) Returns the file name of the current selection, if there is no selection or a directory is select then a blank string is returned.


Explorer.SetDisplayMode


Explorer.SetDisplayMode ( 

(number) ObjectID,

(number) Mode )

Description

Sets the current display mode of the list.

Note: This function only works on the ExplorerList object.

Parameters

ObjectID

(number) The numeric ID of the object.

Mode

(number) The mode to set the list.

CONSTANT

VALUE

DESCRIPTION

Explorer_LargeIcon

0

Large icon mode

Explorer_SmallIcon

1

Small icon mode

Explorer_List

2

List icon mode

Explorer_Report

3

Report mode (columns, Default mode).

Returns

This action dose not return any value.


Explorer.SetCallBack


Explorer.SetCallBack ( 

(number) ObjectID,

(string) Callback )

Description

Sets the main callback function.

Parameters

ObjectID

(number) The numeric ID of the object.

Callback

(string) The name of the callback function.

Returns

This action dose not return any value.


Explorer.SetHeaderWidth


Explorer.SetHeaderWidth ( 

(number) ObjectID,

(number) Width )

Description

Sets the with of the ExplorerList header column.

Note: This function only works on the ExplorerList in Report mode.

Parameters

ObjectID

(number) The numeric ID of the object.

Width

(number) The new width of the header.

Returns

This action dose not return any value.


Explorer.GetHeaderWidth


(number) Explorer.GetHeaderWidth ( 

(number) ObjectID )

Description

Gets the with of the ExplorerList header column.

Note: This function only works on the ExplorerList in Report mode.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(number) Returns the width in pixels of the ExplorerList header, or -1 if any errror.


Explorer.SetHeaderText


Explorer.SetHeaderText ( 

(number) ObjectID,

(string) Text )

Description

Sets the Text of the ExplorerList header column.

Note: This function only works on the ExplorerList in Report mode.

Parameters

ObjectID

(number) The numeric ID of the object.

Text

(string) The new text of the header.

Returns

This action dose not return any value.


Explorer.GetHeaderText


(string) Explorer.GetHeaderText ( 

(number) ObjectID )

Description

Gets the Text of the ExplorerList header column.

Note: This function only works on the ExplorerList in Report mode.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(string) Returns the text from a ExplorerList header or a blank string if any error.


Explorer.SetBackCol


Explorer.SetBackCol ( 

(number) ObjectID,

(number) Color )

Description

Sets the background color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Color

(number) The decimal color code.

Returns

This action dose not return any value.


Explorer.GetBackCol


(number) Explorer.GetBackCol ( 

(number) ObjectID )

Description

Gets the background color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(number) Returns the decimal color code of the objects background, if any error or no color set, -1 is returned.


Explorer.SetFrontCol


Explorer.SetFrontCol ( 

(number) ObjectID,

(number) Color )

Description

Sets the front color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Color

(number) The decimal color code.

Returns

This action dose not return any value.


Explorer.GetFrontCol


(number) Explorer.GetFrontCol ( 

(number) ObjectID )

Description

Gets the front color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(number) Returns the decimal color code of the objects text, if any error or no color set, -1 is returned.


Explorer.SetLineCol


Explorer.SetLineCol ( 

(number) ObjectID,

(number) Color )

Description

Sets the Line color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Color

(number) The decimal color code.

Returns

This action dose not return any value.


Explorer.GetLineCol


(number) Explorer.GetLineCol ( 

(number) ObjectID )

Description

Gets the Line color of the object.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(number) Returns the decimal color code of the objects Lines, if any error or no color set, -1 is returned.


Explorer.SetVisible


Explorer.SetVisible ( 

(number) ObjectID,

(boolean) Visible )

Description

Sets visible state of the object.

Parameters

ObjectID

(number) The numeric ID of the object.

Visible

(boolean) True to set the object visible.

Returns

This action dose not return any value.


Explorer.IsVisible


(boolean) Explorer.IsVisible ( 

(number) ObjectID )

Description

Gets visible state of the object.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(boolean) Returns true if the object is visible, fals if not or if any error.


Explorer.SetEnabled


Explorer.SetEnabled ( 

(number) ObjectID,

(boolean) Enabled )

Description

Sets enabled state of the object.

Parameters

ObjectID

(number) The numeric ID of the object.

Enabled

(boolean) True to set the object enabled.

Returns

This action dose not return any value.


Explorer.IsEnabled


(boolean) Explorer.IsEnabled ( 

(number) ObjectID )

Description

Gets enabled state of the object.

Parameters

ObjectID

(number) The numeric ID of the object.

Returns

(boolean) Returns true if the object is enabled, fals if not or if any error.


Explorer.EnterKey


Explorer.EnterKey ( 

(string) Key )

Description

Unlocks the nag dialog.

Parameters

Key

(string) The key you recived from D-Net when you purchased.

Returns

This action dose not return any value.


Explorer.SetUnpackPath


Explorer.SetUnpackPath ( 

(string) Path )

Description

Overrides the default dll resource path.

Note: Default folder is: "AutoPlay\Plugins\Explorer\Explorer.dll"

Parameters

Path

(string) The path to the support dll.

Note: If you change the name of the resource folder you will need to set this to the correct path, EG: "data\\Plugins\\Explorer\\Explorer.dll" you you can use a temp directory.

Returns

This action dose not return any value.


Explorer.SetPattern


Explorer.SetPattern ( 

(string) Pattern )

Description

Sets the file pattern mask.

Note: This function only works on ExplorerList and ExplorerTree objects.

Parameters

Pattern

(string) The path to the support dll.

Note: If you change the name of the resource folder you will need to set this to the correct path, EG: "data\\Plugins\\Explorer\\Explorer.dll" you you can use a temp directory.

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor