ProgressGradient Help File

ProgressGradient Help File

Plugin Name:

ProgressGradient

Current Version:

2.0.0.0

Description:

ProgressGradient Object for AutoPlay Media Studio.
Created by Ceone with Skelton by Lucas the Duck.

Author:

Ceone

Requirements:

This object plugin require "Memory Actions Plugin" Created by AMSWaves Corporation, And ProgressGradient.ocx.
System.RegisterActiveX(_SourceFolder.."\\AutoPlay\\Plugins\\ProgressGradient\\ProgressGradient.ocx");
To Events need set ProgressGradient.StartEvents.

Events


Click

Fires when click mouse.

MouseUp

Fires when mouse key up.

e_Button:

     (number) The index button that was pressed.

e_Modifiers:

     (number) The index button that was pressed (Shift, Alt, Ctrl, AltGr...).

e_X:

     (number) The horizontal position of the mouse cursor, in pixels, from the left side of the object.

e_Y:

     (number) The vertical position of the mouse cursor, in pixels, from the left side of the object.

MouseDown

Fires when mouse key down.

e_Button:

     (number) The index button that was pressed.

e_Modifiers:

     (number) The index button that was pressed (Shift, Alt, Ctrl, AltGr...).

e_X:

     (number) The horizontal position of the mouse cursor, in pixels, from the left side of the object.

e_Y:

     (number) The vertical position of the mouse cursor, in pixels, from the left side of the object.

MosuseMove

Fires when mouse move over object.

e_Button:

     (number) The index button that was pressed.

e_Modifiers:

     (number) The index button that was pressed (Shift, Alt, Ctrl, AltGr...).

e_X:

     (number) The horizontal position of the mouse cursor, in pixels, from the left side of the object.

e_Y:

     (number) The vertical position of the mouse cursor, in pixels, from the left side of the object.


Table of Contents

ProgressGradient.CreateObject
ProgressGradient.GetCurrentPos
ProgressGradient.SetCurrentPos
ProgressGradient.GetGradientColorBegin
ProgressGradient.SetGradientColorBegin
ProgressGradient.GetGradientColorEnd
ProgressGradient.SetGradientColorEnd
ProgressGradient.GetOrientation
ProgressGradient.SetOrientation
ProgressGradient.GetMin
ProgressGradient.SetMin
ProgressGradient.GetMax
ProgressGradient.SetMax
ProgressGradient.GetWindowsHandle
ProgressGradient.GetBorderStyle
ProgressGradient.SetBorderStyle
ProgressGradient.GetOneColor
ProgressGradient.SetOneColor
ProgressGradient.GetBackColor
ProgressGradient.SetBackColor
ProgressGradient.GetTextColor
ProgressGradient.SetTextColor
ProgressGradient.GetValueSuffix
ProgressGradient.SetValueSuffix
ProgressGradient.StartEvents

 

ProgressGradient.CreateObject


ProgressGradient.CreateObject ( 

(string) ObjectName,

(number) Orientation = Vertical,

(number) StartPos = 0,

(number) BackgroundColor = 0,

(number) GradientColorBegin = 0,

(number) GradientColorEnd = 0 )

Description

To create ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Orientation

(number) The Orientation of the ProgressGradient object.

CONSTANT

VALUE

DESCRIPTION

Vertical

1

Vertical orientation

Horizontal

0

Horizontal orientation

StartPos

(number) The start level number.

BackgroundColor

(number) The Background Color of the ProgressGradient object.

GradientColorBegin

(number) The Gradient Color Begin name of the ProgressGradient object.

GradientColorEnd

(number) The Gradient Color End of the ProgressGradient object.

Returns

This action dose not return any value.


ProgressGradient.GetCurrentPos


(number) ProgressGradient.GetCurrentPos ( 

(string) ObjectName )

Description

To get current position of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetCurrentPos


ProgressGradient.SetCurrentPos ( 

(string) ObjectName,

(number) Position = 0 )

Description

To set current position of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Position

(number) The position number.

Returns

This action dose not return any value.


ProgressGradient.GetGradientColorBegin


(number) ProgressGradient.GetGradientColorBegin ( 

(string) ObjectName )

Description

To get gradient color begin of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetGradientColorBegin


ProgressGradient.SetGradientColorBegin ( 

(string) ObjectName,

(number) Color = 0 )

Description

To set gradient color begin of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Color

(number) The Color number.

Returns

This action dose not return any value.


ProgressGradient.GetGradientColorEnd


(number) ProgressGradient.GetGradientColorEnd ( 

(string) ObjectName )

Description

To get gradient color end of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetGradientColorEnd


ProgressGradient.SetGradientColorEnd ( 

(string) ObjectName,

(number) Color = 0 )

