33 scrollbar

A scrollbar can be used as an analog announcing object or as an analog regulator. It may be horizontally or vertically aligned.

Definition

{ export | reexport } { model } scrollbar { <Identifier> }
{
  <standard attributes>
  <plain attributes>
  <geometry attributes>
  <hierarchy attributes>
  <layout attributes>
  <object-specific attributes>
}

Events

cut

extevent

focus

help

key

paste

scroll

Children

document

record

transformer

Parent

groupbox

layoutbox

module

notepage

splitbox

toolbar

window

Menu

Pop-up menu

33.1 Attributes

Attribute

RLD

PID

Properties

Short Description

.acc_label

string

object

string

text

S.G/D/C

overwrites the Automation Identifier for Microsoft UI Automation

.acc_text

object

string

text

string

S.G/D/C

overwrites the Automation Name for Microsoft UI Automation

.accelerator

identifier

accel

S,G/D/C

accelerator of object

.arrows

boolean

boolean

S,G/D/C

scrollbar arrows

.bgc

identifier

color

S,G/D/C

background color of object

.class

class

class

-,G/-/-

class/id of object

.control

identifier

instance

-,G/-/-

control currently belonging to object

.cursor

identifier

cursor

S,G/D/C

cursor belonging to object

.curvalue

integer

integer

S,G/D/C

position of scrollbar slider

.cut_pending

boolean

boolean

S,G/-/-

cut operation not yet carried out

.cut_pending_changed

boolean

boolean

-,G/-/-

changing state during cut operation

.dialog

identifier

instance

-,G/-/-

dialog to which the object belongs

.direction

integer

integer

S,G/D/C

justification of scrollbar

.document[integer]

object

document

S,G/-/-

accesses the I-th XML Document

.external

boolean

boolean

-,G/-/-

returns if the object class is an USW class

.external[integer]

class

class

-,G/-/-

returns the I-th registered USW class

.fgc

identifier

color

S,G/D/C

foreground color

.firstrecord

object

record

S,G/-/C

accesses the first record of an object

.focus

boolean

boolean

S,G/-/C

input focus on object

.function

identifier

func

S,G/D/C

function belonging to object

.groupbox

identifier

instance

-,G/-/-

object groupbox

.height

integer

integer

S,G/D/C

height of object

.help

string

identifier

string

text

S,G/D/C

help text of object

.index

integer

index

integer

index

-,G/-/-

returns or sets the first record of an object

.label

string

string

S,G/D/C

name/identifier of object

.lastrecord

object

record

S,G/-/C

accesses the last record of an object

.layoutbox

object

object

-,G/-/-

layoutbox of object

.linemotion

integer

integer

S,G/D/C

value by which scrollbar changes when scrolling line by line

.mapped

boolean

boolean

S,G/D/-

defers the display of a visibly created object

.maxvalue

integer

integer

S,G/D/C

maximal scrollbar value

.member[integer]

attribute

attribute

-,G/-,-

user-defined attribute [I] of object

.membercount

integer

integer

-,G/-,-

number of user-defined attributes

.menu

identifier

instance

S,G/D/C

object menu

.minvalue

integer

integer

S,G/D/C

minimal scrollbar value

.model

identifier

instance

S,G/D/C

model belonging to object

.notepage

object

object

-,G/-/-

standard value of attribute is true

.options[enum]

boolean

boolean

S,G/D/-

special options of object

.pagemotion

integer

integer

S,G/D/C

value by which scrollbar changes when scrolling page by page

.parent

identifier

instance

S,G/-/-

parent of object

.posraster

boolean

boolean

S,G/D/C

positions refer to grid

.real_height

integer

integer

-,G/-/-

real height of object

.real_sensitive

boolean

boolean

-,G/-/-

real selectivity of object

.real_visible

boolean

boolean

-,G/-/-

real visibility of object

.real_width

integer

integer

-,G/-/-

real width of object

.real_x

integer

integer

-,G/-/-

real distance from left (in pixel)

.real_y

integer

integer

-,G/-/-

real distance from top (in pixel)

.record[integer]

object

record

S,G/-/C

accesses the I-th record of an object

.recordcount

integer

integer

-,G/-/-

queries the number of child records

.scope

integer
(1, 2, 3)

scope

-,G/-/-

queries the object type (Default, Model or instance)

.sensitive

boolean

boolean

S,G/D/C

selectivity of object

.sizeraster

boolean

boolean

S,G/D/C

size refers to grid of parent object

.statushelp

string

object

string

text

S,G/-/C

text to be displayed in statusbar

.toolbar

object

object

-,G/-/-

toolbar of object

.toolhelp

text

text

S,G/-/-

specified text to be displayed in pop-up

.userdata

anyvalue

anyvalue

S,G/D/C

object userdata (any DM datatype)

.visible

boolean

boolean

S,G/D/C

visibility of object

.width

integer

may be 0

integer

S,G/D/C

actual width of object

.window

identifier

instance

-,G/-/-

window to which object belongs

.xauto

integer

(-1, 0, 1)

integer

S,G/D/C

definition type of x-coordinates

.xleft

integer

integer

S,G/D/C

x-coordinate, distance from left

.xright

integer

integer

S,G/D/C

x-coordinate, distance from right

.yauto

integer

(-1, 0, 1)

integer

S,G/D/C

definition type of y-coordinates

.ybottom

integer

integer

S,G/D/C

y-coordinate, distance from bottom

.ytop

integer

integer

S,G/D/C

y-coordinate, distance from top

33.2 Specific Attributes

Note for IDM on Microsoft Windows

If the attribute .arrows is set to false, the IDM uses the Windows object "slider" instead of the object "scrollbar".

See Also

Attribute .arrows

Scrollbar attributes:

Figure 13-37: Attributes of the scrollbar

Note

The size of a scrollbar slider is calculated on the basis of .maxvalue, .minvalue and .pagemotion. If the entire area over which the slider can navigate is 1 pixel long, the calculation is as follows:

slider size = 1*.pagemotion/(.maxvalue-.minvalue),

if necessary the result is rounded up or down.

The relation of the slider size to the display area is similar to the relation of .pagemotion to the difference of .maxvalue and .minvalue.

This calculation is valid for scrollbars as objects as well as for scrollbars attached to objects.

However, this calculation is not valid for the so-called "scale widgets" (.arrows = false), which have a fixed size.

33.3 Example

dialog D

color Red "RED", grey(0);

window Wn
{
  .width  355;
  .height 180;
  .title  "Beispielfenster";

  child scrollbar Sb1
  {
    .fgc Red;
    .bgc Red;
    .xleft  66;
    .ytop   89;
    .arrows false;
    .direction 2;
    .curvalue  50;
  }
}

Figure 13-38: scrollbar