ToolBarEx Help File

ToolBarEx Help File

Plugin Name:

ToolBarEx

Current Version:

2.5.0.0

Description:

ToolBarEx Object Plugin for AutoPlay Media Studio.

Author:

Ceone


Table of Contents

ToolBarEx.Create
ToolBarEx.SetEvent
ToolBarEx.DetectEvent
ToolBarEx.SetStyle
ToolBarEx.GetStyle
ToolBarEx.SetVisible
ToolBarEx.IsVisible
ToolBarEx.SetEnabled
ToolBarEx.IsEnabled
ToolBarEx.SetSize
ToolBarEx.GetSize
ToolBarEx.SetButtonEnabled
ToolBarEx.GetButtonEnabled
ToolBarEx.SetButtonVisible
ToolBarEx.GetButtonVisible
ToolBarEx.SetButtonSound
ToolBarEx.GetButtonSound
ToolBarEx.SetAllButtonsSound
ToolBarEx.SetButtonCursor
ToolBarEx.GetButtonCursor
ToolBarEx.SetAllButtonsCursor
ToolBarEx.SetButtonTooltipText
ToolBarEx.GetButtonTooltipText
ToolBarEx.SetAllButtonsTooltipText
ToolBarEx.SetButtonPos
ToolBarEx.GetButtonPos
ToolBarEx.SetAllButtonsPos
ToolBarEx.GetAllButtonsPos
ToolBarEx.SetButtonImage
ToolBarEx.GetButtonImage

ToolBarEx.Create


ToolBarEx.Create ( 

(string) ToolBarExName,

(table) tblButton = {},

(number) SizeHeight = 20,

(string) Skin = nil,

(number) StartPos = nil,

(string) SeparatorName = nil )

Description

To create ToolBarEx Object.

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

tblButton

(table) The tblButton (max 20 buttons).

SizeHeight

(number) The SizeHeight (Size "Min.20" and "Max.30")

Skin

(string) The Image Skin (if you use...).

StartPos

(number) The StartPos (if you use...).

SeparatorName

(string) The SeparatorName (if you use...).

Returns

This action dose not return any value.


ToolBarEx.SetEvent


ToolBarEx.SetEvent ( 

(string) ToolBarExName,

(string) Event,

(number) Button = 1,

(string) Script = "" )

Description

To SetEvent button from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Event

(string) The event of button.

CONSTANT

VALUE

DESCRIPTION

"On Click"

NA

NA

"On Right-Click"

NA

NA

Button

(number) The Button (max 20 buttons).

Script

(string) The Script.

Returns

This action dose not return any value.


ToolBarEx.DetectEvent


ToolBarEx.DetectEvent ( 

(string) ToolBarExName,

(number) Button = 1 )

Description

To DetectEvent from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Returns

This action dose not return any value.


ToolBarEx.SetStyle


ToolBarEx.SetStyle ( 

(string) ToolBarExName,

(string) NewImagePath = "" )

Description

To SetStyle from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

NewImagePath

(string) The NewImagePath.

Returns

This action dose not return any value.


ToolBarEx.GetStyle


(number) ToolBarEx.GetStyle ( 

(string) ToolBarExName )

Description

To GetStyle from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(number)


ToolBarEx.SetVisible


ToolBarEx.SetVisible ( 

(string) ToolBarExName,

(number) Button = 1,

(boolean) Visible = true )

Description

To SetVisible from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Visible

(boolean) The Visible.

Returns

This action dose not return any value.


ToolBarEx.IsVisible


(boolean) ToolBarEx.IsVisible ( 

(string) ToolBarExName )

Description

Is Visible ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(boolean)


ToolBarEx.SetEnabled


ToolBarEx.SetEnabled ( 

(string) ToolBarExName,

(number) Button = 1,

(boolean) Enable = true )

Description

To SetEnabled from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Enable

(boolean) The Enable.

Returns

This action dose not return any value.


ToolBarEx.IsEnabled


(boolean) ToolBarEx.IsEnabled ( 

(string) ToolBarExName )

Description

Is Enabled ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(boolean)


ToolBarEx.SetSize


