String

The value type String is used to create an edit field for an string value input.

../../../../_images/String.png

Syntax

<Parameter>
<Name>StringValue</Name>
<Text>String</Text>
<Value>4, 7, 1, 1</Value>
<ValueType>String</ValueType>
</Parameter>

Optional

Additional info about the <Value> and the optional <ValueList> tag are shown here Value and ValueList

If the PythonPart should be localized, the following tag must be added

<TextId>1001</TextId>

Sometimes it’s useful to disable or hide the edit field depending on the value of another parameter. This is achieved by adding additional tags to the parameter or by defining functions in the py-file. See Enable and visible options

In some cases it’s useful to highlight input fields in the property palette, see Background color

The persistent state of the parameter can be changed by adding

<Persistent>…</Persistent>

Example

The implementation of the String value type is described in the example AllControls, which is located in

…\etc\Examples\PythonParts\PaletteExamples\AllControls.pyp
…\etc\PythonPartsExampleScripts\PaletteExamples\AllControls.py