This functionality is only available for certain module packages. Info / Copyright

Action: XGedStartInteractionAction


Parameter

Description

Name

Name of the interaction to be started. Possible interactions are:

In EPLAN you can create these interactions as actions on toolbar buttons. The parameters for the above interactions are listed below.

Parameters for the "XGedIaFormatDefPoints" interaction

Parameter

Description

Values

/width:?

Line thickness

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

/color:?

(Text or line) Color

The predefined values are:

  • 0 = black
  • 1 = red
  • 2 = yellow
  • 3 = green
  • 4 = cyan
  • 5 = blue
  • 6 = magenta
  • 7 = black
  • 8 = white
  • 9 = light gray
  • 252 = dark gray
  • 253 = gray
  • -16002 = from layer.

However, other values can also be specified in the Color selection dialog. Values from 0 to 256 are possible. The color values are displayed in the color selection tooltips.

/type:?

Line type

The following values are possible:

  • 0 = solid
  • 1 = dashed
  • 2 = dotted
  • 3 = dash-dot
  • 4 = dash-dot-dot
  • 5 = dash-2 short dashes
  • 26 = long dash-dot
  • -16002 = from layer.

/patternlength:?

Pattern length

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

Parameters for the "XGedIaFormatGraphic" interaction

Parameter

Description

Values

/width:?

Line thickness

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

/color:?

(Text or line) Color

The predefined values are:

  • 0 = black
  • 1 = red
  • 2 = yellow
  • 3 = green
  • 4 = cyan
  • 5 = blue
  • 6 = magenta
  • 7 = black
  • 8 = white
  • 9 = light gray
  • 252 = dark gray
  • 253 = gray
  • -16002 = from layer.

However, other values can also be specified in the Color selection dialog. Values from 0 to 256 are possible. The color values are displayed in the color selection tooltips.

/visible:?

Invisible (text or line invisible / visible)

The following values are possible:

  • 0 = invisible
  • 1 = visible.
  • 2 = from layer.

/type:?

Line type

The following values are possible:

  • 0 = solid
  • 1 = dashed
  • 2 = dotted
  • 3 = dash-dot
  • 4 = dash-dot-dot
  • 5 = dash-2 short dashes
  • 26 = long dash-dot
  • -16002 = from layer.

/patternlength:?

Pattern length

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

/lineendstyle:?

Line end style

The following values are possible:

  • 0 = round
  • 1 = rectangular
  • 2 = flat
  • 32 = from layer.

/filled:?

Fill surface

The following values are possible:

  • 0 = graphical element is not filled
  • 1 = graphical element is filled.

/rounded:?

Rounded (only applies to rectangles)

The following values are possible:

  • 0 = corners of the rectangle will not be rounded
  • 1 = corners of the rectangle will be rounded.

/radius:?

Arc Radius (only applies to rounded rectangles; fillet radius of the corners)

Numeric values in "mm" or in "In" (Inch)

/transparency:?

Transparency (specifies the transparency of a 3D object in the layout space)

Numerical values from 0.0 to 1.0. A value of 1.0 results in complete transparency (100% transparency). As an alternative you can also enter the value 'bylayer'. This will apply the transparency level as set for the layer.

Parameters for the "XGedIaFormatSymbol" interaction

Parameter

Description

Values

/height:?

Font size

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

/color:?

(Text or line) Color

The predefined values are:

  • 0 = black
  • 1 = red
  • 2 = yellow
  • 3 = green
  • 4 = cyan
  • 5 = blue
  • 6 = magenta
  • 7 = black
  • 8 = white
  • 9 = light gray
  • 252 = dark gray
  • 253 = gray
  • -16002 = from layer.

However, other values can also be specified in the Color selection dialog. Values from 0 to 256 are possible. The color values are displayed in the color selection tooltips.

/justification:?

(Text) Alignment

The following values are possible:

  • 1 = upper left
  • 2 = upper center
  • 3 = upper right
  • 4 = center left
  • 5 = middle centered
  • 6 = center right
  • 7 = bottom left
  • 8 = bottom centered
  • 9 = bottom right
  • 10 = basis left
  • 11 = basis center
  • 12 = basis right
  • 13 = special left
    (special alignment type for path function texts in DIN and USA projects)
  • 14 = special centered
    (should not be used for new projects; needed only for reasons of compatibility with EPLAN 5)
  • 15 = special right
  • 16 = JIC special left
    (special alignment types for path function texts in JIC projects)
  • 17 = JIC special center
    (should not be used for new projects; needed only for reasons of compatibility with EPLAN 5)
  • 18 = JIC special right.

/angle:?

Angle to the X-axis by which the text should be rotated in the counter-clockwise direction.

The following values are possible:

  • 0
  • 45
  • 90
  • 135
  • 180
  • -45
  • -90
  • -135.

