Classes > WaveformAnalyzer class > Methods > WaveformAnalyzer.GraphicItemVerticalLineAdd method

Remarks

Adds a new vertical line that will be displayed over the waveform's graphics.

On the screenshot below you can see a set of vertical lines displayed over the waveform, each with its own set of properties, positions and buddy text:

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

•	through code using the WaveformAnalyzer.GraphicItemHorzPositionSet method

•	through the mouse, causing a sequence of WaveAnalyzerLineMoveBegin, WaveAnalyzerLineMoving and WaveAnalyzerLineMoveEnd events to be generated.

During playback of the loaded sound, the WaveAnalyzerLineReached event is generated when playback position reaches the position of the vertical line.

This method fails if no sound is currently loaded into the editor.

The vertical line is automatically destroyed, as all of the other existing graphic items, when the loaded sound is discarded from memory through the CloseSound method.

A vertical line can be removed through the WaveformAnalyzer.GraphicItemRemove method and hidden or shown through the WaveformAnalyzer.GraphicItemShow method.

For details about graphic items management on the waveform analyzer refer to the How to add graphic items to the Waveform analyzer section.

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

strFriendlyName as String,

strDescription as String,

nPositionInMs as Int32,

settings as WANALYZER_VERTICAL_LINE

) as Int16

[C#]

public Int16 GraphicItemVerticalLineAdd (

string strFriendlyName,

string strDescription,

Int32 nPositionInMs,

WANALYZER_VERTICAL_LINE settings

);

[C++]

public: Int16 GraphicItemVerticalLineAdd (

string strFriendlyName,

string strDescription,

Int32 nPositionInMs,

WANALYZER_VERTICAL_LINE settings

);

Parameter	Description

strFriendlyName	Friendly name of the line. This friendly name can be modified or retrieved at a later time through the WaveformAnalyzer.GraphicItemNameGet and WaveformAnalyzer.GraphicItemNameSet methods.
strDescription	Description of the line. This description can be modified or retrieved at a later time through the WaveformAnalyzer.GraphicItemDescriptionGet and WaveformAnalyzer.GraphicItemDescriptionSet methods.
nPositionInMs	Position of the line expressed in milliseconds. This position can be modified or retrieved at a later time through the WaveformAnalyzer.GraphicItemHorzPositionGet and WaveformAnalyzer.GraphicItemHorzPositionSet methods.
settings	Settings for the new line. These settings can be modified or retrieved at a later time through the WaveformAnalyzer.GraphicItemVerticalLineParamsGet and WaveformAnalyzer.GraphicItemVerticalLineParamsSet methods.

Return value

Value	Meaning

0	An error occurred (see the LastError property for further error details)
Value > 0	Unique identification number assigned to this new line.