Action Extension Plugin Help File

Action Extension Plugin Help File

Plugin Name:

Action Extension Plugin

Current Version:

1.2.0.0

Description:

Pack of actions and functions useful for Autoplay Media Studio

Author:

Ceone&rafaxplayer

Web:

amsspecialist.info

Requirements:

Autoplay Media Studio 8


Table of Contents

AE.AudioSecToTime
AE.GridFindSelected
AE.GridFindCellText
AE.GridResetCellColor
AE.ImageSetCurProgress
AE.ImageGetCurProgress
AE.ImageLoadFadeImage
AE.ImageFadeIn
AE.ImageFadeOut
AE.InputSetWordWrap
AE.InputGetWordWrap
AE.InputSaveToFile
AE.InputLoadFromFile
AE.InputAlignText
AE.ListBoxAddCharacter
AE.ListBoxDelCharacter
AE.ListBoxDeleteItemsRepeat
AE.PageOverObject
AE.PageDragAndDrop
AE.PageMoveGroup
AE.SessionVarExpand
AE.SessionVarGet
AE.SessionVarRemove
AE.SessionVarSet
AE.SessionVarGetAll
AE.StringRandomFromPattern
AE.StringDelimitedToTable
AE.StringGetLastFolder
AE.StringGetAllFolder
AE.SystemFindAndCloseProcess
AE.SystemLogOff
AE.SystemClose
AE.TableDelimitedToString
AE.WindowSetPosAlwais
AE.ZipAddFile
AE.ZipAddFolderTree
AE.TablePrint
AE.InputSetTextAppend
AE.TreeGetNodes
AE.GridGetCells
AE.GridExSaveToFile
AE.GridExLoadFromFile

AE.AudioSecToTime


(table) AE.AudioSecToTime ( 

(number) Seconds,

(boolean) TableMode = false )

Description

It turns seconds into format time. The time is represented as a number based 60. (limited in 86400 Secs = Day). if active table mode return system is, Example: result.Hours or result.Minutes or result.Seconds or result.Complete.

Parameters

Seconds

(number) Secons to convert in format time.

TableMode

(boolean) Table mode is for return table with all values. Example: result.Hours or result.Minutes or result.Seconds or result.Complete.

Returns

(table)


AE.GridFindSelected


(table) AE.GridFindSelected ( 

(string) ObjectName )

Description

Find selected to return Row and Column.

Parameters

ObjectName

(string) The name of the object.

Returns

(table)


AE.GridFindCellText


AE.GridFindCellText ( 

(string) ObjectName,

(string) FindText = "",

(number) ColorHighlighted = 10092543,

(boolean) ResetColor = true,

(table) PropertiesTable )

Description

Find the text in the object.

Parameters

ObjectName

(string) The name of the object.

FindText

(string) The text you want in the object.

ColorHighlighted

(number) The color highlighted cell.

ResetColor

(boolean) Reset the color highlighted cell.

PropertiesTable

(table) The table of properties to set color cells.

Returns

This action dose not return any value.


AE.GridResetCellColor


AE.GridResetCellColor ( 

(string) ObjectName,

(boolean) DefineColors = false,

(number) BackgroundColor = 16777215,

(number) TextColor = 0 )

Description

To Reset the cell colors.

Parameters

ObjectName

(string) The name of the object.

DefineColors

(boolean) To define colors of items in the object.

BackgroundColor

(number) The BackgroundColor.

TextColor

(number) The Text color.

Returns

This action dose not return any value.


AE.ImageSetCurProgress


AE.ImageSetCurProgress ( 

(string) ObjectName,

(number) SizeImageWidth,

(number) ProgressPosition,

(function) CallbackFunction = nil )

Description

Set current position progress to select image.

Parameters

ObjectName

(string) The name of the image object.

SizeImageWidth

(number) Width size to select image file.

ProgressPosition

(number) Current pogress position to select image file.

CallbackFunction

(function) The name of a function that will be called whenever progress is made in the copy operation.

Returns

This action dose not return any value.


