< Anterior | Avançar >

Gl ob a l s

OverviewGlobal FunctionsBuilt In

AutoPlay Media Studio comes with some built-in global functions to make certain runtime tasks simpler.

Note: These optional functions are automatically called by your application. You do not call them in your script, only define them.

General Project Functions

General project functions are called by the application whenever something project-wide happens. These functions allow the developer to control how certain aspects of the published application behave.

g _ On S y s t em T ray M e nu ( nu m b er X , nu m b er Y )

Called whenever the user right-clicks on your application's system tray icon. Typically, you would use

Application.ShowPopupMenu in this function to create a right-click popup menu from the system tray.

X:

The X coordinate, in pixels, in relation to the top left corner of the user's screen.

Y:

The Y coordinate, in pixels, in relation to the top left corner of the user's screen.

Re t u r n s :

Nothing.

E xam pl e :

function g_OnSystemTrayMenu(X, Y) tblMenu = {};

tblMenu[1] ={}; tblMenu[1].Text = "&New Menu"; tblMenu[1].ID = 100; tblMenu[1].Checked = false; tblMenu[1].Enabled = true; tblMenu[1].SubMenu = {}; tblMenu[1].SubMenu[1] = {};

tblMenu[1].SubMenu[1].Text = "&SubItem 1"; tblMenu[1].SubMenu[1].ID = 101; tblMenu[1].SubMenu[1].Checked = false; tblMenu[1].SubMenu[1].Enabled = true; tblMenu[1].SubMenu[2] = {}; tblMenu[1].SubMenu[2].Text = "S&ubItem 2"; tblMenu[1].SubMenu[2].ID = 102; tblMenu[1].SubMenu[2].Checked = false; tblMenu[1].SubMenu[2].Enabled = true;

result = Application.ShowPopupMenu(X, Y, tblMenu, TPM_RIGHTALIGN, TPM_BOTTOMALIGN, true, false);

if(result ~= -1)then

Dialog.Message("Menu Item Selected",result);

end end

Qu eryA llow P r oj ec t C lo s e ( )

Called whenever the project is 'told' to close. Using this function, you can control how the user can close the application, such as confirming with the user that they intended to close the application.

Re t u r n s :

True if the application should close, false if it should not close.

E xam pl e :

function QueryAllowProjectClose()

result= Dialog.Message("Application Exit", "Are you sure that you want to quit?", MB_YESNO, MB_ICONEXCLAMATION, MB_DEFBUTTON1);

--if they choose yes

if result == IDYES then

--allow the app to close return true;

else

--cancel close return false;

end

end

g _ OnG e t M in M ax I n f o ( )

Called whenever the application is resized at runtime. Using this function, you can set the minimum and maximum application window size for your project. If 'Resizable' is not checked in your application's Project Settings, this function is ignored.

Note: If this function is not defined then window size during a resize will not be restricted.

Note: The Min. height and Min. width settings on the Appearance tab of the Project Settings dialog can also be used to set a minimum page height and width, however this function will override those values.

Re t u r n s :

A table indexed by the following keys:

E xam pl e :

-- Restrict the window size to 200x100 minimum

-- and 800x600 maximum: function g_OnGetMinMaxInfo()

tbReturn = {}; tbReturn.MinX = 200;

tbReturn.MinY = 100;

tbReturn.MaxX = 800;

tbReturn.MaxY = 600;

end

return tbReturn;

Dialog Functions

Dialog functions are called by the application whenever dialogs are used. These functions allow the developer to control how certain aspects of the dialog behave.

Qu eryA llow D i a log C lo s e ( s t r ing D i a log Name )

Called whenever the dialog is 'told' to close. Using this function, you can control how the user can close the dialog, such as confirming with the user that they intended to close the dialog. This function will be called before the dialog's On Close event.

D i a log Name

A string containing the name of the dialog you want this function to be used on.

Re t u r n s :

True to allow the dialog to close, false to not close it.

E xam pl e :

function QueryAllowDialogClose(strDialogName)

result= Dialog.Message("Close Dialog", "Are you sure that you want to close the dialog?", MB_YESNO, MB_ICONEXCLAMATION, MB_DEFBUTTON1);

--if they choose yes

if result == IDYES then

--allow the dialog to close return true;

else

--cancel close return false;

end

end

Menu Bar Functions

Menu Bar functions are called by the application at runtime to allow the developer to dynamically enable/disable and check/uncheck menu items. By default these functions are not defined (and therefore will do nothing). These functions will only perform tasks if they are defined by the developer at design time.

bool ea n g _ On U pd a t e M e nu E n a bl e d ( nu m b er C o mma nd I D , t a bl e I t em I n f o )

Accepts both a Command ID and a table of item information from the AutoPlay runtime. Should return true if the current item should be enabled, and false if the current item should be disabled.

C o mma nd I D :

The ID of the currently selected menu item.

I t em I n f o :

A table of information about the currently selected item, indexed by the following keys:

Re t u r n s :

True if the current item should be enabled, false if the current item should not be enabled.

E xam pl e :

function g_OnUpdateMenuEnabled(CommandID,tblInfo)

-- Disable command 2000

if (CommandID == 2000) then return false;

else

return true;

end

end

bool ea n g _ On U pd a t e M e nu C h eck ( nu m b er C o mma nd I D , t a bl e I t em I n f o )

Accepts both a Command ID and a table of item information from the AutoPlay runtime. Should return true if the current item should be checked, and false if the current item should not be checked.

C o mma nd I D

The ID of the currently selected menu item.

I t em I n f o

A table of information about the currently selected item, indexed by the following keys:

Re t u r n s :

True if the current item should be checked, false if the current item should not be checked.

E xam pl e :

function g_OnUpdateMenuCheck(CommandID,tblInfo)

-- Uncheck command 2000

if (CommandID == 2000) then return false;

else

return true;

end

end

G e n e r a l In f o

ContentsInput Mask

An input mask is a special pattern that controls what the user can type into a MaskedInput dialog or input object at run time. The mask can be any combination of regular text characters (literal characters) and special characters. Each special character, as outlined below, represents one "place" in the edit field where the user can type a character. Different special characters allow different kinds of characters to be typed in their "place" by the user. For example, the # character only allows a digit between 0 and 9 to be typed in its place, and the ? character only allows a letter between a and Z.

Note: The special characters you use in the input mask determine what the user will be allowed to type into the edit field.

You can use any literal characters to include "normal" characters in the edit field. The user will type "around" the literal characters as they fill in the "blanks" created by the special characters.

Here are the special characters that you can use in an input mask:

Note: Some of these special literal characters adapt to the user's system settings, so they may need to be forced on all systems using "\" before the character.

...which would appear as: IP Address: . . .

(Note that we needed to use the literal escape for the 'A' in Address, the colon, and all three decimal points.)

< Anterior | Avançar >