poINote GetAnchorToScreen

Gets whether or not the note is anchored.

Syntax

note_handle GetAnchorToScreen

Application

HyperView Tcl Query

Description

This command retrieves the current anchor state of the note.

Example

To find out if note id 2 is anchored to the screen or not, use the following:

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 bool_anchor [note_handle GetAnchorToScreen];
hwi CloseStack

Errors

Returns "true" if the note is anchored to the screen, or "false" if the note is not anchored to the screen.