Methods > Graphic items management > GraphicItemBuddyTextParamsGetEx method

Remarks

Obtains the value of one of the settings for the buddy text of the given graphic item. Value of single settings can be modified through the GraphicItemBuddyTextParamsSetEx method.

This method is an alternative to the GraphicItemBuddyTextParamsGet method and is provided with the purpose of allowing single settings modifications when dealing with languages like JavaScript where data structures are not easy to implement.

Syntax

[Visual Basic]

control.GraphicItemBuddyTextParamsGetEx (

nUniqueId as Integer,

nParam as short

) as String

[C++]

BSTR control.GraphicItemBuddyTextParamsGetEx (

short nUniqueId,

short nParam

);

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

nParam

Numeric identifier of the requested parameter.

Supported values are the following:

Value	Meaning
0	colorText member of the WANALYZER_BUDDY_TEXT data structure
1	colorTextOutline member of the WANALYZER_BUDDY_TEXT data structure
2	nOutlineWidth member of the WANALYZER_BUDDY_TEXT data structure
3	nTranspFactor member of the WANALYZER_BUDDY_TEXT data structure
4	nAlignment member of the WANALYZER_BUDDY_TEXT data structure
5	bKeepVisible member of the WANALYZER_BUDDY_TEXT data structure

Return value

Value

Meaning

Empty string

An error occurred: see the LastError property for further error details or for a list of the possible error values.

Valid string

String containing the value of the requested parameter.

The value is formatted with the following rules:

•	Color values are formatted like "#RRGGBB" where:

- "#" represents the control character used for formatting colors in HTML code: the presence of this character is mandatory

- RR represents the hexadecimal value of the color's red component

- GG represents the hexadecimal value of the color's green component

- BB represents the hexadecimal value of the color's blue component

For example the green color will be represented with the value "#00FF00"

•	Boolean values are rendered as

- "1" or "True" for indicating the boolean "true"

- "0" or "False" for indicating the boolean "false"