Document User Text properties

Toolbar Menu

File
Properties
Standard

File

Properties

The Document User Text page in Document Properties lists text information attached to the model. The Document User Text panel is the quick access to this page.

Search

Type in the search box to only display the User Text that contains the typed text in its key or value.

Key

The name of the UserText.

Value

The value of the UserText.

Type

The type of the UserText.

It can be Plain text, Block Attribute Text, or Textfield.

See: Naming conventions in Rhino

Sort the list

  • Click the Key, Value, or Type column header.

Indicators

The indicators in the list provide some information of the user text items.

Key

Value

(Type)
ModelUnits  

Number

5

  

Area

24.2

Material Brass

= A key driven by a text field function that does not reference geometry.

= A key driven by a text field function that references geometry.

  • Double-click the or icon to edit the text field.

= A Block Attribute Text.

  • A Block Attribute Key ("Material" in the table above) can only be edited via the BlockEdit command.

Toolbar

New

Adds a User Text key to the 3dm file. Prefix a key with a "." (period) to add a hidden key.

Hidden keys will not appear in Document Properties > Document User Text and the Document User Text panel.

Text Fields

Retrieves information from the current document or an object.

Delete

Removes the selected User Text key from the 3dm file.

Use the SetDocumentUserText command to remove a hidden key.

Import

Reads User Text keys from a .3dm, .csv or .txt file into the current 3dm file.

Export

Saves User Text keys in the current 3dm file to a .csv or .txt file.

Right-click context menu

Assign to Objects

Copies the key-value pair to the selected object as Attribute User Text.

Select Function Object(s)

Selects the object referenced by the text field function in the key-value pair.

Copy key and value

Copies the selected key and value to the Clipboard.

Paste key and value

Pastes the key and value from the Clipboard.

Paste key and value to all layouts

Pastes the key and value stored in the Clipboard to every layout.

  • User Text can be copied and pasted between object, layout, and document properties.
  • Attribute User Text is pasted to Document User Text or Layout User Text in the format of <Key>:<Object Name>|<Value>. If the object does not have a name, <Object Name> is replaced by the object's GUID.
  • Paste key and value to all layouts does not overwrite the values of existing keys.

  • Search for ExportDocumentUserText in Advanced settings. It is false by default. When it is true, Document User Text will be saved on export or copied to Clipboard by Ctrl(CMD)+C.

See also

GetDocumentUserText

Retrieve text information attached to a file with the SetDocumentUserText command.

SetDocumentUserText

Attach text information to the file.