Angle specifications are always in degrees. The "°" character need not be specified, but may be.

/font:?

Font

The values for fonts 1-10 can be determined under the Options > Settings > Company > Graphical editing > Fonts menu path. The following values are possible:

  • 0 = Font 1 in the company settings
  • 1 = Font 2 in the company settings
  • 2 = Font 3 in the company settings
  • 3 = Font 4 in the company settings
  • 4 = Font 5 in the company settings
  • 5 = Font 6 in the company settings
  • 6 = Font 7 in the company settings
  • 7 = Font 8 in the company settings
  • 8 = Font 9 in the company settings
  • 9 = Font 10 in the company settings.

/visible:?

Invisible (text or line invisible / visible)

The following values are possible:

  • 0 = invisible
  • 1 = visible.
  • 2 = from layer.

/language:?

Language (as in the Display tab in the Property dialog)

The following values are possible:

  • AllLanguagesColumn = All displayed languages (arrange horizontally)
  • AllLanguagesRow = All displayed languages (arrange vertically)
  • OneLanguageVariable = One language (variable)
  • 'de_DE', 'en_US', ... = Specify the language

/bold:?

Font style / Bold

The following values are possible:

  • 0 = normal
  • 1 = bold.

/italic:?

Font style / Italic

The following values are possible:

  • 0 = normal
  • 1 = italic.

/underline:?

Font style / Underlined

The following values are possible:

  • 0 = normal
  • 1 = underlined.

/showtextbox:?

Draw text box

The following values are possible:

  • 0 = don't show text box
  • 1 = show text box as rectangle
  • 2 = show text box as ellipse
  • 3 = from layer.

/sizefromsettings:?

Size from project setting

The following values are possible:

  • 0 = switched off
  • 1 = switched on.

/leaderline:?

Activate leader line

The following values are possible:

  • 0 = switched off
  • 1 = switched on.

/setframeactive:?

Activate alignment box

The following values are possible:

  • 0 = deactivate settings for alignment box
  • 1 = activate settings for alignment box.

/showframe:?

Draw alignment box

The following values are possible:

  • 0 = don't show alignment box
  • 1 = show alignment box.

/framewidth:?

Width of the alignment box

Numeric values in "mm" or in "In" (Inch)

/frameheight:?

Height of the alignment box

Numeric values in "mm" or in "In" (Inch)

/adjustframe:?

Fit to alignment box

The following values are possible:

  • 1 = don't fit
  • 16 = Text: Fixed width, never hyphenate words
  • 32 = Text: Fixed height, never hyphenate words
  • 64 = Hyphenate words
  • 80 = Text: Fixed width, hyphenate words
  • 128 = Remove breaks
  • 144 = Text: Fixed width, never hyphenate words, remove breaks
  • 208 = Text: Fixed width, hyphenate words, remove breaks.

/propertyId:?

Identifier of a component property to be defined (= Property number).

  • If this parameter is used, all format modifications are only performed for the property texts of the one specified property of the component.
  • If this parameter is not used, the format modifications are performed for the property texts of all placed properties.

5-digit number

/propertyIndex:?

The index, if the property has indices; usually 0

/linespacing:?

Row spacing

Numeric values. The value "1" corresponds, e.g., to single row spacing, value "2" is double spacing, etc.

/paragraphspacing:?

Paragraph spacing

Numeric values in "mm" or in "In" (Inch)

/layer:?

Layer

Layer name (e.g. "EPLAN501")

Parameters for the "XGedIaFormatText" interaction

Parameter

Description

Values

/height:?

Font size

Numeric values in "mm" or in "In" (Inch). With the value "-16002", the "From layer" setting will be applied.

/color:?

(Text or line) Color

The predefined values are:

  • 0 = black
  • 1 = red
  • 2 = yellow
  • 3 = green
  • 4 = cyan
  • 5 = blue
  • 6 = magenta
  • 7 = black
  • 8 = white
  • 9 = light gray
  • 252 = dark gray
  • 253 = gray
  • -16002 = from layer.

However, other values can also be specified in the Color selection dialog. Values from 0 to 256 are possible. The color values are displayed in the color selection tooltips.

/justification:?

(Text) Alignment

The following values are possible:

  • 1 = upper left
  • 2 = upper center
  • 3 = upper right
  • 4 = center left
  • 5 = middle centered
  • 6 = center right
  • 7 = bottom left
  • 8 = bottom centered
  • 9 = bottom right
  • 10 = basis left
  • 11 = basis center
  • 12 = basis right
  • 13 = special left
    (special alignment type for path function texts in DIN and USA projects)
  • 14 = special centered
    (should not be used for new projects; needed only for reasons of compatibility with EPLAN 5)
  • 15 = special right
  • 16 = JIC special left
    (special alignment types for path function texts in JIC projects)
  • 17 = JIC special center
    (should not be used for new projects; needed only for reasons of compatibility with EPLAN 5)
  • 18 = JIC special right.

