Copyright © 2008-2015 MultiMedia Soft

WaveformAnalyzer.GetRectangle method

Previous pageReturn to chapter overviewNext page

Remarks

 

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

 

For details about the use of the Waveform Analyzer refer to the How to use the Waveform Analyzer section.

For further details about methods of the Waveform Analyzer refer to the WaveformAnalyzer class section.

 

 

Syntax

 

[Visual Basic]

Public Function GetRectangle (

nIdRectangle as enumWaveAnalyzerRectangles,

nIdSecondary as Int16,

ByRef nLeft as Int32,

ByRef nTop as Int32,

ByRef nWidth as Int32,

ByRef nHeight as Int32

) as enumErrorCodes


 

[C#]

public enumErrorCodes GetRectangle (

enumWaveAnalyzerRectangles nIdRectangle,

Int16 nIdSecondary,

ref Int32 nLeft,

ref Int32 nTop,

ref Int32 nWidth,

ref Int32 nHeight

);


 

[C++]

public: enumErrorCodes GetRectangle (

enumWaveAnalyzerRectangles nIdRectangle,

Int16 nIdSecondary,

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

WAVEANALYZER_RECT_TOTAL

0

Total rectangle

WAVEANALYZER_RECT_WAVEFORM

1

Waveform rectangle

WAVEANALYZER_RECT_WAVEFORM_LEFT_CH

2

Waveform rectangle for left channel

WAVEANALYZER_RECT_WAVEFORM_RIGHT_CH

3

Waveform rectangle for right channel

WAVEANALYZER_RECT_SB_TOP

4

Top scrollbar rectangle

WAVEANALYZER_RECT_SB_BOTTOM

5

Bottom scrollbar rectangle

WAVEANALYZER_RECT_RULER_LEFT

6

Left ruler rectangle

WAVEANALYZER_RECT_RULER_RIGHT

7

Right ruler rectangle

WAVEANALYZER_RECT_RULER_TOP

8

Top ruler rectangle

WAVEANALYZER_RECT_RULER_BOTTOM

9

Bottom ruler rectangle

WAVEANALYZER_RECT_SELECTION

10

Selected rectangle

WAVEANALYZER_RECT_PLAYBACK_LINE

11

Playback line rectangle

WAVEANALYZER_RECT_CUSTOM_LINE

12

Custom vertical line rectangle. If nWidth and nHeight dimensions of the rectangle are both set to 0, this means that the line is not on the visible area of the waveform

WAVEANALYZER_RECT_HORZ_LINE_LEFT

13

Horizontal line on left channel rectangle. If nWidth and nHeight dimensions of the rectangle are both set to 0, this means that the line is not on the visible area of the waveform

WAVEANALYZER_RECT_HORZ_LINE_RIGHT

14

Horizontal line on right channel rectangle. If nWidth and nHeight dimensions of the rectangle are both set to 0, this means that the line is not on the visible area of the waveform

WAVEANALYZER_RECT_WAVE_RANGE

15

Wave range rectangle. If nWidth and nHeight dimensions of the rectangle are both set to 0, this means that the wave range is not on the visible area of the waveform

nIdSecondary

Unique identifier of a specific graphic item added to the analyzer through a call to one of the following methods:

Leave this parameter to 0 if the value of the nIdRectangle parameter is different from WAVEANALYZER_RECT_CUSTOM_LINE, WAVEANALYZER_RECT_HORZ_LINE_LEFT, WAVEANALYZER_RECT_HORZ_LINE_RIGHT or WAVEANALYZER_RECT_WAVE_RANGE.

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