ABI Help File

ABI Help File

Plugin Name:

ABI

Current Version:

3.0.0.1

Description:

Action Bank Infusion
This plugin adds some much-needed, functions to the general Action Bank.
New Actions range from DialogEx functions to XML functions and are infused directly into their respective parent tables.

Licence:

Free to use and distribute.

Author:

Centauri Soldier

Web:

www.AMSPublic.com

E-mail:

CentauriSoldier@AMSPublic.com

Copyright:

Copyright © 2010 AMSPuclic.com

Install Notes:

Place the "ABI" folder in your "AutoPlay Media Studio 8.0/Plugins/Action" folder.


Table of Contents

Application.GetPageOrDialog
Application.IsDialog
DialogEx.Close
DialogEx.Show
Folder.Clear
Folder.GetEndFolder
Folder.GetParent
String.Capatalize
String.IsBlank
String.ToTable
Window.Center

Application.GetPageOrDialog


(string) Application.GetPageOrDialog ()

Description

Returns the name of the current page or dialog.

Returns

(string)
Returns the name of the page or dialog.


Application.IsDialog


(boolean) Application.IsDialog ()

Description

Determines whether or not the current window is a dialog.

Returns

(boolean)
Returns true if the current window is a dialog and false if it is a page.


DialogEx.Close


DialogEx.Close ( 

(variant) Argument = vRet )

Description

Together with the revised, DialogEx.Show() function, this function allows the programmer to return any variable type from a DialogEx window.

Note: This DialogEx code is the combination of code By Centauri Soldier and Shadiku (ShadowUK)

Parameters

Argument

(variant) The argument you wish to return.

Note: This can be of ANY variable type.

Returns

This action dose not return any value.


DialogEx.Show


(number) DialogEx.Show ( 

(string) Dialog = "MyDialog" )

Description

Together with the revised, DialogEx.Close() function, this function allows the programmer to return any variable type from a DialogEx window.

Note: This DialogEx code is the combination of code By Centauri Soldier and Shadiku (ShadowUK)

Parameters

Dialog

(string) The name of the Dialog you wish to show.

Returns

(number)
Returns any value entered to the variable assigned to DialogEx.Show()

Additional:
This function operates exactly as the original except that you can return any variable type you desire (string, number, table etc.).


Folder.Clear


(boolean) Folder.Clear ()

Description

Removes all files and sub folders from the specifed folder.

Returns

(boolean)
Returns 0 if the action was successful.
Returns -1 if the folder does not exist.
Returns the error number if a different error occured.


Folder.GetEndFolder


(string) Folder.GetEndFolder ( 

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

Description

Gets the name of the last folder in a folder path.

Parameters

Path

(string) The folder path to search.

Returns

(string)
Returns the last folder in the path.
If an error occurs or there is no end folder, a blank string is returned.


Folder.GetParent


(string) Folder.GetParent ( 

(string) Path = "C:\\Test\\New Folder" )

Description

Gets the parent folder of the specified folder path.

Parameters

Path

(string) The file/folder path.

Returns

(string)
Returns the path to the parent folder.
If an error occurs then a blank string is returned.


String.Capatalize


(string) String.Capatalize ( 

(string) Input = "i wish I could write properly!" )

Description

Capatalizes the first letter of a string.

Parameters

Input

(string) The string to capatalize.

Returns

(string)
Returns the input string with the first word capatalized.


String.IsBlank


(boolean) String.IsBlank ( 

(string) Input = " ",

(boolean) Remove Spaces = true )

Description

Determines whether or not the input string is blank.

Parameters

Input

(string) The input string to check.

Remove Spaces

(boolean) Whether or not all spaces should be removed when checking the string.

Note: This is very useful for instances such as getting a string from an input object that may contain only spaces.

Returns

(boolean)
Returns true if the string is blank and false if it is not.


String.ToTable


(table) String.ToTable ( 

(string) String = "Item1, Item2, Some More Stuff, etc",

(string) Delimiter = "," )

Description

Creates a table from a delimited string.

Note: Orginal function by IR, modified by Centauri Soldier.

Parameters

String

(string) The original string to convert to a table.

Delimiter

(string) The control character that delimits the sections of the string that should separate.

Returns

(table)
Returns a numerically indexed table whose values are the delimited items in the original string.


Window.Center


Window.Center ( 

(number) Handle = Application.GetWndHandle() )

Description

Centers a window in the middle of the user's desktop.

Parameters

Handle

(number) The handle of the window to center.

Returns

This action dose not return any value.



Copyright © 2010 AMSPuclic.com
This File Was Generated With AMS ActionFile Editor