AnnoUIGetTextEditorBackground

 

Usage

Short AnnoUIGetTextEditorBackground(Component As BIANNOLib.RGBComponent)

Description

This method retrieves the red, green or blue color component of the background color that is visible when editing an aotText (=9) annotation object.

Parameters

Component

BIANNOLib.Component

The color component (compRed, compGreen or compBlue) of the background color to retrieve.

Return value

The value of the specified color component. The function will return 0 for every component if the background is set to transparent.

Programming Notes

This function cannot be used to determine if the text editor background is currently set to transparent. Use the AnnoUIIsTextEditorBackgroundTransparent function to find out if the background is transparent.