poINote GetBackgroundColor

Gets the background/fill color of the note.

Syntax

note_handle GetBackgroundColor

Application

HyperView Tcl Query

Description

This command retrieves the background color, or the fill color, of the note. The return value is a string which corresponds to the rgb color value.

Example

To retrieve the background/fill color of the note whose id is "2":

hwi OpenStack
hwi GetSessionHandle session_handle
session_handle GetProjectHandle project_handle
project_handle GetPageHandle page_handle [project_handle GetActivePage]
page_handle GetWindowHandle window_handle [page_handle GetActiveWindow]
window_handle GetClientHandle client_handle
client_handle GetNoteHandle note_handle 2;
set fill_color [note_handle GetBackgroundColor]
hwi CloseStack

Error

Returns a valid rgb color if an invalid rgb color is set using the "SetBackgroundColor" API. Valid rgb colors are the 64 colors supported by HyperView.