GuideNameList

GuideNameList (winNameStr, optionsStr)

The GuideNameList function returns a string containing a semicolon-separated list of guide names from the named host window or subwindow.

Parameters

winNameStr can be "" to refer to the top host window.

When identifying a subwindow with winNameStr, see Subwindow Syntax for details on forming the window hierarchy.

optionsStr is used to further qualify the list of guides. It is a string containing keyword-value pairs separated by commas. Use "" to list all guides. Available options are:

TYPE:type	type = BuiltIn: List only built-in guides. type = User: List only user-defined guides, those created by the DefineGuide operation or by manually dragging a new guide from an existing one.
HORIZONTAL:h	h = 0: List only non-horizontal (that is, vertical) guides. h = 1: List only horizontal guides.

Example

String list = GuideNameList("Graph0", "TYPE:Builtin,HORIZONTAL:1")

See Also

DefineGuide, GuideInfo