SetUserText

Toolbar Menu

Not on toolbars.

Not on menus.

The SetUserText command attaches text information to an object. The information is stored in a key/value format. Retrieve the information with the GetUserText command.

This information can also be attached by .NET plug-ins and VisualBasic scripts. This information is easily accessed in .NET and Visual Basic scripts.

To add a User Text key to an object

  1. Select an object.
  2. Type the key.
  3. Type the value.

To add a hidden User Text key to an object

  1. Select an object.
  2. Type the key with a "." (period) prefix.
  3. Type the value.

Note: Hidden keys will not appear in Object Properties > Attribute User Text.

To remove a User Text key from an object

  1. Select an object.
  2. Type an existing key.
  3. Type "" (two double quotes) as the value.

Command-line options

AttachTo
Object

Attaches text information to the object geometry.

If the information is closely associated with the geometry, attach it to the geometry. For example, a circle's radius should be attached to the geometry because the information will be invalid if the circle is control-point edited and changed into a NURBS curve.

Attributes

Attaches text information to the attributes of an object.

If the information is higher-level attribute information, like color, then it should be attached to the object's attributes. Attribute information will persist when an object is control-point edited, trimmed, copied, and so on.

More information about User Text

GetUserText

Toolbar Menu

Not on toolbars.

Not on menus.

The GetUserText command retrieves text information attached to an object using the SetUserText command. This information can also be retrieved by .NET plug-ins and VisualBasic scripts.

Steps

  1. Select an object.
  2. Press Enter to list all the user text keys and values in the object.
    Or, type a key name and press Enter. The command returns the value of the key.

See also

Attribute User Text properties

More information about User Text

 

 

 

Rhinoceros 6 © 2010-2019 Robert McNeel & Associates. 31-Jan-2019