/angle:?

Angle to the X-axis by which the text should be rotated in the counter-clockwise direction.

The following values are possible:

  • 0
  • 45
  • 90
  • 135
  • 180
  • -45
  • -90
  • -135.

Angle specifications are always in degrees. The "°" character need not be specified, but may be.

/font:?

Font

The values for fonts 1-10 can be determined under the Options > Settings > Company > Graphical editing > Fonts menu path. The following values are possible:

  • 0 = Font 1 in the company settings
  • 1 = Font 2 in the company settings
  • 2 = Font 3 in the company settings
  • 3 = Font 4 in the company settings
  • 4 = Font 5 in the company settings
  • 5 = Font 6 in the company settings
  • 6 = Font 7 in the company settings
  • 7 = Font 8 in the company settings
  • 8 = Font 9 in the company settings
  • 9 = Font 10 in the company settings.

/visible:?

Invisible (text or line invisible / visible)

The following values are possible:

  • 0 = invisible
  • 1 = visible.
  • 2 = from layer.

/language:?

Language (as in the Format tab in the Properties dialog)

The following values are possible:

  • AllLanguagesColumn = All displayed languages (arrange horizontally)
  • AllLanguagesRow = All displayed languages (arrange vertically)
  • OneLanguageVariable = One language (variable)
  • 'de_DE', 'en_US', ... = Specify the language

/bold:?

Font style / Bold

The following values are possible:

  • 0 = normal
  • 1 = bold.

/italic:?

Font style / Italic

The following values are possible:

  • 0 = normal
  • 1 = italic.

/underline:?

Font style / Underlined

The following values are possible:

  • 0 = normal
  • 1 = underlined.

/showtextbox:?

Draw text box

The following values are possible:

  • 0 = don't show text box
  • 1 = show text box as rectangle
  • 2 = show text box as ellipse
  • 3 = from layer.

/sizefromsettings:?

Size from project setting

The following values are possible:

  • 0 = switched off
  • 1 = switched on.

/leaderline:?

Activate leader line

The following values are possible:

  • 0 = switched off
  • 1 = switched on.

/setframeactive:?

Activate alignment box

The following values are possible:

  • 0 = deactivate settings for alignment box
  • 1 = activate settings for alignment box.

/showframe:?

Draw alignment box

The following values are possible:

  • 0 = don't show alignment box
  • 1 = show alignment box.

/framewidth:?

Width of the alignment box

Numeric values in "mm" or in "In" (Inch)

/frameheight:?

Height of the alignment box

Numeric values in "mm" or in "In" (Inch)

/adjustframe:?

Fit to alignment box

The following values are possible:

  • 1 = don't fit
  • 16 = Text: Fixed width, never hyphenate words
  • 32 = Text: Fixed height, never hyphenate words
  • 64 = Hyphenate words
  • 80 = Text: Fixed width, hyphenate words
  • 128 = Remove breaks
  • 144 = Text: Fixed width, never hyphenate words, remove breaks
  • 208 = Text: Fixed width, hyphenate words, remove breaks.

/donttranslate:?

Do not translate automatically (as in the Text tab in the Property dialog)

The following values are possible:

  • 1 = Text is not automatically translated.
  • 0 = Text is translated.

/linespacing:?

Row spacing

Numeric values. The value "1" corresponds, e.g., to single row spacing, value "2" is double spacing, etc.

/layer:?

Layer

Layer name (e.g. "EPLAN501")

Parameters for the "XMIaInsertMacro" interaction

Parameter

Description

Values

/filename:?

Name of the macro to be inserted. If no value is specified for the parameter, a dialog for selecting macros opens.

/variant:?

Variant of the macro to be inserted 

The following values are possible:

  • 0 = variant A
  • 1 = variant B
  • 2 = variant C
  • 3 = variant D
  • 4 = variant E
  • 5 = variant F
  • 6 = variant G
  • 7 = variant H
  • 8 = variant I
  • 9 = variant J
  • 10 = variant K
  • 11 = variant L
  • 12 = variant M
  • 13 = variant N
  • 14 = variant O
  • 15 = variant P.

/RepresentationType:?

Representation type of the macro to be inserted

The following values are possible:

  • 1 = Multi-line
  • 2 = Single-line
  • 3 = Pair cross-reference
  • 4 = Overview
  • 5 = Graphic
  • 6 = Panel layout
  • 7 = P&I diagram
  • 8 = Multi-line Fluid
  • 9 = Topology
  • 10 = 3D mounting layout
  • 11 = Functional.

See also