Remarks
Adds a new vertical line that will be displayed over the waveform's graphics. This line can be manually moved on the screen through the mouse causing a WaveAnalyzerLineMoving event to be generated.
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 VerticalLineAddWithName (
nUniqueId as Int16,
strFriendlyName as String,
nPosition as Int32,
color as Color,
nMode as enumWaveformLineModes,
nWidth as Int16
) as enumErrorCodes
|
|
Parameter
|
Description
|
|
|
nUniqueId
|
Unique identification number assigned to this new line.
It's recommended to avoid the usage of value -1 because it has internally a special and dedicated meaning.
|
strFriendlyName
|
Friendly name of the vertical line
|
nPosition
|
Initial position expressed in milliseconds
|
color
|
Color of the line
|
nMode
|
Line mode used for rendering the line.
Supported values are the following:
Mnemonic constant
|
Numeric value
|
Meaning
|
LINE_MODE_DOTTED
|
0
|
Dotted line (applied only if the nWidth parameter below is set to 1)
|
LINE_MODE_DASHED
|
1
|
Dashed line (applied only if the nWidth parameter below is set to 1)
|
LINE_MODE_SOLID
|
2
|
Solid line
|
|
nWidth
|
Width of the line expressed in pixels. In case the parameter should be set to a value higher than 1, the nMode parameter above would be automatically set to LINE_MODE_SOLID.
|
Return value
Value
|
Meaning
|
|
|
Negative value
|
An error occurred (see the LastError property for further error details)
|
enumErrorCodes.NOERROR (0)
|
The method call was successful.
|
|
