All tags
Here is a list of all tags which can be included in <Paramater> node.
| Tag | Optional | Description |
|---|---|---|
<Name> |
No | Name of the parameter, must be unique in the pyp-file. |
<Text> |
No | The text is displayed in the property palette as control text. |
<TextId> |
Yes | Text ID of the <Text>, used for localization of the PythonPart. |
<Value> |
No | The initial value of the parameter. |
<ImperialValue> |
Yes | The initial value of the parameter in an imperial input unit such as feet, inches, …. |
<ValueTextId> |
Yes | Text ID of the <Value> in case of a string value, used for localization of the PythonPart. |
<ValueDialog> |
Yes | Defines the name of an input dialog, which is used for the input of the value. |
<ValueList> |
No | The initial values for the entries in a combo box list or picture button list. The allowed values for edit controls. The values are separated by | like left|center|right or include a range command. |
<ValueList2> |
No | The initial image data for the entries in a picture combo box or picture button list. |
<ValueList_TextIds> |
No | The text IDs for <ValueList>, separated by | like 1328|1327|1329 |
<MinValue> |
Yes | The defined value is used as minimal value for the input control. |
<MaxValue> |
Yes | The defined value is used as maximal value for the input control. |
<ValueSlider> |
Yes | If set to True, the input control is displayed as slider. |
<IntervalValue> |
Yes | Interval value for the slider and grid length for the handle. |
<ValueType> |
No | Value type1 of the defined value. |
<EventId> |
No | Event ID for the button controls. The value is used for the button click. |
<Enable> |
Yes | Value or condition of enable/disable the input control in the property palette. |
<Visible> |
Yes | Value or condition of show/hide the input control in the property palette. |
<Persistent> |
Yes | Defines the persistent state of the parameter. |
<Orientation> |
No | The orientation of a picture. |
<DisableButtonIsShown> |
Yes | If set to True, the disable-button is shown for the material input. |
<Dimensions> |
Yes | Parameter names of the list dimensions (for value as Python list). |
<ValueListStartRow> |
Yes | Index of the start row (for value as Python list). |
<ValueIndexName> |
Yes | Name of the index for the visible row (for value as Python list). |
<AttributeId> |
Yes | When defined, the value is used as an attribute and is assigned to the attribute with the defined ID. |
<ListGroup> |
Yes | Individual parameter with value lists can be grouped to combine the controls with the same list item index into a block within the Properties palette. |
<ExcludeIdentical> |
Yes | Exclude parameter from the Identical PythonPart check. |
<HeightInRow> |
Yes | Define the height of the control, only for controls that are in a row. |
<WidthInRow> |
Yes | Define the width of the control, only for controls that are in a row. |
<FontStyle> |
Yes | Define the font style of the control text. |
<FontFaceCode> |
Yes | Define the font facade code of the control text. |
<BackgroundColor> |
Yes | Define the background color of the input field. |
<XYZinRow> |
Yes | Relevant for geometry parameters only. When set to True, the x, y and z coordinates will be displayed in one row instead of in separate row each |
-
The tag
<ValueType>not only determines the type of the parameter (integer, string, etc.) but also, the input control that appears in the property palette of the PythonPart. Depending on the defined<ValueType>different tags are required for the creation of the input controls in the property palette. Please refer to the chapter Key Components -> Property Palette -> Control types and select the desired type of input control to learn more. ↩