Copyright © 2008-2013 MultiMedia Soft

WANALYZER_BUDDY_TEXT structure

Previous pageReturn to chapter overviewNext page

The WANALYZER_BUDDY_TEXT structure describes settings applied to a "buddy" text assigned to a graphic item, available on the Waveform Analyzer, through the GraphicItemBuddyTextSet method. The current settings of the "buddy" text can be retrieved through the GraphicItemBuddyTextParamsGet method and modified through the GraphicItemBuddyTextParamsSet method.

 

 

C# definition

 

public struct WANALYZER_BUDDY_TEXT

{

     public Color colorText;

     public Color colorTextOutline;

     public Int16 nOutlineWidth;

     public Int16 nTranspFactor;

     public enumBuddyAlignment nAlignment;

     public bool bKeepVisible;

};

 

 

Member

Description

 

 

colorText

Text color

colorTextOutline

Text outline color. If this color is set to a value identical to the colorText field, no outline is rendered.

nOutlineWidth

Text outline width in pixels. If this field is set to 0, no outline is rendered.

nTranspFactor

Transparent factor. This value can range from 0 (total opacity) to 255 (total transparency). Values outside of this range will be automatically capped to the nearest valid value.

nAlignment

Alignment respect to the graphic item.

Supported values are the following:

Mnemonic constant

Value

Meaning

BUDDY_ALIGN_LEFT_TOP

0

Buddy element is left-top aligned

BUDDY_ALIGN_CENTER_TOP

1

Buddy element is center-top aligned

BUDDY_ALIGN_RIGHT_TOP

2

Buddy element is right-top aligned

BUDDY_ALIGN_LEFT_MIDDLE

3

Buddy element is left-middle aligned

BUDDY_ALIGN_CENTER_MIDDLE

4

Buddy element is center-middle aligned

BUDDY_ALIGN_RIGHT_MIDDLE

5

Buddy element is right-center aligned

BUDDY_ALIGN_LEFT_BOTTOM

6

Buddy element is left-bottom aligned

BUDDY_ALIGN_CENTER_BOTTOM

7

Buddy element is center-bottom aligned

BUDDY_ALIGN_RIGHT_BOTTOM

8

Buddy element is right-bottom aligned

bKeepVisible

Boolean value that specifies if the buddy text is kept visible when reaching the limits of the waveform visible range.

Supported values are the following:

Mnemonic constant

Meaning

False

The buddy text is not kept visible

True

The buddy text is kept visible