Table of Contents
String Property
A String Property is a text property that provides the name of a tag and holds a series of ascii/utf-8 characters. This property allows the user to insert a string of text that is then tagged onto the selected property. This text will then follow the property until the text is removed or changed.
For scripting API documentation, see DzStringProperty.
Anatomy
String properties typically display the Default Anatomy features as well as features specific to the the String property, namely the option to insert text.
Header
The Header of a String property displays the label of the property as well as icons that provide options for customizing how the property functions.
Body
The Body of a String property displays a text box and a widget button. Hover the cursor over the text box. When the cursor changes to a text “I” cursor, click within the text box to directly type in text. This box displays “String Value” by default.
The body also displays a button, labelled “…,” that when selected causes a “String” dialog to appear. Select within the “String” dialog text box to insert any length of text. This text body displays “String Value” by default. Check/uncheck the Word Map option to turn on or off the ___. Click “Accept” to save any inserted text and exit the dialog; or click “Cancel” to exit the dialog without saving text.
Sub-Types
The File Property property type is a sub-type of the String property and inherits the traits described above and offers its own unique traits.
File Property
A File Property provides the ability to choose a specific file to apply to the scene selection. As a sub-type of the String Property, this property gives the option to provide text for the application; however, the File property only offers file strings (text) for selection.
As a specialized version of the string property, the File property always holds the path to a file, unless it is empty, and will contain a path if it has a value. This is a path to a file or directory. If no value is provided, the property is a path.
For scripting API documentation, see DzFileProperty.