LeaderText

Returns or modifies the text string of a dimension leader object.

Syntax

rhinoscriptsyntax.LeaderText (object_id, text=None)

rhinoscript.dimension.LeaderText (object_id, text=None)

Parameters

object_id

Required. String or Guid. The object's identifier.

text

Optional. String. The new text string value.

Returns

String

If text is not specified, then the current text string if successful.

String

If text is specified, then the previous text string if successful.

None

On error.

Example

import rhinoscriptsyntax as rs

obj = rs.GetObject("Select a leader")

if rs.IsLeader(obj): print rs.LeaderText(obj)

Also See

AddLeader

IsLeader