Frames Help File

Frames Help File

Plugin Name:

Frames

Current Version:

1.2.0.0

Description:

This plugin adds the ability to create Frames on in your AMS project.

Original Code created by Worm
All Additional code created by Centauri Soldier
Converted to plugin format by Centauri Soldier

Licence:

Free to Use and Distribute

Author:

Centauri Soldier

Web:

www.amspublic.com

E-mail:

centaurisoldier@amspublic.com

Requirements:

.Net Framework 2.0 or higher.

Copyright:

©2009 www.amspublic.com

Install Notes:

Place the "Frames" folder inside your "AutoPlay Media Studio\Plugins\Actions" folder.


Table of Contents

Frames.ConstrainHorBar
Frames.ConstrainVerBar
Frames.Initialize
Frames.SetHorPrefix
Frames.SetNoMovePrefix
Frames.SetVerPrefix
Frames.OnMouseButton
Frames.OnMouseMove
Frames.OnSize

Frames.ConstrainHorBar


Frames.ConstrainHorBar ( 

(string) Object = "Hbar",

(number) Closest to Top = 35,

(number) Closest to Bottom = 200 )

Description

This sets the maximun movement of the specified horizontal bar.

Parameters

Object

(string) The name of the object serving as the horizontal bar.

Closest to Top

(number) The closest the horizontal bar is allowed to get to the top of the application window.

Closest to Bottom

(number) The closest the horizontal bar is allowed to get to the bottom of the application window.

Returns

This action dose not return any value.


Frames.ConstrainVerBar


Frames.ConstrainVerBar ( 

(string) Object = "Vbar left",

(number) Closest to Left = 75,

(number) Closest to Right = 350 )

Description

This sets the maximun movement of the specified vertical bar.

Parameters

Object

(string) The name of the object serving as the vertical bar.

Closest to Left

(number) The closest the vertical bar is allowed to get to the left of the application window.

Closest to Right

(number) The closest the vertical bar is allowed to get to the right of the application window.

Returns

This action dose not return any value.


Frames.Initialize


Frames.Initialize ()

Description

This enables the designated objects as frame bars. This action should be placed in your On Preload or On Show events. Be sure to use this after any change in name prefixes.

Returns

This action dose not return any value.


Frames.SetHorPrefix


(string) Frames.SetHorPrefix ( 

(string) Prefix = "Hbar" )

Description

Set the name prefix that horizontal bars will use. To designate a bar or non-moving object, simply name the specified object the proper prefix plus a given suffix (as its name).

Parameters

Prefix

(string) The prefix that will be on all horizontal bar objects. If you do not set this or if an error occurs, the default "hsplit_" will be used as the prefix. This is not case sensitive.

Returns

(string)


Frames.SetNoMovePrefix


(string) Frames.SetNoMovePrefix ( 

(string) Prefix = "Stay_" )

Description

Set the name prefix that non-moving objects will use. To designate a bar or non-moving object, simply name the specified object the proper prefix plus a given suffix (as its name).

Parameters

Prefix

(string) The prefix that will be on all non-moving objects. If you do not set this or if an error occurs, the default "nomove_" will be used as the prefix. This is not case sensitive.

Returns

(string)


Frames.SetVerPrefix


(string) Frames.SetVerPrefix ( 

(string) Prefix = "Vbar" )

Description

Set the name prefix that vertical bars will use. To designate a bar or non-moving object, simply name the specified object the proper prefix plus a given suffix (as its name).

Parameters

Prefix

(string) The prefix that will be on all vertical bar objects. If you do not set this or if an error occurs, the default "vsplit_" will be used as the prefix. This is not case sensitive.

Returns

(string)


Frames.OnMouseButton


Frames.OnMouseButton ( 

(number) e_Type = e_Type,

(number) e_X = e_X,

(number) e_Y = e_Y )

Description

This must be placed in your page's On Mouse Button event.

Parameters

e_Type

(number) Do Not Change.

e_X

(number) Do Not Change.

e_Y

(number) Do Not Change.

Returns

This action dose not return any value.


Frames.OnMouseMove


Frames.OnMouseMove ( 

(number) e_X = e_X,

(number) e_Y = e_Y,

(variant) Callback Function = nil )

Description

This must be placed in your page's On Mouse Move event.

Parameters

e_X

(number) Do Not Change.

e_Y

(number) Do Not Change.

Callback Function

(variant) You may specify a function that will be executed when the splitter bars are being moved. If you do not wish to declare a function then leave nil.

Returns

This action dose not return any value.


Frames.OnSize


Frames.OnSize ( 

(number) Window Width = e_WindowWidth,

(number) Window Height = e_WindowHeight,

(number) Page Width = e_PageWidth,

(number) Page Height = e_PageHeight,

(number) Object Type = e_Type )

Description

This must be placed in your page's On Size event.

Parameters

Window Width

(number) Do Not Change.

Window Height

(number) Do Not Change.

Page Width

(number) Do Not Change.

Page Height

(number) Do Not Change.

Object Type

(number) Do Not Change.

Returns

This action dose not return any value.



©2009 www.amspublic.com
This File Was Generated With AMS ActionFile Editor