Copyright © 2005-2023 MultiMedia Soft

TracksBoard.Scroll method

Previous pageReturn to chapter overviewNext page

Remarks

 

Scrolls the TracksBoard horizontally of a given amount.

 

After a call to this method the control will fire the TracksBoardDisplayRangeChange event.

 

For details about the use of the TracksBoard refer to the How to use the TracksBoard to visually compose songs tutorial.

For further details about methods of the TracksBoard refer to the TracksBoard class section.

 

 

Syntax

 

[Visual Basic]

Public Function Scroll (

bHorizontal as Boolean,

nAmount as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes Scroll (

bool bHorizontal,

Int32 nAmount

);


 

[C++]

public: enumErrorCodes Scroll (

bool bHorizontal,

Int32 nAmount

);


 

Parameter

Description

 

 

bHorizontal

Boolean flag that specifies if the scroll should be performed horizontally or vertically

Supported values are the following:

Mnemonic Value

Meaning

false

Vertical scroll

true

Horizontal scroll

nAmount

Amount to scroll, can represent a value in pixels or in percentage depending upon the value of the bHorizontal parameter.

Value

Meaning

Negative value

If the bHorizontal parameter is set to "true" scrolls left the TracksBoard of the given amount of pixels

If the bHorizontal parameter is set to "false" scrolls up the TracksBoard of the given amount of percentage

Positive value

If the bHorizontal parameter is set to "true" scrolls right the TracksBoard of the given amount of pixels

If the bHorizontal parameter is set to "false" scrolls down the TracksBoard of the given amount of percentage

 

 

Return value

 

Value

Meaning

 

 

Negative value

An error occurred (see the LastError property for further error details)

enumErrorCodes.ERR_NOERROR (0)

The method call was successful