Classes > TracksBoard class > Methods > TracksBoard.RectangleGet method

Remarks

Obtains the rectangle where a specific graphic element is positioned inside the TracksBoard.

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 RectangleGet (

nIdRectangle as enumTracksBoardRectangles,

nIdFirst as Int32,

nIdSecond as Int32,

ByRef nLeft as Int32,

ByRef nTop as Int32,

ByRef nWidth as Int32,

ByRef nHeight as Int32

) as enumErrorCodes

[C#]

public enumErrorCodes RectangleGet (

enumTracksBoardRectangles nIdRectangle,

Int32 nIdFirst,

Int32 nIdSecond,

ref Int32 nLeft,

ref Int32 nTop,

ref Int32 nWidth,

ref Int32 nHeight

);

[C++]

public: enumErrorCodes RectangleGet (

enumTracksBoardRectangles nIdRectangle,

Int32 nIdFirst,

Int32 nIdSecond,

Int32 __gc *nLeft,

Int32 __gc *nTop,

Int32 __gc *nWidth,

Int32 __gc *nHeight

);

Parameter

Description

nIdRectangle

Mnemonic Identifier of the graphic element

Supported values are the following:

Mnemonic value

Value

Meaning

TRACKSBOARD_RECT_TOTAL

Total rectangle of the TracksBoard's window

TRACKSBOARD_RECT_ALL_TRACKS

Rectangle containing all of the tracks

TRACKSBOARD_RECT_SINGLE_TRACK

Rectangle of a single track; use the nIdFirst parameter to define the zero-based index of the track of interest

TRACKSBOARD_RECT_SB_TOP

Top horizontal scrollbar rectangle

TRACKSBOARD_RECT_SB_BOTTOM

Bottom horizontal scrollbar rectangle

TRACKSBOARD_RECT_SB_RIGHT

Right vertical scrollbar rectangle

TRACKSBOARD_RECT_RULER_LEFT

Left ruler rectangle

TRACKSBOARD_RECT_RULER_RIGHT

Right ruler rectangle

TRACKSBOARD_RECT_RULER_TOP

Top ruler rectangle

TRACKSBOARD_RECT_RULER_BOTTOM

Bottom ruler rectangle

TRACKSBOARD_RECT_SELECTION

Selected rectangle

TRACKSBOARD_RECT_PLAYBACK_LINE

Play head line rectangle

TRACKSBOARD_RECT_SINGLE_ITEM

Single item rectangle; use the nIdFirst parameter to define the unique identification number of the item of interest.

The unique identification number is assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

TRACKSBOARD_RECT_SINGLE_VOLUME_POINT

Single volume point rectangle: use the nIdFirst parameter to define the unique identification number of the item of interest and the the nIdSecond parameter to define the zero-based index of the volume point of interest.

The unique identification number is assigned to the sound item after being generated by one of the following methods:

•	TracksBoard.ItemSoundFileAdd and TracksBoard.ItemSoundFileRawAdd for sound files

•	TracksBoard.ItemSpeechFromStringAdd and TracksBoard.ItemSpeechFromFileAdd for text to speech items

•	TracksBoard.ItemClone when an existing item has been cloned

The total number of volume points available for the given item can be obtained through the TracksBoard.ItemVolumePointCountGet method

nIdFirst

In case the nIdRectangle parameter should be set to TRACKSBOARD_RECT_SINGLE_TRACK this parameter defines the zero-based index of a specific track

In case the nIdRectangle parameter should be set to TRACKSBOARD_RECT_SINGLE_ITEM or TRACKSBOARD_RECT_SINGLE_VOLUME_POINT this parameter defines the unique identification number of the item.

In all other cases this parameter is ignored.

nIdSecond

In case the nIdRectangle parameter should be set to TRACKSBOARD_RECT_SINGLE_VOLUME_POINT this parameter defines the zero-based index of the volume point belonging to the item defined into the nIdFirst parameter.

In all other cases this parameter is ignored.

nLeft

Reference that, after returning from the method call, will contain the left coordinate, expressed in pixels, of the requested rectangle respect to the client area of the Waveform Analyzer.

nTop

Reference that, after returning from the method call, will contain the top coordinate, expressed in pixels, of the requested rectangle respect to the client area of the Waveform Analyzer.

nWidth

Reference that, after returning from the method call, will contain the width, expressed in pixels, of the requested rectangle.

nHeight

Reference that, after returning from the method call, will contain the height, expressed in pixels, of the requested rectangle

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