SetDocumentUserText
Toolbar | Menu |
---|---|
|
|
The SetDocumentUserText command attaches text information to a Rhino .3dm file. The information is stored in a key/value format. Retrieve the information with the GetDocumentUserText command.
To add a User Text key to a file
- Type the key.
- Type the value.
To add a hidden User Text key to a file
- Type the key with a "." (period) prefix.
- Type the value.
Note: Hidden keys will not appear in Document Properties > Document User Text and the Document User Text panel.
See: Naming conventions in Rhino
Toolbar | Menu |
---|---|
|
|
The GetDocumentUserText command retrieves text information attached using the SetDocumentUserText command.
Toolbar | Menu |
---|---|
|
Window Panels > Document User Text |
The DocumentText command opens the Document User Text panel that lets you manage the document user text.
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 key.
Value
The value of the UserText key.
Example |
|
---|---|
Key |
Value |
Part name |
X-Joint |
Part number |
XJT-20-584 |
Supplier |
Krypton Metals, Inc. |
Material |
Titanium |
Weight in kilograms |
20 |
Sort the list alphabetically
- Click the key or value column header.
The icon indicates the key is driven by a text field function.
- Double-click the icon to edit the text field.
Key |
Value |
|
Number |
5 |
|
Area |
20 |
|
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
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.