Parameter tags

The following tags can be used to define a <Parameter> node:

<Parameter>
<Name>……</Name>
<Text>……</Text>
<TextId>……</TextId>
<Value>……</Value>
<ImperialValue>……</ImperialValue>
<ValueTextId>……</ValueTextId>
<ValueDialog>……</ValueDialog>
<ValueList>……</ValueList>
<ValueList2>……</ValueList2>
<ValueList_TextIds>……</ValueList_TextIds>
<MinValue>……</MinValue>
<MaxValue>……</MaxValue>
<ValueSlider>……</ValueSlider>
<IntervalValue>……</IntervalValue>
<ValueType>……</ValueType>
<EventId>……</EventId>
<Enable>……</Enable>
<Visible>……</Enable>
<Persistent>……</Persistent>
<Orientation>……</Orientation>
<DisableButtonIsShown>……</DisableButtonIsShown> <Dimensions>……</Dimensions> <ValueListStartRow>……</ValueListStartRow> <ValueIndexName>……</ValueIndexName> <AttributeId>……</AttributeId> <ListGroup>……</ListGroup> <ExcludeIdentical>……</ExcludeIdentical> <HeightInRow>……</HeightInRow> <WidthInRow>……</WidthInRow> <FontStyle>……</FontStyle> <FontFaceCode>……</FontFaceCode> <BackgroundColor>……</BackgroundColor>
</Parameter>

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. The dialog is ope

<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 controls is displayed as slider.

<IntervalValue>

Yes

Interval value for the slider and grid length for the handle.

<ValueType>

No

Value type of the defined value. This value is used to create the corresponding input control for the value in the property palette.

<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, the following states are possible:

  • No: No persistent parameter

  • ModelAndFavorite: The parameter is stored in the PythonPart and the favorites file

  • Model: The parameter is stored in the PythonPart

  • Favorite: The parameter is stored in the the favorites file

The default value is ModelAndFavorite

<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

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

Depending of the defined value type in <ValueType>, different tags are required to define the data needed for the creation of the controls in the property palette. Detailed information about this can be found in the following sections.