Method getUserEntityWithStringValues

Namespace

VectorDraw.Professional.ActionUtility

Assembly

VectorDraw.Professional.dll

getUserEntityWithStringValues(out vdFigure, out gPoint, LockLayerMethodEnum)

Prompt the user to pick an entity from the active layout.

public string getUserEntityWithStringValues(out vdFigure retfig, out gPoint retpt, vdDocument.LockLayerMethodEnum locklayerMethod)

Parameters

retfig vdFigure

A vdFigure variable to return the figure that the user selected.

retpt gPoint

A gPoint variable to return the point in User Coordinate System that the user clicked.

locklayerMethod vdDocument.LockLayerMethodEnum

The method to be used in combination with active LockLayerMethod property value, to test if entities belonging in locked layers are accepted. You can use EnableGetEntityFromPoint for default getUserEntity(out vdFigure, out gPoint) implementation.

Returns

string

An Empty string if the user clicked a figure , or one of the added AcceptedStringValues that the developer gave.

Remarks

The command can end with right click in which case the result will be an empty string.