Scroll Bar

The scroll bar component displays a periodic message and scrolls a message across the status bar. The site designer provides this information so the user can learn more about the page.

Properties

name

DisplayName - Name
Description - Internal Name of Component in HTML page.
Type - String
DefaultValue - scrollBarComponent1

Tooltip

DisplayName - Text To Display - Tooltip
Description - Enter the text to be displayed periodically in the status bar
Type - STRING

UpdateDuration

DisplayName - Update Duration
Description - Enter the amount of time between status bar static text updates.
Type - NUMBER

ScrollRate

DisplayName - Scroll Rate
Description - Enter the rate (in seconds) that you wish to have the status bar scroll at.
Type - NUMBER

ScrollMsg

DisplayName - Scrool Bar Message
Description - Enter the text that you wish to see scrolling.
Type - STRING

ScrollWidth

DisplayName - Scroll Bar Width
Description - Enter the width of the scrolling message.
Type - NUMBER

Methods

void StatusScroll( void )
Function:StatusScroll
Input:None
Return:None
Description:This function scrolls a user-defined message, msg, from right to left in the browser's status bar. The message is scrolled and refreshed at every interval specified by the rate parameter. Set the width parameter to determine how far from the left side of the status bar to start the scrolling message. The message will then scroll that many spaces from right to left until being "swallowed up" by the left margin, and repeat.

void Display(void)
Function:Display
Input:None
Return:None
Description:This method will display the text within the tooltip property in the status bar.

void ClearStatusBar(void)
Function:ClearStatusBar
Input:None
Return:None
Description:This method will clears the status bar.

Events

None

Other Information

Environment: Client