Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.MouseActionRectangleGet method

Remarks

Obtains the identifier of the rectangle on which a mouse action occurred.

This method can be usually invoked from within the handler function of the WaveAnalyzerMouseNotification event, whose xPos and yPos parameters represent the point where the mouse action occurred.

Position and size of various rectangles can be obtained through the WaveformAnalyzer.GetRectangle method.

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

xPos as Int32,

yPos as Int32,

ByRef nRectangle as enumWaveAnalyzerRectangles

) as enumErrorCodes

[C#]

public enumErrorCodes MouseActionRectangleGet (

Int32 xPos,

Int32 yPos,

ref enumWaveAnalyzerRectangles nRectangle

);

[C++]

public: enumErrorCodes MouseActionRectangleGet (

Int32 xPos,

Int32 yPos,

enumWaveAnalyzerRectangles __gc *nRectangle

);

Parameter

Description

xPos

Horizontal position, expressed in pixels respect to the waveform's client area, where the mouse generated the notification.

yPos

Vertical position, expressed in pixels respect to the waveform's client area, where the mouse generated the notification

nRectangle

Reference that, on return from the method call, will contain the identifier of the rectangle

Supported values are the following:

Mnemonic constant	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	Selection rectangle
WAVEANALYZER_RECT_PLAYBACK_LINE	11	Playback line rectangle
WAVEANALYZER_RECT_CUSTOM_LINE	12	Custom vertical line rectangle
WAVEANALYZER_RECT_HORZ_LINE_LEFT	13	Horizontal line on left channel rectangle
WAVEANALYZER_RECT_HORZ_LINE_RIGHT	14	Horizontal line on right channel rectangle
WAVEANALYZER_RECT_WAVE_RANGE	15	Wave range rectangle
WAVEANALYZER_RECT_WAVEFORM_CH_0	16	Waveform rectangle for channel 0
WAVEANALYZER_RECT_WAVEFORM_CH_1	17	Waveform rectangle for channel 1
WAVEANALYZER_RECT_WAVEFORM_CH_2	18	Waveform rectangle for channel 2
WAVEANALYZER_RECT_WAVEFORM_CH_3	19	Waveform rectangle for channel 3
WAVEANALYZER_RECT_WAVEFORM_CH_4	20	Waveform rectangle for channel 4
WAVEANALYZER_RECT_WAVEFORM_CH_5	21	Waveform rectangle for channel 5
WAVEANALYZER_RECT_WAVEFORM_CH_6	22	Waveform rectangle for channel 6
WAVEANALYZER_RECT_WAVEFORM_CH_7	23	Waveform rectangle for channel 7

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.