SetDocumentUserText

Sets or removes user text stored in the document. For more details on User Text, see the discussion found in the User Data Methods summary.

Syntax

rhinoscriptsyntax.SetDocumentUserText (key, value=None)

rhinoscript.userdata.SetDocumentUserText (key, value=None)

Parameters

key

Required.  String.  The key name to set.

value

Optional.  String.  The string value to set. If omitted the key/value pair specified by key will be deleted.

Returns

Boolean

True or False indicating success or failure.

Example

import rhinoscriptsyntax as rs

rs.SetDocumentUserText("Designer", "Steve Baer")

rs.SetDocumentUserText("Notes", "Added some layer and updated some geometry")

Also See

GetDocumentUserText

IsDocumentUserText