Parameters for Labels

Parameters set or read by ARCHICAD

The following set of label parameters were all introduced in ARCHICAD 22, so the parallel global variables are considered deprecated. See Deprecated Label Globals section for the full list of out-of-date label globals.

Starting from ARCHICAD 22, the locking/hiding of the corresponding ARCHICAD interface controls (if exist) is an option by using LOCK and HIDEPARAMETER commands via the parameter script of the library part, combined with “Enable hide/lock of specific fix named optional parameters” setting (see “Details/Compatibility Options” dialog of the object in the Library Part Editor).

AC_bLabelAlwaysReadable boolean
1 – “Always Readable” is checked on “Label Settings/Text Style” panel, 0 otherwise
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_ALWAYS_READABLE” is considered deprecated since ARCHICAD 22.
AC_bLabelTextWrap boolean
1 – “Wrap Text” is checked on “Label Settings/Text Style” panel, 0 otherwise
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_TEXT_WRAP” is considered deprecated since ARCHICAD 22.
AC_bLabelOpaqueFill boolean
1 – “Opaque” is checked on “Label Settings/Text Style” panel, 0 otherwise
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_TEXT_BG_PEN” is considered deprecated since ARCHICAD 22.
AC_LabelTextBgrPen integer
Contains the index of the selected Text Fill Pen.
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_TEXT_BG_PEN” is considered deprecated since ARCHICAD 22.
AC_bLabelFrame boolean
Defines whether the Frame is turned on
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_FRAME_ON” is considered deprecated since ARCHICAD 22.
AC_LabelFrameOffset integer
Frame offset value according to “Label Settings/Text Style” panel.
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_FRAME_OFFSET” is considered deprecated since ARCHICAD 22.
AC_LabelPointerPen integer
Contains the index of the selected Pointer Line Pen.
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_ARROW_PEN” is considered deprecated since ARCHICAD 22.
AC_LabelPointerLineType integer
Contains the index of the selected Pointer Line Type.
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_ARROW_LINETYPE” is considered deprecated since ARCHICAD 22.
AC_LabelPointerConnection integer
Pointer connection position.
0 – middle, 1 – top, 2 – bottom, 3 – bottom right
Compatibility: introduced in ARCHICAD 22. The similar global variable “LABEL_ANCHOR_POS” is considered deprecated since ARCHICAD 22.
AC_LabelOrientation integer
Label orientation type value of “Label Orientation” settings in “Symbol Label” panel. “LABEL_ROTANGLE” value may change according to orientation settings.
1 – parallel, 2 – perpendicular, 3 – vertical, 4 – horizontal, 5 – custom angle
Compatibility: introduced in ARCHICAD 22.
Extended LOCK/HIDEPARAMETER feature is not available for this parameter. Masking of the corresponding interface control values is set by “AC_DisableLabelOrientationVal”. The parameter defines the library part default value.

Parameters read by ARCHICAD

AC_DisableLabelOrientationVal integer
Label orientation (“AC_LabelOrientation) type value mask.
bitset: Disable the following options in “Symbol Label” dialog panel for “Label Orientation”:
bitset = j1 + 2*j2 + 4*j3 + 8*j4, where each j can be 0 or 1.
j1: “Parallel”,
j2: “Perpendicular”,
j3: “Vertical”,
j4: “Horizontal”.
“Custom” type cannot be disabled.
Compatibility: introduced in ARCHICAD 22.
ac_bDisableLabelFrameDisplay boolean
Compatibility: introduced in ARCHICAD 20
Hides the built-in rectangular frame drawing around the Label Symbol in case of the built-in Pointer and Frame is set, enabling the user to script custom shaped frame.
ac_bCustomPointerConnection boolean
Compatibility: introduced in ARCHICAD 20
Controls the automatic Pointer Connections of the Label Symbol in case of the built-in Pointer is set. If this parameter is set to ON, 6 hotspots can be defined in the 2D script for the custom pointer connection in accordance with the built-in types.
These hotspots should have fix ID-s from 1 to 6. The ID’s indicate the following connection positions:
if the Pointer is on the left side of the Label Symbol:

  • 1: left top connection
  • 3: left middle connection
  • 5: left bottom connection
  • 6: right bottom connection

if the Pointer is on the right side of the Label Symbol:

  • 2: right top connection
  • 4: right middle connection
  • 6: right bottom connection
  • 5: left bottom connection

FOP_LabelPointerPos
FOP_LabelHotspots

The hostpot positions must be symmetrical to the vertical axis of the label symbol to support auto position snap (left-right direction).