Skip to content

Properties objects

Common Properties

Defining <ValueType> as CommonProperties creates input controls for the selection of format properties like pen, line and color. The return value of the parameter would be a CommonProperties object

Parameter CommonProperties

<Parameter>
    <Name>CommonProp</Name>
    <Text></Text><!--(2)!-->
    <Value></Value> <!--(1)!-->
    <ValueType>CommonProperties</ValueType>
</Parameter>
  1. Leaving this tag empty initializes the palette with CommonProperties object with the current format properties.
  2. Setting a value in this tag will result in combining the text with the default text of the property.

Surface element properties

Defining <ValueType> as SurfaceElementProperties creates input controls for the selection of hatching/pattern/filling/etc. The return value of the parameter would be a SurfaceElementProperties object

Parameter SurfaceElementProperties

<Parameter>
    <Name>SurfaceElementProp</Name>
    <Text><!--(1)!--></Text>
    <Value></Value>
    <ValueType>SurfaceElementProperties</ValueType>
</Parameter>
  1. Setting a value in this tag will result in combining the text with the default text of each control.

Hide individual control

To hide an individual control of the parameter, include the <Visible>(1) tag and specify the control name followed by a colon : and the boolean statement. Separate the expressions for each control with | like this:

  1. Using the <Enable> tag is not allowed
<Parameter>
    ...
    <Visible>|CommonProp.ColorByLayer:False|CommonProp.DrawOrder:False</Visible><!--(1)!-->
</Parameter>

  1. Following key words for the control name are allowed for the value type CommonProperties:

    • Stroke
    • StrokeByLayer
    • Pen
    • PenByLayer
    • Color
    • ColorByLayer
    • Layer
    • DrawOrder

    And following key words are allowed for the value type SurfaceElementProperties:

    • BitmapID
    • BitmapSelected
    • FaceStyleID
    • FaceStyleSelected
    • FillingID
    • FillingSelected
    • HatchID
    • HatchSelected
    • PatternID
    • PatternSelected
    • UseAreaInGroundplan

Examples on GitHub

Refer to the following examples:

Placeholder