The Scroll Bar

The Scroll Bar

Welcome to our Knowledge Base

Documentation | Blog | Demos | Support

< All Topics
Print

The Scroll Bar

Main Characteristics of Scroll Bars

Scroll bars form fields have a variety of uses. They are commonly used for providing the application end-user with a convenient mechanism for scrolling over more data than fits on the screen, but they can be used for other purposes as well. The data type for a scroll bar is always numeric. The values that an activated scroll bar delivers (or can be assigned) is a function of a numeric scale, and a small and large increment within that scale.

ScaleThe scale associated with a scroll bar is defined by a minimum and a maximum value. For a vertical scroll bar, these values correspond to the scroll bar’s “bar” being positioned at the top and bottom respectively, within the scroll bar’s “trough”. For a horizontal scroll bar, read far left for top and far right for bottom.
Small IncrementThe small increment associated with a vertical scroll bar is that amount that is added to (or subtracted from), the current value of the scroll bar when the application end-user clicks on the top (or bottom) arrow. For a horizontal scroll bar, read left arrow for top arrow, and right arrow for bottom arrow.
Large IncrementThe large increment associated with a vertical scroll bar is that amount that is added to (or subtracted from), the current value of the scroll bar when the application end-user clicks within the top (or bottom) portion of the “trough”. For a horizontal scroll bar, read left for top and right for bottom.

 

Scroll Bars Attributes

– Identification

Attribute NameDefault ValueDescription
Field TypeThe type of this form field or of this user interface object. (Read-only).
Field NamevariableA string that identifies this form field within the Zim application;
Automatically assigned by the Zim IDE when a new form field is created;
May be changed by the developer, but must always conform to the Zim Object Naming Rules and satisfy the Zim Object Uniqueness Conditions.
Field Number0A number that may be used to identify this form field within the Zim application and in Callback Events;
May be changed by the developer and need not be unique;
Value must be an integer between 0 and 999;
Field Tag“”A string that may be used to identify this form field within the Zim application and in Callback Events;
May be changed by the developer and need not be unique;
If left blank, the Zim IDE will assign the value of Field Name to Field Tag.
DirectoryZIMThe directory that owns the parent form of this form field (Read-only).
Form NameA string that identifies the parent form of this form field (Read-only).
Help Message“”A help message that will be displayed when this form field or this menu item receives input focus;
Displayed in the status bar of the window associated with the parent form of this form field (if the window object’s Status Bar attribute is set to True);
Displayed in a message field if one such field exists in the parent form of this form field.

 

– Appearance

Attribute NameDefault ValueDescription
Customized PointerdefaultThe pointer (or cursor) style when the pointer is hovering over (or the cursor is inside) an available form field;
May be selected from the following choices in the list box:
Arrow →  the standard arrow cursor;
Cross-hair →  ;
I-Beam →  ;
Icon →  ;
Resize →  ;
Size NE SW →  ;
Size NS →  ;
Size NW SE →  ;
Size WE →  ;
Up Arrow →  ;
Hourglass →  ;
default →  The pointer style will be I-Beam for Entry Field and Arrow for all other form fields.
LocationThe location (in pixels) of this form field in relation to the top-left corner of its parent form or parent container.
XThe horizontal location of this form field.
YThe vertical location of this form field.
Orientation1 →  This is a horizontal scroll bar;
2 →  This is a vertical scroll bar.
SizeThe size of this form field in pixels.
WidthThe width of this form field.
HeightThe height of this form field.
VisibleTrueTrue →  This form field will be visible by default.

 

– Behavior

Attribute NameDefault ValueDescription
AnchoringTop, LeftWhen the window associated with this form field’s parent form is resized:
Top →  The top edge of this form field will maintain its distance from the top edge of the window;
Bottom →  The bottom edge of this form field will maintain its distance from the bottom edge of the window;
Left →  The left edge of this form field will maintain its distance from the left edge of the window;
Right →  The right edge of this form field will maintain its distance from the right edge of the window;
None →  The same as TopLeft.
Auto SkipFalseTrue →  The input focus will automatically skip to the next available form field after the value or state of this form field has been modified.
DockingNoneTop →  The top edge of the form field will be expanded and placed;
Bottom →  ;
Left →  ;
Right →  ;
Fill →  ;
None →  This form field.

 

– Callback Events

Attribute NameDefault ValueDescription
All Callback EventsWhen any of the following callback event attributes is set to True, this form field will be able to trigger the corresponding callback event;
After the event is triggered, the form input command will be terminated and the following values will populate the Event Vector:
Event.EventType = “FormField”;
Event.EventTag = the form field’s Field Tag attribute;
Additional values relative to specific callback events (see below);
Note:
Callback events can only be triggered by a form field if it is available and contained in a form that has input focus.
ClickFalseTriggered when the left mouse button is clicked within this form field;
Event.EventName = “Click” added to the Event Vector.
Got FocusFalseTriggered when a mouse click, a tab key press or an accelerator key press causes this form field to acquire the input focus;
Event.EventName = “GotFocus” added to the Event Vector.
Lost Focus (Always)FalseTriggered when a mouse click, a tab key press or an accelerator key press causes this form field to lose the input focus;
Event.EventName = “LostFocus” added to the Event Vector.
Lost Focus (When Modified)FalseTriggered when a mouse click, a tab key press or an accelerator key press causes this form field to lose the input focus after its value has been modified (cf. Modified below);
Event.EventName = “LostFocusModified” added to the Event Vector.
ModifiedFalseTriggered when the value or state of this form field is modified by a left mouse button click;
Event.EventName = “Modified” added to Event Vector.
Right ClickFalseTriggered when the right mouse button is clicked on or inside this form field;
Event.EventName = “RightClick” added to the Event Vector.

 

– Colors

Attribute NameDefault ValueDescription
Inherit Background ColorvariableTrue →  The form field or container will inherit the background color of its parent container or parent form object.
Inherit Foreground ColorvariableTrue →  The form field or container will inherit the foreground color of its parent container or parent form object.

 

– Properties

Attribute NameDefault ValueDescription
AvailabilityAvailableThe way in which the end-user will interact with this form field:
Available →  This form field can receive input focus and its contents can be modified;
Unavailable →  This form field cannot receive input focus and its contents cannot be modified;
Guarded →  This form field can receive input focus but its contents cannot be modified;
Protected →  This form field cannot receive input focus, its contents cannot be modified and it will appear grayed-out;
Default Data Value“”The default data value of this form field.
Minimum Value0The scroll bar data value when the bar is at the leftmost or rightmost position;
Maximum Value100The scroll bar data value when the bar is at the topmost or bottommost position;
Small Increment1The value that will be added to, or subtracted from, this scroll bar’s value when one of the arrows is clicked.
Large Increment10The value that will be added to, or subtracted from, this scroll bar’s value when one of the trough areas is clicked.
Tab Index0The relative position of this form field in the tab sequence order for its parent container or form field;
0 →  The relative position of the form field in the structure chart will be used instead.
Tab StopTrueTrue →  This form field will be included in the tab order for its parent container or form;
False →  
Z-Order>= 10001The relative depth of this form field in relation to other form fields within the same parent container or form.

 

Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.

Leave a Reply

Your email address will not be published. Required fields are marked *

en_CAEnglish