Classes > TracksBoard class > Methods > TracksBoard.VerticalLineAdd method

Remarks

Adds a new vertical line that will be displayed over the TracksBoard session.

On the screenshot below you can see a set of four vertical lines displayed over the session, each with its own color, set of properties and position:

This line can be moved on the screen in one of the following ways:

•	through code using the TracksBoard.VerticalLinePositionSet method

•	through the mouse, causing the TracksboardLineMoved event to be generated.

During playback of the session, the TracksBoardLineReached event is generated when playback position reaches the position of the vertical line.

The vertical line is automatically destroyed when the current session is discarded from memory through the CloseSound method or when a new session is loaded through the TracksBoard.Load method.

A vertical line can be removed through the TracksBoard.VerticalLineRemove method and hidden or shown through the TracksBoard.VerticalLinesShow method.

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 object section.

Syntax

[Visual Basic]

Public Function VerticalLineAdd (

strFriendlyName as String,

strDescription as String,

nPositionInMs as Int32,

settings as WANALYZER_VERTICAL_LINE,

ByRef nUniqueId as Int32

) as Int16

[C#]

public Int16 VerticalLineAdd (

string strFriendlyName,

string strDescription,

Int32 nPositionInMs,

WANALYZER_VERTICAL_LINE settings,

ref Int32 nUniqueId

);

[C++]

public: Int16 VerticalLineAdd (

string strFriendlyName,

string strDescription,

Int32 nPositionInMs,

WANALYZER_VERTICAL_LINE settings,

Int32 __gc *nUniqueId

);

Parameter	Description

strFriendlyName	Friendly name of the line. This friendly name can be modified or retrieved at a later time through the TracksBoard.VerticalLineNameGet and TracksBoard.VerticalLineNameSet methods.
strDescription	Description of the line. This description can be modified or retrieved at a later time through the TracksBoard.VerticalLineDescriptionGet and TracksBoard.VerticalLineDescriptionSet methods.
nPositionInMs	Position of the line expressed in milliseconds. This position can be modified or retrieved at a later time through the TracksBoard.VerticalLinePositionGet and TracksBoard.VerticalLinePositionSet methods.
settings	Address of a structure of type WANALYZER_VERTICAL_LINE that contains the settings for the new line. These settings can be modified or retrieved at a later time through the TracksBoard.VerticalLineParamsGet and TracksBoard.VerticalLineParamsSet methods.
nUniqueId	Reference to a value that, on return from the method call, will contain the unique identifier of the newly added vertical line: this unique identifier will be used in order to invoke further methods related to the use of this specific vertical line.

Return value

Value	Meaning

Negative value	An error occurred, check the LastError property value in order to get the error code
enumErrorCodes.ERR_NOERROR (0)	The method call was successful