GetDocumentUserText

Returns User Text that is stored in the document. For more details on User Text, see the discussion found in the User Data Methods summary.

Syntax

rhinoscriptsyntax.GetDocumentUserText (key=None)

rhinoscript.userdata.GetDocumentUserText (key=None)

Parameters

key

Optional.  String.  The key name.  If omitted or an empty string ("") is specified, all key names for the object are returned.

Returns

String

If key is specified, then the associated value if successful.

List

If key is not specified, then a list of key names if successful.

None

If not successful, or on error.

Example

import rhinoscriptsyntax as rs

print rs.GetDocumentUserText("Designer")

print rs.GetDocumentUserText("Notes")

Also See

IsDocumentUserText

SetDocumentUserText