AE.ImageGetCurProgress


(number) AE.ImageGetCurProgress ( 

(string) ObjectName,

(number) SizeImageWidth )

Description

Returns progress from the specified image file.

Parameters

ObjectName

(string) The name of the image object.

SizeImageWidth

(number) Width size to select image file.

Returns

(number)


AE.ImageLoadFadeImage


AE.ImageLoadFadeImage ( 

(string) ObjectName,

(string) ImageFile,

(number) MaximunOpacity,

(number) MinimumOpacity,

(number) TimeOut,

(function) FunctionInBetween = nil )

Description

This action loads an image and in the meanwhile it fades the old loaded image out. When loading this image, it will fade in.

Parameters

ObjectName

(string) Image object, must be a string and ofcourse of type OBJECT_IMAGE

ImageFile

(string) Image File, Must exist, be string and an image file

MaximunOpacity

(number) Maximum Opacity, Must be of type number and lower than 100, higher than 0."OPTIONAL"

MinimumOpacity

(number) Minimum Opacity, Must be of type number and higher than 0, lower than 100."OPTIONAL"

TimeOut

(number) Timeout, The timeout in miliseconds between every opacity change."OPTIONAL"

FunctionInBetween

(function) Function in between, You can parse a function that will be executed between fading out and fading in the image."OPTIONAL"

Returns

This action dose not return any value.


AE.ImageFadeIn


(boolean) AE.ImageFadeIn ( 

(string) ObjectName,

(number) MaximunOpacity,

(number) TimeOut )

Description

Image Object, Must be of type OBJECT_IMAGE and must be parsed as string.

Parameters

ObjectName

(string) The name of the image object.

MaximunOpacity

(number) Maximum Opacity, Must be of type number and lower than 100, higher than 0."OPTIONAL"

TimeOut

(number) Timeout, The timeout in miliseconds between every opacity change."OPTIONAL"

Returns

(boolean)


AE.ImageFadeOut


(boolean) AE.ImageFadeOut ( 

(string) ObjectName,

(number) MinimumOpacity,

(number) TimeOut )

Description

Image Object, Must be of type OBJECT_IMAGE and must be parsed as string.

Parameters

ObjectName

(string) The name of the image object.

MinimumOpacity

(number) Minimum Opacity, Must be of type number and higher than 0, lower than 100."OPTIONAL"

TimeOut

(number) Timeout, The timeout in miliseconds between every opacity change."OPTIONAL"

Returns

(boolean)


AE.InputSetWordWrap


AE.InputSetWordWrap ( 

(string) ObjectName,

(boolean) HorizontalScroll = true )

Description

Set Horizontal Scroll to select input.

Parameters

ObjectName

(string) The name of the input object.

HorizontalScroll

(boolean) Show Horizontal Scroll to input object true or false.

Returns

This action dose not return any value.


AE.InputGetWordWrap


(boolean) AE.InputGetWordWrap ( 

(string) ObjectName )

Description

Return if Horizontal Scroll is enable or disable.

Parameters

ObjectName

(string) The name of the input object.

Returns

(boolean)


AE.InputSaveToFile


AE.InputSaveToFile ( 

(string) ObjectName,

(string) FileName,

(boolean) Append = false )

Description

For save text to input object in file.

Parameters

ObjectName

(string) The name of the input object.

FileName

(string) The path to the destination file that you want save.

Append

(boolean) Whether to append the string to the end of the text file.

Returns

This action dose not return any value.


AE.InputLoadFromFile


AE.InputLoadFromFile ( 

(string) ObjectName,

(string) FileName )

Description

For load text and print in input object from file.

Parameters

ObjectName

(string) The name of the input object.

FileName

(string) The path to the destination file that you want load.

Returns

This action dose not return any value.


AE.InputAlignText


AE.InputAlignText ( 

(string) ObjectName,

(number) Align = ALIGN_LEFT )

Description

For set align text in input object.

Parameters

ObjectName

(string) The name of the input object.

Align

(number) Set align text.

CONSTANT

VALUE

DESCRIPTION

