leHiCreateLabel

leHiCreateLabel( 
[ w_windowId ] 
[ t_mode ]
) 
=> t / nil

Description

Opens the Create Label form, which lets you create a label in the specified window. If w_windowId is not specified, the current window is used.

You can specify the text for the label, the height of the label, the font style, and the justification. You can choose options for Drafting and Attach. You can also rotate the label or mirror the label over the X or Y axis.

Arguments

w_windowId	ID of the window in which labels are to be created.
t_mode	Mode for creating the label. Valid values: manual, fromConnectivity

Values Returned

t	Returned when the Create Label form is already open.
nil	Returned when the command fails to run.

Examples

Opens the Create Label form for the current window:

leHiCreateLabel()

Opens the Create Label form for the current window:

leHiCreateLabel(hiGetCurrentWindow())

Opens the Create Label form for the current window with the Manual option selected:

leHiCreateLabel(hiGetCurrentWindow() "manual")

Prompts you to click the shape to be labeled. If you select a shape that does not have any associated net information, an appropriate warning message is generated in the CIW. You can press F3 to open the Create Label form to configure additional label settings.

leHiCreateLabel(hiGetCurrentWindow() "fromConnectivity")

Return to top