Methods > Graphic items management > GraphicItemBuddyTextSet method

Remarks

Sets a buddy text of a graphic item over the waveform's graphics. The current buddy text can be obtained through the GraphicItemBuddyTextGet method.

Settings of the buddy text can be obtained and modified through the GraphicItemBuddyTextParamsGet and GraphicItemBuddyTextParamsSet methods.

On the screenshot below you can see a set of vertical lines displayed over the waveform, each with its buddy text aligned on the top right of the vertical line:

An existing buddy text can be removed at a later time by calling this method again and by specifying an empty text string.

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

Syntax

[Visual Basic]

Public Function GraphicItemBuddyTextSet (

nUniqueId as Int32,

strText as String,

settings as WANALYZER_BUDDY_TEXT,

ByRef fontText as Font

) as enumWanErrorCodes

[C#]

public enumWanErrorCodes GraphicItemBuddyTextSet (

Int32 nUniqueId,

string strText,

WANALYZER_BUDDY_TEXT settings,

ref Font fontText

);

[C++]

public: enumWanErrorCodes GraphicItemBuddyTextSet (

Int32 nUniqueId,

string strText,

WANALYZER_BUDDY_TEXT settings,

Font __gc *fontText

);

Parameter

Description

nUniqueId

Unique identification number assigned to the graphic item.

The unique identification number of a graphic item is generated using one of the following methods:

•	GraphicItemHorizontalLineAdd for horizontal lines

•	GraphicItemVerticalLineAdd for vertical lines

•	GraphicItemWaveRangeAdd for wave ranges

strText

String of the buddy text.

An empty string will remove an eventually existing buddy text.

settings

Settings for the buddy text.

These settings can be modified or retrieved at a later time through the GraphicItemBuddyTextParamsSet and WaveformAnalyzer.GraphicItemBuddyTextParamsGet methods.

fontText

Reference to the font used for rendering the text.

Return value

Value	Meaning

Negative value	An error occurred (see the LastError property for further error details)
enumWanErrorCodes.ERR_WAN_NOERROR (0)	The method call was successful.