::hwp::GetNote

Gets a note handle of a window.

Syntax

::hwp::GetNote

Application

HyperWorks Tcl Query

Description

This procedure implements minus options.

This procedure returns a note handle of HyperGraph or HyperView.

If no page ID is requested, then it operates on the current/active page.

If no window ID is given, then it returns a note handle of the active window.

Mandatory Arguments

None.

Optional Arguments

-page "pageID"
The page ID of the requested page.
-window "windowID"
The window ID of the requested window.
-note "noteID"
The note ID of the requested note.

Returns

Returns a note handle of a window.

Example

set noteHandle [::hwp::GetNote -page 3 -window 1 -note 2]