ALIGN_LEFT

NA

NA

ALIGN_CENTER

NA

NA

ALIGN_RIGHT

NA

NA

Returns

This action dose not return any value.


AE.ListBoxAddCharacter


AE.ListBoxAddCharacter ( 

(string) ObjectName,

(string) Char = "*",

(boolean) OtherChar = false )

Description

To add a character predefined or personalized in front of all the items of a listbox.

Parameters

ObjectName

(string) The name of the listbox object.

Char

(string) The char to add.

CONSTANT

VALUE

DESCRIPTION

"*"

NA

NA

"-"

NA

NA

"~"

NA

NA

">"

NA

NA

"#"

NA

NA

OtherChar

(boolean) Use others char not default.

Returns

This action dose not return any value.


AE.ListBoxDelCharacter


AE.ListBoxDelCharacter ( 

(string) ObjectName,

(string) Char = "*",

(boolean) OtherChar = false )

Description

To delete a character predefined or personalized of all the item of a listbox

Parameters

ObjectName

(string) The name of the listbox object.

Char

(string) The char to add.

CONSTANT

VALUE

DESCRIPTION

"*"

NA

NA

"-"

NA

NA

"~"

NA

NA

">"

NA

NA

"#"

NA

NA

OtherChar

(boolean) Use others char not default.

Returns

This action dose not return any value.


AE.ListBoxDeleteItemsRepeat


AE.ListBoxDeleteItemsRepeat ( 

(string) ObjectName )

Description

To delete the repeated items of an object of listbox.

Parameters

ObjectName

(string) The name of the listbox object.

Returns

This action dose not return any value.


AE.PageOverObject


(boolean) AE.PageOverObject ( 

(string) ObjectName )

Description

Based in IsInRectEX Function. Is to detect if the mouse cursor is inside an object's rectangle of the specified object.

Parameters

ObjectName

(string) The name of the object.

Returns

(boolean)


AE.PageDragAndDrop


AE.PageDragAndDrop ( 

(string) NamePage,

(string) NameObject )

Description

Moves object on page.

Parameters

NamePage

(string) Name page.

NameObject

(string) name object

Returns

This action dose not return any value.


AE.PageMoveGroup


AE.PageMoveGroup ( 

(table) Group Objects = {"Button1", "Button2"},

(number) X Difference = 100,

(number) Y Difference = 100,

(boolean) Redraw = false )

Description

This action moves all of the items in a group by a specific value X and Y.

Parameters

Group Objects

(table) The name of the items with which to work. (In table Format)

X Difference

(number) The number of pixles by which to move the group horizontally.

Y Difference

(number) The number of pixles by which to move the group vertically.

Redraw

(boolean) Whether or not to redraw the application during the process.

Returns

This action dose not return any value.


AE.SessionVarExpand


(string) AE.SessionVarExpand ( 

(string) Text )

Description

Returns a string containing the contents of the given session variable.

Parameters

Text

(string) The session variable string you want to expand.

Returns

(string)


AE.SessionVarGet


(string) AE.SessionVarGet ( 

(string) VariableName )

Description

Returns the unexpanded contents of a session variable.

Parameters

VariableName

(string) The name of the session variable whose contents you want.

Returns

(string)


AE.SessionVarRemove


AE.SessionVarRemove ( 

(string) VariableName )

Description

Removes the given session variable from the session variable manager at runtime.

Parameters

VariableName

(string) The name of the session variable you want to remove (undefine).

Returns

This action dose not return any value.


AE.SessionVarSet


AE.SessionVarSet ( 

(string) VariableName,

(string) Value )

Description

Sets the given session variable to the specified value.

Parameters

VariableName

(string) The name of the session variable whose value you want to set.

Value

(string) The value you want to set the session variable to.

Returns

This action dose not return any value.


AE.SessionVarGetAll


(table) AE.SessionVarGetAll ()

Description

Returns all contents of a session variable.

Returns

(table)


AE.StringRandomFromPattern


(string) AE.StringRandomFromPattern ( 

(string) Pattern )