Description

To set gradient color begin of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Color

(number) The Color number.

Returns

This action dose not return any value.


ProgressGradient.GetOrientation


(number) ProgressGradient.GetOrientation ( 

(string) ObjectName )

Description

To get orientation of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetOrientation


ProgressGradient.SetOrientation ( 

(string) ObjectName,

(number) Orientation = Vertical )

Description

To set orientation of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Orientation

(number) The Orientation of the ProgressGradient object.

CONSTANT

VALUE

DESCRIPTION

Vertical

1

Vertical orientation

Horizontal

0

Horizontal orientation

Returns

This action dose not return any value.


ProgressGradient.GetMin


(number) ProgressGradient.GetMin ( 

(string) ObjectName )

Description

To get minimun of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetMin


ProgressGradient.SetMin ( 

(string) ObjectName,

(number) Minimun = 0 )

Description

To set minimun of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Minimun

(number) The minimun number.

Returns

This action dose not return any value.


ProgressGradient.GetMax


(number) ProgressGradient.GetMax ( 

(string) ObjectName )

Description

To get maximun of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetMax


ProgressGradient.SetMax ( 

(string) ObjectName,

(number) Maximun = 100 )

Description

To set maximun of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Maximun

(number) The maximun number.

Returns

This action dose not return any value.


ProgressGradient.GetWindowsHandle


(number) ProgressGradient.GetWindowsHandle ( 

(string) ObjectName )

Description

To get windows handle object of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.GetBorderStyle


(number) ProgressGradient.GetBorderStyle ( 

(string) ObjectName )

Description

To get border style of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetBorderStyle


ProgressGradient.SetBorderStyle ( 

(string) ObjectName,

(number) BorderStyle = None )

Description

To set border style of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

BorderStyle

(number) The BorderStyle of the ProgressGradient object.

CONSTANT

VALUE

DESCRIPTION

None

0

No Border

FixedSingle

1

Border FixedSingle

Returns

This action dose not return any value.


ProgressGradient.GetOneColor


(number) ProgressGradient.GetOneColor ( 

(string) ObjectName )

Description

To get one color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetOneColor


ProgressGradient.SetOneColor ( 

(string) ObjectName,

(number) Color = 0 )

Description

To set one color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Color

(number) The Color number.

Returns

This action dose not return any value.


ProgressGradient.GetBackColor


(number) ProgressGradient.GetBackColor ( 

(string) ObjectName )

Description

To get back color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetBackColor


ProgressGradient.SetBackColor ( 

(string) ObjectName,

(number) Color = 0 )

Description

To set back color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Color

(number) The Color number.

Returns

This action dose not return any value.


ProgressGradient.GetTextColor


(number) ProgressGradient.GetTextColor ( 

(string) ObjectName )

Description

To get text color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(number)


ProgressGradient.SetTextColor


ProgressGradient.SetTextColor ( 

(string) ObjectName,

(number) Color = 0 )

Description

To set text color of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Color

(number) The Color number.

Returns

This action dose not return any value.


ProgressGradient.GetValueSuffix


(string) ProgressGradient.GetValueSuffix ( 

(string) ObjectName )

Description

To get value suffix of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

Returns

(string)


ProgressGradient.SetValueSuffix


ProgressGradient.SetValueSuffix ( 

(string) ObjectName,

(string) SuffixString = " %" )

Description

To set value suffix of ProgressGradient object.

Parameters

ObjectName

(string) The name of the ProgressGradient object.

SuffixString

(string) The Suffix String.

Returns

This action dose not return any value.


ProgressGradient.StartEvents


ProgressGradient.StartEvents ( 

(string) ObjectName1,

(string) ObjectName2,

(string) ObjectName3,

(string) ObjectName4,

(string) ObjectName5,

(string) ObjectName6,

(string) ObjectName7,

(string) ObjectName8,

(string) ObjectName9,

(string) ObjectName10 )

Description

To start events of ProgressGradient object. (Max. 10)

Parameters

ObjectName1

(string) The name 1 of the ProgressGradient object.

ObjectName2

(string) The name 2 of the ProgressGradient object.

ObjectName3

(string) The name 3 of the ProgressGradient object.

ObjectName4

(string) The name 4 of the ProgressGradient object.

ObjectName5

(string) The name 5 of the ProgressGradient object.

ObjectName6

(string) The name 6 of the ProgressGradient object.

ObjectName7

(string) The name 7 of the ProgressGradient object.

ObjectName8

(string) The name 8 of the ProgressGradient object.

ObjectName9

(string) The name 9 of the ProgressGradient object.

ObjectName10

(string) The name 10 of the ProgressGradient object.

Returns

This action dose not return any value.




This File Was Generated With AMS ActionFile Editor