ShapeContainer Help File

 Welcome

• Create new project
  
• In Menu Project Global Action (On StartUp) add the following code:

startpage = true;
startdialog = true;

• On the First page on your Project add the following code to "On Show" Event:

if startpage then
    -------------------------------------------------------------------
    -- Add here all objects that will be inside the created shape container
    -- The visibility state of each object inside will be managed by each ShapeContainer
    -- If extended scripting will be enabled
    -------------------------------------------------------------------
    startpage = false;
end

• If you going to use ShapeContainer on a DialogEx, add the following code:

OnPreloadDialogExSetScript()

if startdialog then
    -------------------------------------------------------------------
    -- Add here all objects that will be inside the created shape container
    -- The visibility state of each object inside will be managed by each ShapeContainer
    -- If extended scripting will be enabled
    -------------------------------------------------------------------
    startdialog = false;
end

• Add 2 shape object to your page or dialog (for each dialog 2 more shapes need to be added, eg: if you want to create 4 ShapeContainer then you need to add 8 object shape to your page or dialog and each shape object must have an unique id (label).
• For each shape added, setup the propertie of StrokeSize that can not be set at runtime (at least dunno how to do).

(boolean) ShapeContainer.AddObjects (

(number) n = 1, (table) tbl_objects = {"Label1",{20,20},"Label2",{20,40}}, (string) link = "http://www.microsoft.com", (boolean) msg = false )

Description

This action allow to add existing objects (collapse and expand) into the ShapeContainer. (Objects must exist on the stage: Page or Dialog, you can add them after the creation of ShapeContainer).

THIS ACTION DOES NOT CREATE ANY AMS OBJECTS (except for built in ShapeContenair objects)
( You must create the ShapeContainer before adding AMS objects )

Note: Arguments multiples

Parameters

n

(number) ShapeContainer index (using .Create and begin at 1, default = 0)

Note: Argument must be a valid number (index of ShapeContainer that you created before)
(number) n = 1

tbl_objects

(table) Table of all objects that will be management by the created ShapeContainer

Note: Arguments multiples (string and table)
(table) tbl_objects = {ObjectName, {Lag X, Lag Y}....}
    Where Lag X and Lag Y are based on X:0 and Y:0 of body ShapeContainer
    (PosX, PosY: Arguments from .Create function that you used before add objects).
(table) tbl_objects = {"Label1",{20,20},"Label2",{20,40}....}

link

(string) The link that will be associated with ShapeContainer Title (On Click Event)

Note: Argument must be a valid string (http://...), can be nil but not "" (blank string)
(string) link = "http://www.microsoft.com"

msg

(boolean) Enable or Disable Warning and Infos messages
(PS: When adding objects it update the file ExtendedScript.lua then ShapeContainer need to be restarted when all objects are added to all shape containers)

Note: Argument must be a type boolean
(boolean) msg = false

Returns

(boolean) This action return true if the file ExtendedScipt.lua was updated and false if not.

Example

-- set arguments
SC_Index = 1;
tbl_objects = { "Input1",{20,20},
                "CheckBox1",{20,50},
                "RadioButton1",{20,120},
                "ComboBox1",{20,150}
             }
link = "http://www.microsoft.com";
msg = false;
-- Run function
result = ShapeContainer.AddObjects(SC_Index, tbl_objects, link, msg)

Description

This action will create a shape container

Note: Arguments multiples.

Parameters

tbl_object

(table) The two (2) object shape id (name, label)

Note: Argument must be a type table:
(table: strings)
tbl_object = {Shape1, Shape2}

tbl_arguments

(table) Properties of ShapeContainer Top and Body (both shapes object)

Note: Argument must be a type table:
(table: numbers) 
tbl_arguments (BackColor and StrokeColor are tables, you can set 2 different values on each table but its optional) = {Body Pos X, Body Pos Y, Body Width, Body Height, {BackColor}, {StrokeColor}, BackMode, StrokeMode, ShapeType}
(Top Pos X, Top Pos Y, Top Width and Top Height are based on values of Body Shape and Title font size)

tbl_label

(table) Properties ShapeContainer Label (Title)

Note: Argument must be a type table (All Label properties are available, at least 4 are required):
(table: strings, numbers, booleans)
tbl_label = {Text="ShapeContainer1", FontName="Time New Roman", FontSize=12, ColorNormal=0}

show_button

(boolean) Whether to Show or Hide the Action Button at top right of ShapeContainer (that will collapse or expand the ShapeContainer Body)

Note: Argument must be a type Boolean
(boolean: true or false)
show_button = true

iicon

(string) The ShapeContainer Image "Icon" Full Path (Located at the ShapeContainer Top Left).
When you click this icon if the ShapeContainer body is collapsed then it will be expanded. (without animation and extended script must be enabled)

Note: Argument must be a type string (PS: ImageFile size must be 16x16 but you can try others)
Recommended: Use always as possible the full path.
(string)
iicon = _SourceFolder.."\\AutoPlay\\Images\\icon.png" or "AutoPlay\\Images\\icon.png"

tbl_body_image

(table) The ShapeContainer Body Picture (All ImageProperties are available; see built in image object table in ams).
    PS: Default = {} -> Dont use body image.

Note: Argument must be a type table
(table: strings, numbers, booleans)
tbl_body_image = {All ImageProperties are available};

extended_script

(boolean) Enable or Disable Extended Lua Scripting with ShapeContainer

Note: Argument must be a type boolean
PS: See at the bottom: Content of Extended Scripting
(boolean: true or false)
extended_script = false

Returns

(boolean) This action return true if the ShapeContainer was created sucessfuly and false if not.

Example

-- ARGUMENTS:
-- tbl_object: {Shape1, Shape2}
-- tbl_arguments: {posX, posY, Width, Height, back_color, stroke_color, back_mode, stroke_mode, type}
-- tb_label: {text, fontname, fontsize, fontcolor} -- at least but all label props are available
-- show_button: Whether show or hide the Action panel button, default = false
-- iicon: Full path to icon picture (recommended picture size: 16x16)
-- tbl_body_image: { All table images properties can be used }
-- extended_script: Whether Use or not Extended Scripting Function.

-- Exemple:
tbl_object = {"TOPA", "BODYA"};
posX, posY = 30, 40;
Width, Height = 200, 100;
back_color, stroke_color = 11206655, 0;
back_mode, stroke_mode = 1, 0;
shtype = 1;
tbl_arguments = { posX, posY, Width, Height, back_color, stroke_color, back_mode, stroke_mode, shtype };
tbl_label = {Text="ShapeContainer", FontName="Constantia", FontSize=10, ColorNormal=255};
iicon = "AutoPlay\\Images\\icon.png";
tbl_body_image = {};  -- Dont use body image
extended_script = true;  -- Default is false;
    
result = ShapeContainer.Create (tbl_object, tbl_arguments, tbl_label, true, iicon, tbl_body_image, true)

Description:

Copyright @ 2000 - 2011 : All rights reserved too
This File Was Generated With AMS ActionFile Editor