Description

To return a random string based on a given pattern.

Parameters

Pattern

(string)  The pattern to base the random string on. # = (0-9), * = (A-Z), @ = (a-z), ? = (0-9,A-Z), ~ = (0-9,A-Z,a-z). Any other charater is the same. More information: # - A random digit (0-9) * - A random uppercase letter (A-Z) @ - A random lowercase letter (a-z) ? - A random digit or uppercase letter (0-9,A-Z) ~ - A random digit, upppercase or lowercase letter (0-9,A-Z,a-z) Any other charater - Remains the same. Examples: String.RandomFromPattern("###-###"); -- could produce: "6355-0989" String.RandomFromPattern("TEST-***"); -- could produce: "TEST-HAJ" String.RandomFromPattern("~~~~~~~~~~"); -- could produce: "7Hg543fp02"

Returns

(string)


AE.StringDelimitedToTable


(table) AE.StringDelimitedToTable ( 

(string) DelimitedString,

(string) Delimiter )

Description

Breaks up a string given a delimiter into a table. Returns A numerically indexed table with the string elements.

Parameters

DelimitedString

(string) The string to parse.

Delimiter

(string) The delimiter.

Returns

(table)


AE.StringGetLastFolder


(string) AE.StringGetLastFolder ( 

(string) FilePath )

Description

Returns a last folder path.

Parameters

FilePath

(string) The file path you want the last folder.

Returns

(string)


AE.StringGetAllFolder


(string) AE.StringGetAllFolder ( 

(string) FilePath )

Description

Returns all folders in the specified path.

Parameters

FilePath

(string) The file path you want to abbreviate.

Returns

(string)


AE.SystemFindAndCloseProcess


AE.SystemFindAndCloseProcess ( 

(string) Programname,

(boolean) Question = true,

(string) Personalizedquestion )

Description

Find and close running process on the local system.

Parameters

Programname

(string) The full name of program.

Question

(boolean) To activate question to close the application.

Personalizedquestion

(string) This is for personalized text of question.

Returns

This action dose not return any value.


AE.SystemLogOff


AE.SystemLogOff ()

Description

Log off the user's system.

Returns

This action dose not return any value.


AE.SystemClose


AE.SystemClose ()

Description

Close the user's system.

Returns

This action dose not return any value.


AE.TableDelimitedToString


(variant) AE.TableDelimitedToString ( 

(table) Table,

(string) Delimiter )

Description

Makes a table into a delimited string. Returns a delimited string of the table elements.

Parameters

Table

(table) The table to make into a string.

Delimiter

(string) The delimiter.

Returns

(variant)


AE.WindowSetPosAlwais


AE.WindowSetPosAlwais ( 

(variant) Position )

Description

Set the position of the application using a predefined parameters, respecting the taskbar.

Parameters

Position

(variant) Set Application Position.

CONSTANT

VALUE

DESCRIPTION

TOP_CENTER

NA

NA

TOP_RIGTH

NA

NA

TOP_LEFT

NA

NA

CENTER

NA

NA

LEFT_CENTER

NA

NA

RIGTH_CENTER

NA

NA

BOTTOM_LEFT

NA

NA

BOTTOM_CENTER

NA

NA

BOTTOM_RIGTH

NA

NA

Returns

This action dose not return any value.


AE.ZipAddFile


AE.ZipAddFile ( 

(string) ZipFile,

(table) FilesToAdd,

(boolean) IncludeFolderNames = true,

(string) Password = "",

(number) CompFactor = 5,

(function) CallbackFunction = nil,

(boolean) Recurse = false )

Description

Adds a file (or multiple files if you use a mask) to a Zip file by filename instead of using a table to specify filenames. Same Arguments as Zip.Add except that the second argument (FileToAdd) is a filename instead of a table.

Parameters

ZipFile

(string) The full path and file name of the Zip archive file.

FilesToAdd

(table) A table containing the full paths to all of the files you want to add.

IncludeFolderNames

(boolean) Whether to preserve folder names in the archive when adding files.