ToolBarEx.SetSize ( 

(string) ToolBarExName,

(number) Width = 0,

(number) Height = 0 )

Description

To SetSize from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Width

(number) The Width size.

Height

(number) The Height size.

Returns

This action dose not return any value.


ToolBarEx.GetSize


(table) ToolBarEx.GetSize ( 

(string) ToolBarExName )

Description

To GetSize from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(table)


ToolBarEx.SetButtonEnabled


ToolBarEx.SetButtonEnabled ( 

(string) ToolBarExName,

(number) Button = 1,

(boolean) Enable = true )

Description

To SetButtonEnabled from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Enable

(boolean) The Enable.

Returns

This action dose not return any value.


ToolBarEx.GetButtonEnabled


(boolean) ToolBarEx.GetButtonEnabled ( 

(string) ToolBarExName )

Description

To GetButtonEnabled from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(boolean)


ToolBarEx.SetButtonVisible


ToolBarEx.SetButtonVisible ( 

(string) ToolBarExName,

(number) Button = 1,

(boolean) Visible = true )

Description

To SetButtonVisible from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Visible

(boolean) The Visible.

Returns

This action dose not return any value.


ToolBarEx.GetButtonVisible


(boolean) ToolBarEx.GetButtonVisible ( 

(string) ToolBarExName )

Description

To GetButtonVisible from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(boolean)


ToolBarEx.SetButtonSound


ToolBarEx.SetButtonSound ( 

(string) ToolBarExName,

(number) Button = 1,

(string) SetSounds = "ClickSound",

(variant) SetMode = SND_STANDARD,

(string) CustomSoundFile = "" )

Description

To SetButtonSound from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

SetSounds

(string) The SetSounds.

CONSTANT

VALUE

DESCRIPTION

"ClickSound"

NA

NA

"HighlightSound"

NA

NA

SetMode

(variant) The SetMode.

CONSTANT

VALUE

DESCRIPTION

SND_STANDARD

NA

NA

SND_CUSTOM

NA

NA

CustomSoundFile

(string) The CustomSoundFile.

Returns

This action dose not return any value.


ToolBarEx.GetButtonSound


(table) ToolBarEx.GetButtonSound ( 

(string) ToolBarExName )

Description

To GetButtonSound from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(table)


ToolBarEx.SetAllButtonsSound


ToolBarEx.SetAllButtonsSound ( 

(string) ToolBarExName,

(number) MaxNumButton = 1,

(string) SetSounds = "ClickSound",

(variant) SetMode = SND_STANDARD,

(string) CustomSoundFile = "" )

Description

To SetAllButtonsSound from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

MaxNumButton

(number) The MaxNumButton (max 20 buttons).

SetSounds

(string) The SetSounds.

CONSTANT

VALUE

DESCRIPTION

"ClickSound"

NA

NA

"HighlightSound"

NA

NA

SetMode

(variant) The SetMode.

CONSTANT

VALUE

DESCRIPTION

SND_STANDARD

NA

NA

SND_CUSTOM

NA

NA

CustomSoundFile

(string) The CustomSoundFile.

Returns

This action dose not return any value.


ToolBarEx.SetButtonCursor


ToolBarEx.SetButtonCursor ( 

(string) ToolBarExName,

(number) Button = 1,

(number) Cursor = CURSOR_HAND )

Description

To SetButtonCursor from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Cursor

(number) The Cursor.

CONSTANT

VALUE

DESCRIPTION

CURSOR_ARROW

NA

NA

CURSOR_HAND

NA

NA

CURSOR_BLACK_ARROW

NA

NA

CURSOR_CROSSHAIR

NA

NA

CURSOR_EXPLORE

NA

NA

CURSOR_HELP

NA

NA

CURSOR_MAGNIFY

NA

NA

CURSOR_MEDIA

NA

NA

CURSOR_MONEY

NA

NA

CURSOR_NOTEPAD

NA

NA

CURSOR_PENCIL

NA

NA

CURSOR_PRINTER

NA

NA

CURSOR_SPEAKER

NA

NA

CURSOR_UP_ARROW

NA

NA

Returns

This action dose not return any value.


ToolBarEx.GetButtonCursor


(number) ToolBarEx.GetButtonCursor ( 

(string) ToolBarExName )

Description

To GetButtonCursor from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(number)


ToolBarEx.SetAllButtonsCursor


ToolBarEx.SetAllButtonsCursor ( 

(string) ToolBarExName,

(number) MaxNumButton = 1,

(number) Cursor = CURSOR_HAND )

Description

To SetAllButtonsCursor from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

MaxNumButton

(number) The MaxNumButton (max 20 buttons).

Cursor

(number) The Cursor.

CONSTANT

VALUE

DESCRIPTION

CURSOR_ARROW

NA

NA

CURSOR_HAND

NA

NA

CURSOR_BLACK_ARROW

NA

NA

CURSOR_CROSSHAIR

NA

NA

CURSOR_EXPLORE

NA

NA

CURSOR_HELP

NA

NA

CURSOR_MAGNIFY

NA

NA

CURSOR_MEDIA

NA

NA

CURSOR_MONEY

NA

NA

CURSOR_NOTEPAD

NA

NA

CURSOR_PENCIL

NA

NA

CURSOR_PRINTER

NA

NA

CURSOR_SPEAKER

NA

NA

CURSOR_UP_ARROW

NA

NA

Returns

This action dose not return any value.


ToolBarEx.SetButtonTooltipText


ToolBarEx.SetButtonTooltipText ( 

(string) ToolBarExName,

(number) Button = 1,

(string) TooltipText = "" )

Description

To SetButtonTooltipText from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

TooltipText

(string) The TooltipText.

Returns

This action dose not return any value.


ToolBarEx.GetButtonTooltipText


(string) ToolBarEx.GetButtonTooltipText ( 

(string) ToolBarExName )

Description

To GetButtonTooltipText from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(string)


ToolBarEx.SetAllButtonsTooltipText


ToolBarEx.SetAllButtonsTooltipText ( 

(string) ToolBarExName,

(number) MaxNumButton = 1,

(string) TooltipText = "" )

Description

To SetAllButtonsTooltipText from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

MaxNumButton

(number) The MaxNumButton (max 20 buttons).

TooltipText

(string) The TooltipText.

Returns

This action dose not return any value.


ToolBarEx.SetButtonPos


ToolBarEx.SetButtonPos ( 

(string) ToolBarExName,

(number) Button = 1,

(number) PosX = 0,

(number) PosY = 0 )

Description

To SetButtonPos from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

PosX

(number) The PosX.

PosY

(number) The PosY.

Returns

This action dose not return any value.


ToolBarEx.GetButtonPos


(table) ToolBarEx.GetButtonPos ( 

(string) ToolBarExName )

Description

To GetButtonPos from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Returns

(table)


ToolBarEx.SetAllButtonsPos


ToolBarEx.SetAllButtonsPos ( 

(string) ToolBarExName,

(number) MaxNumButton = 1,

(number) PosX = 0,

(number) PosY = 0 )

Description

To SetAllButtonsPos from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

MaxNumButton

(number) The MaxNumButton (max 20 buttons).

PosX

(number) The PosX.

PosY

(number) The PosY.

Returns

This action dose not return any value.


ToolBarEx.GetAllButtonsPos


(table) ToolBarEx.GetAllButtonsPos ( 

(string) ToolBarExName,

(number) MaxNumButton = 1 )

Description

To GetAllButtonsPos from ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

MaxNumButton

(number) The MaxNumButton (max 20 buttons).

Returns

(table)


ToolBarEx.SetButtonImage


ToolBarEx.SetButtonImage ( 

(string) ToolBarExName,

(number) Button = 1,

(string) NewImagePath = "" )

Description

To SetButtonImage ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

NewImagePath

(string) The NewImagePath.

Returns

This action dose not return any value.


ToolBarEx.GetButtonImage


(string) ToolBarEx.GetButtonImage ( 

(string) ToolBarExName,

(number) Button = 1 )

Description

To GetButtonImage ToolBarEx Object

Parameters

ToolBarExName

(string) The name of the ToolBarEx object.

Button

(number) The Button (max 20 buttons).

Returns

(string)




This File Was Generated With AMS ActionFile Editor