Hotspot.SetProperties

Enabled

boolean

True if the hotspot object should be enabled, false if it should not be.

X

number

The horizontal position (in pixels) of the top left corner of the hotspot object in relation to the current page.

Note: The top left corner of the current page has an X value of 0

Y

number

The vertical position (in pixels) of the top left corner of the hotspot object in relation to the current page.

Note: The top left corner of the current page has a Y value of 0

Width

number

The width (in pixels) of the hotspot object.

Height

number

The height (in pixels) of the hotspot object.

TooltipText

string

The mouseover tooltip of the hotspot object. Tip: If you want a "&" character in the text, you must enter "&&&".

Cursor

number

The mouse cursor that will be displayed when the mouse is over the hotspot object:

HighlightSound

number

The type of sound that will be played when the mouse moves over the hotspot object.

HighlightSoundFile

string

The path to the hotspot object's custom highlight sound file.  If the hotspot object does not use a custom sound, this value will be an empty string ("").

Note: For this to take effect, HighlightSound must be set to SND_CUSTOM.

ClickSound

number

The type of sound that will be played when the mouse clicks the hotspot object.

ClickSoundFile

string

The path to the hotspot object's custom click sound file.  If the hotspot object does not use a custom sound, this value will be an empty string ("").

Note: For this to take effect, ClickSound must be set to SND_CUSTOM.