Password

(string) The password to use to protect the Zip file. This password will be needed to extract the files. This parameter is optional. If you don't want to protect the Zip file, just leave this parameter blank.

CompFactor

(number) The compression factor to use for the Zip file (0-9). 0 is the fastest and compresses the least, 9 is the slowest and compresses the most. The default is 5.

CallbackFunction

(function) The name of a function that will be called whenever progress is made in adding a file to the Zip archive. (You can use this callback function to display the progress of each file's archiving in your own custom way.).

Recurse

(boolean) Whether to recurse subfolders when wildcards are used.

Returns

This action dose not return any value.


AE.ZipAddFolderTree


AE.ZipAddFolderTree ( 

(string) ZipFile,

(table) BaseFolder,

(string) Password = "",

(number) CompFactor = 5,

(function) CallbackFunction = nil )

Description

Adds an entire folder tree (a folder, the files it contains and all files in all subfolders.Same as Zip.Add except that the second argument (BaseFolder) is a folder path instead of a table and the IncludeFolderNames and Recurse arguments are not passed in (they are set automatically).

Parameters

ZipFile

(string) The full path and file name of the Zip archive file.

BaseFolder

(table) Full paths to all of the folder you want to add.

Password

(string) The password to use to protect the Zip file. This password will be needed to extract the files. This parameter is optional. If you don't want to protect the Zip file, just leave this parameter blank.

CompFactor

(number) The compression factor to use for the Zip file (0-9). 0 is the fastest and compresses the least, 9 is the slowest and compresses the most. The default is 5.

CallbackFunction

(function) The name of a function that will be called whenever progress is made in adding a file to the Zip archive. (You can use this callback function to display the progress of each file's archiving in your own custom way.).

Returns

This action dose not return any value.


AE.TablePrint


(string) AE.TablePrint ( 

(table) tbl )

Description

Print tables (thanks webultra)

Parameters

tbl

(table) Table to print

Returns

(string) Returns a string with the table


Example

t={"a","b","c","d","e","f","g"};
Debug.ShowWindow(true);
Debug.Print(AE.TablePrint(t));



AE.InputSetTextAppend


AE.InputSetTextAppend ( 

(string) ObjectName,

(string) Text,

(boolean) Append = true )

Description

Set text to imput and opcion append

Note: add text input even without overwriting

Parameters

ObjectName

(string) Name of the object

Text

(string) Text to print

Append

(boolean) True append , false not append

Value

Description

true

(Default) Append

false

Not Append

Returns

This action dose not return any value.


Example

Input.SetTextAppend("Input1","More text",true);



AE.TreeGetNodes


(table) AE.TreeGetNodes ( 

(string) TreeName = "Tree1" )

Description

Get de tree nodes contens

Parameters

TreeName

(string) The name of tree object

Returns

(table) A table containing all node's properties, indexed by the following keys:


Example

t=Tree.GetNodes(TreeName)
Debug.ShowWindow(true);
Debug.Print(AE.TablePrint(t));



AE.GridGetCells


(table) AE.GridGetCells ( 

(string) strGrid = "Grid1" )

Description

Get all properties of cells Object

Parameters

strGrid

(string) The Object Name

Returns

(table)


Example

sFile= "AutoPlay\\Docs\\Grid.csv"
delimitier = ",";
strObject= "Plugin2";
AE.GridExLoadFromFile(strObject,sFile,delimit



AE.GridExSaveToFile


AE.GridExSaveToFile ( 

(string) ObjectName,

(string) Delimitier = "," )

Description

Use to save GridEx Object plugin data to file, delimitier string

Parameters

ObjectName

(string) Name of te Gridex Object

Delimitier

(string) Delimitier used

Returns

This action dose not return any value.


AE.GridExLoadFromFile


AE.GridExLoadFromFile ( 

(string) ObjectName,

(string) FilePath,

(string) Delimitier )

Description

Load gridex data from file

Parameters

ObjectName

(string) Name of the Object

FilePath

(string) File path

Delimitier

(string) Delimitier used

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor