ProgressBarX Help File

ProgressBarX Help File

Plugin Name:

ProgressBarX

Current Version:

1.5.0.0

Description:

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

Author:

Ceone

E-mail:

produceone@gmail.com

Requirements:

This object plugin require "Memory Actions Plugin" Created by AMSWaves Corporation, And progressbar-xp.ocx.


Table of Contents

ProgressBarX.CreateObject
ProgressBarX.SetCurrentPos
ProgressBarX.GetCurrentPos
ProgressBarX.Refresh
ProgressBarX.CustomBrushStyle
ProgressBarX.SetColor
ProgressBarX.GetColor
ProgressBarX.SetRange
ProgressBarX.GetRange
ProgressBarX.SetOrientation
ProgressBarX.GetOrientation
ProgressBarX.SetScrollingStyle
ProgressBarX.GetScrollingStyle
ProgressBarX.SetShowText
ProgressBarX.GetShowText

ProgressBarX.CreateObject


ProgressBarX.CreateObject ( 

(string) ObjectName,

(number) Position = 0,

(number) ScrollingStyle = SS_Standard,

(number) OrientationStyle = OS_Horizontal,

(boolean) ShowText = false )

Description

To create ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Position

(number) Position.

ScrollingStyle

(number) ScrollingStyle.

CONSTANT

VALUE

DESCRIPTION

SS_Standard

0

Standard Style

SS_Smooth

1

Smooth Style

SS_Search

2

Search Style

SS_OfficeXP

3

OfficeXP Style

SS_Pastel

4

Pastel Style

SS_JavT

5

JavT Style

SS_MediaPlayer

6

MediaPlayer Style

SS_CustomBrush

7

CustomBrush Style

SS_Metallic

9

Metallic Style

OrientationStyle

(number) OrientationStyle.

CONSTANT

VALUE

DESCRIPTION

OS_Horizontal

0

Horizontal Orientation

OS_Vertical

1

Vertical Orientation

ShowText

(boolean) ShowText.

Returns

This action dose not return any value.


ProgressBarX.SetCurrentPos


ProgressBarX.SetCurrentPos ( 

(string) ObjectName,

(number) Position = 0 )

Description

To SetCurrentPos ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Position

(number) Position.

Returns

This action dose not return any value.


ProgressBarX.GetCurrentPos


(number) ProgressBarX.GetCurrentPos ( 

(string) ObjectName )

Description

To GetCurrentPos ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(number) The current position of the progress meter within the ProgressBarX.


ProgressBarX.Refresh


ProgressBarX.Refresh ( 

(string) ObjectName )

Description

To Refresh ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

This action dose not return any value.


ProgressBarX.CustomBrushStyle


ProgressBarX.CustomBrushStyle ( 

(string) ObjectName,

(number) BrushStyle = BS_VERTICAL )

Description

To CustomBrushStyle ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

BrushStyle

(number) BrushStyle.

CONSTANT

VALUE

DESCRIPTION

BS_HORIZONTAL

0

Horizontal Brush Style

BS_VERTICAL

1

Vertical Brush Style

BS_FDIAGONAL

2

FDiagonal Brush Style

BS_BDIAGONAL

3

BDiagonal Brush Style

BS_CROSS

4

Cross Brush Style

BS_DIAGCROSS

5

DiagonalCross Brush Style

BS_SOLID

6

Solid Brush Style

Returns

This action dose not return any value.


ProgressBarX.SetColor


ProgressBarX.SetColor ( 

(string) ObjectName,

(number) Color = 0 )

Description

To SetColor ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Color

(number) Color.

Returns

This action dose not return any value.


ProgressBarX.GetColor


(number) ProgressBarX.GetColor ( 

(string) ObjectName )

Description

To GetColor ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(number) The color of the ProgressBarX.


ProgressBarX.SetRange


ProgressBarX.SetRange ( 

(string) ObjectName,

(number) Min = 0,

(number) Max = 0 )

Description

To SetRange ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Min

(number) Min.

Max

(number) Max.

Returns

This action dose not return any value.


ProgressBarX.GetRange


(table) ProgressBarX.GetRange ( 

(string) ObjectName )

Description

To GetRange ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(table) A table containing the range of the ProgressBarX, indexed by values "Min" and "Max". These values can be accessed using the form mytable.


ProgressBarX.SetOrientation


ProgressBarX.SetOrientation ( 

(string) ObjectName,

(number) Orientation = OS_Vertical )

Description

To SetOrientation ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Orientation

(number) Orientation.

CONSTANT

VALUE

DESCRIPTION

OS_Horizontal

0

Horizontal Orientation

OS_Vertical

1

Vertical Orientation

Returns

This action dose not return any value.


ProgressBarX.GetOrientation


(number) ProgressBarX.GetOrientation ( 

(string) ObjectName )

Description

To GetOrientation ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(number) The orientation of the ProgressBarX.


ProgressBarX.SetScrollingStyle


ProgressBarX.SetScrollingStyle ( 

(string) ObjectName,

(number) ScrollingStyle = SS_Standard )

Description

To SetScrollingStyle ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

ScrollingStyle

(number) ScrollingStyle.

CONSTANT

VALUE

DESCRIPTION

SS_Standard

0

Standard Style

SS_Smooth

1

Smooth Style

SS_Search

2

Search Style

SS_OfficeXP

3

OfficeXP Style

SS_Pastel

4

Pastel Style

SS_JavT

5

JavT Style

SS_MediaPlayer

6

MediaPlayer Style

SS_CustomBrush

7

CustomBrush Style

SS_Metallic

9

Metallic Style

Returns

This action dose not return any value.


ProgressBarX.GetScrollingStyle


(number) ProgressBarX.GetScrollingStyle ( 

(string) ObjectName )

Description

To GetScrollingStyle ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(number) The ScrollingStyle of the ProgressBarX.


ProgressBarX.SetShowText


ProgressBarX.SetShowText ( 

(string) ObjectName,

(boolean) SetShowText = false )

Description

To SetShowText ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

SetShowText

(boolean) SetShowText.

Returns

This action dose not return any value.


ProgressBarX.GetShowText


(boolean) ProgressBarX.GetShowText ( 

(string) ObjectName )

Description

To GetShowText ProgressBarX object.

Parameters

ObjectName

(string) The name of the ProgressBarX object.

Returns

(boolean) The boolean value if ShowText is actived of the ProgressBarX.




This File Was Generated With AMS ActionFile Editor