• ListingParameters

Contents

---

Element Type

Type: string
Possible values:see list below
Returns a string stating the type of the element being listed.
The possible values are the following: Wall, Column, Beam, Window, Door, Slab, Roof, Object, Lamp, Mesh, Fill.
Note: in the list these string are usually displayed in all CAPITALS.

The eleven Element types that can be listed.

View Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw the contours of the element in views (not the contours of cut surfaces) as defined in the Settings Dialog of the element.
Note: since a Fill is not a 3D element, this parameter returns no value in case of a Fill.

Section Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen used to draw the contours of the cut surfaces of the element in Section/Elevation Windows as defined in the Settings Dialog of the element.
Note: in case of Fills the index number of the pen used to draw the contour of the Fill in the Floor Plan Window is returned.

Composite Section Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the contours of each skin of the composite structure of the element (Wall, Slab or Roof) as defined in the Composite Structures Dialog or the Settings Dialog of the element.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof.
Here is how it works: if the ‘Use Line & Fill Colors of Composite’ checkbox is not checked in the Wall/Slab/Roof Settings Dialog then one pen index number is returned several times. This is the index number of the pen used to draw the fill pattern of the Wall/Slab/Roof in section. The reason is because this is the pen used for all the fills and contours of all skins of the composite.

The field (above) returned in the list when ‘Composite Section Pens’ is used in the case the ‘ Use Line & Fill Colors of Composite’ checkbox (below) is not checked.

If the ‘Use Line & Fill Colors of Composite’ checkbox is checked then the index numbers of the pens defined for each skin contour of the composite are returned.

The field in the Composite Structures Dialog returned in the list under ‘Composite Section Pens’ when the ‘Use Line & Fill Colors of Composite’ checkbox is checked in the element’s Settings Dialog

Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number for top skin of the composite structure first, second top skin second and so on).

Line Type

Type: string
Possible length: max. 31 characters
Returns in a string the name of the line type used to draw the element in the Floor Plan Window (e.g. ‘Solid Line” or ‘Dot & Dashed’) as set in the element’s Settings Dialog.
Note: In case of Beams it returns the name of the line type used to draw the contours of the Beam (and not the one for its axis).

Values returned in a list under the heading of ‘Line Type’

Fill Name / Composite Name

Type: string
Possible length: max. 31 characters
Returns in a string the name of the simple Fill (such as ‘solid fill’ or ‘roof, insulated’) or the name of the Composite Structure (in case of Walls, Slabs and Roofs) assigned to the element. This Fill or Composite will be used in the Section/Elevation Windows and/or in the Floor Plan Window (for Walls, Columns and Fills).
Note: in case of Columns it returns the Fill assigned to the Column core (the Fill assigned to the veneer is not returned).

Composite Fill Names

Type: string
Possible length: max. 31 characters
Returns in strings the names of the Fills used for each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many Fill names as the number of skins in the composite structure used for that Wall/Slab/Roof. In case of other types of elements one Fill name is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Name’.
Note: the Fill names are returned from top to bottom as defined in the Composite Structures Dialog (Fill for top skin of the composite structure first, Fill for second top skin second and so on).

The values returned in a list under ‘Composite Fill Names’

Fill Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen assigned to draw the fill pattern of the cut surfaces of the element in the Section/Elevation Windows.
Note: in case of Column the Fill assigned to draw the fill pattern of the core is returned (the Fill of the veneer is not). In case of Walls/Slabs/Roofs the default Fill pen index assigned to the section of the element in the Settings Dialog is returned regardless of whether the ‘Use Fill Colors of Composite’ checkbox is checked or not. In case of Fills the index number of the pen used to draw the fill pattern of the Fill in the Floor Plan Window is returned (since it is not a 3D element).

Composite Fill Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the fill pattern of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof. Just as in the case of ‘Composite Section Pens’ the pen index values defined in the Composite Structures Dialog are used when the ‘Use Fill Colors of Composite’ checkbox is checked in the Wall/Slab/Roof Settings Dialog. Otherwise the values set in the elements’ Dialog are returned. In case of other types of elements one pen index number is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Pen’.
Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number of fill of top skin of the composite structure first, pen index number of second top skin second and so on).

The values returned in a list under ‘Composite Fill Pens’ (‘Use Line & Fill Colors of Composite’ is checked in the Wall Settings Dialog).

Fill Background Pen

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index number of the pen assigned to draw the background of the fill pattern of the cut surfaces of the element in the Section/Elevation Windows.
Note: in case of Column the Fill assigned to draw the background of the fill pattern of the core is returned (the fill background pen of the veneer is not). In case of Walls/Slabs/Roofs the index of the default fill background pen assigned to the section of the element in the Settings Dialog is returned regardless of whether the ‘Use Background Colors of Composite’ checkbox is checked or not. In case of Fills the index number of the pen used to draw the background of the fill pattern of the Fill in the Floor Plan Window is returned (since it is not a 3D element).

Composite Fill Background Pens

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns the index numbers of the pens used to draw the background of the fill pattern of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many pen index numbers as the number of skins in the composite structure used for that Wall/Slab/Roof. The pen index values defined in the Composite Structures Dialog are used when the ‘Use Background Colors of Composite’ checkbox is checked in the Wall/Slab/Roof Settings Dialog. Otherwise the values set in the elements’ Dialog are returned. In case of other types of elements one pen index number is returned (since they are assigned a single Fill) and it is the same string as the one returned under ‘Fill Background Pen’.
Note: the pen index numbers are returned from top to bottom as defined in the Composite Structures Dialog (pen index number of fill background of top skin of the composite structure first, pen index number of second top skin second and so on).

The values returned in a list under ‘Composite Fill Background Pens’ (‘Use Background Colors of Composite’ is checked in the Wall Settings Dialog).

Material

Type: string
Possible length: max. 31 characters
Returns in strings the names of materials (such as ‘Whitewash’ or ‘Plaster, smooth’) assigned to various surfaces of the element as seen in the 3D Window. For each element as many material names will be returned as the total number of materials definable in the Settings Dialog of that element. The following table shows the number of materials returned in case of each element type and the order in which they are returned:

Note: no material is returned for a Fill since it is not a 3D-element type. In case of Mesh all three materials are returned even in case the Mesh doesn’t actually have a skirt and/or a bottom as set in its Settings Dialog.

The values returned in a list under ‘Material’

Layer Name

Type: string
Possible length: max. 31 characters
Returns in a string the name of the layer (such as ‘ArchiCAD’ or ‘Exterior walls’) the element is assigned to appear on.
Note: no value is returned in case of Doors/Windows since they are always assigned to the layer of the Wall they as placed into.

The values returned in a list under ‘Layer Name’, “User ID’ and ‘Internal ID’

User ID

Type: string
Possible length: max. 15 characters
Returns in a string the User ID assigned to the element as set in the Listing Attributes portion of its Settings Dialog.

Internal ID

Type: numerical (positive integer value)
Possible range: 1 and up
Returns the number internally assigned to each created element by ArchiCAD. This is a unique ID in case of each and every element and can not be modified.

Surface

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the size of the various surfaces of each element. The surface sizes are returned in the order stated at ‘Material’ in this writing.
Notes: in case of Meshes, when no bottom surface/skirt is present as set in its Settings Dialog, zero is returned for the surfaces of these. In case of Library Parts, zero is returned if the Library Part has no such 3D parts generated which can have a 3D surface size. In case of Fills the area of the Fill in the Floor Plan Window is returned. In case of Roofs the calculated surfaces are the slanted surfaces not the areas of the Roof surface projected to the horizontal plane). In case of Walls the surface area of Windows/Doors/holes is deducted from the full surface of the Wall if they are larger then the value set in the List Setup Dialog. In case of other elements containing holes all surface areas of holes are deducted.

The field in the List Setup Dialog where you can set how large a Wall opening must be to be deducted from the Wall’s surface/volume in lists

Volume

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns in numerical form the volume of each element.
Note: in case of Meshes, when no bottom surface/skirt is present as set in its Settings Dialog, zero is returned for the volume of these. In case of Library Parts, zero is returned if the Library Part has no such 3D parts generated which can have a 3D surface size. In case of Fills no value returned since it is not a 3D element so this category doesn’t apply.
In case of Walls – similarly to ‘Surface’ - the volume of Windows/Doors/holes is deducted from the total volume of the Wall if they are larger then the value set in the List Setup Dialog. In case of other elements containing holes all volumes of holes are deducted.

Composite Volumes

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the volumes of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog.
Checking this checkbox will return for each Wall, Slab or Roof in the list as many volumes as the number of skins in the composite structure used for that Wall/Slab/Roof. If you add up the volumes returned you will get the number returned under ‘Volume’ (the total volume of the Wall/Slab/Roof). In case of other types of elements one volume amount is returned and it is the same value as the one returned under ‘Volume’.
Note: the volumes are returned from top to bottom as defined in the Composite Structures Dialog (volume for top skin of the composite structure first, volume for second top skin second and so on). Hole volumes are deducted the same way as in case of ‘Volume’.

Thickness/Size

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns either one or two numbers for each element giving information about the thickness or x-y size of the element. The following table shows which measurements the parameter returns in case of each element type:

Note: if the Mesh is only a surface zero is returned by this parameter. In case of Fills no value is returned as it is not a 3D element.

The values returned in a list under ‘Thickness-Size’

Composite Thicknesses

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the thickness of each skin of the composite structure of the element (Wall, Slab or Roof) as they are defined in the Composite Structures Dialog. Checking this checkbox will return for each Wall, Slab or Roof in the list as many thickness values as the number of skins in the composite structure used for that Wall/Slab/Roof. If you add up the thicknesses returned you get the number returned under ‘Thickness/Size’ (the total thickness of the Wall/Slab/Roof). In case of other types of elements one or two thickness amounts are returned and are the same values as the ones returned under ‘Thickness/Size’.
Note: the thicknesses are returned from top to bottom as defined in the Composite Structures Dialog (thickness for top skin of the composite structure first, thickness for second top skin second and so on).

Height

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the height of the element.
Note: in case of Fills the parameter returns zero as it is not a 3D element. In case of Slabs, Roofs and Meshes the parameter returns zero, as these element types do not have a ‘height’ (they have a thickness). In case of Objects/Lamps it returns zero unless a ‘zzyzx’ variable is defined for the Object/Lamp in its Library Part Editor as the first parameter in which case the height field appears in its Settings Dialog and can be set to a value other than zero.

The values returned in a list under ‘Height’

Library Part Name

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Library Part type element.
Note: The parameter returns a valid string in case of Doors, Windows Objects and Lamps. In case of all other elements this parameter doesn’t apply.

The values returned in a list under ‘Library Part Name’

Associated Property Object

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Property Object that was individually linked to the element in the ‘Listing Attributes’ tab page of the element’s Settings Dialog.

The field in an element’s Settings Dialog where the Property Object can be linked to the element.

The values returned in a list under ‘Associated Property Object’

Property Part(s) by Criteria

Type: string
Possible length: max. 27 characters
Returns in string the names of those Property Objects that were linked to the element automatically by the program because they fulfilled certain selection criteria. The list of these is shown on ‘Listing Attributes’ tab page of the element’s Settings Dialog.

The values returned in a list under ‘Property Part(s) by Criteria’

Base Elevation

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the base elevation of the element relative to the elevation of the story the element is placed on.
Note: this means different things in case of various element types. In case of Walls and Columns it means the elevation of the bottom surface of the element. In case of Beams and Slabs it means the elevation of the top surface of the element. In case of Doors and Windows it means the elevation of the bottom of the Door/Window relative to the Wall they are placed into. In case the Door/Window has dimensions, the ‘Subfloor thickness’ value of the Door/Window Dimension Subdialog can modify this value. In case of Roof it means the elevation of the pivot line of the Roof. In case of Objects and Lamps it is the elevation of the Object/Lamp’s local origin. For a Mesh it is the elevation of the top of the Mesh’s skirt. For Fills it is always zero because it is not a 3D element.

The values returned in a list under ‘Base Elevation’

Associated Label

Type: string
Possible length: approx. 30000 characters
Returns in a string the text of the Label associated with the element. It returns a valid string if ‘Text’, ‘ID’ or Internal ID’ is selected for Label Content in the top of the Label Settings Dialog. It returns no value if any other Label object is selected. The returned string will be the string generated by ArchiCAD (with ‘ID’ or ‘Internal ID’) or typed by the user (with ’Text’).

Associated Label Object

Type: string
Possible length: max. 27 characters
Returns in a string the name of the Label Object that has been associated with the element. It returns no value when ‘Text’, ‘ID’ or Internal ID’ is selected for Label Content in the top of the Label Settings Dialog.

The values returned in a list under ‘Associated Label’ and ‘Associated Label Object’

Zone Category Code

Type: string
Possible length: max. 31 characters
Returns in a string the category code (such as ‘2 HNF’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.

The values returned in a list under ‘Zone Category Code’, ‘Zone Category Name’, ‘Zone Name’ and ‘Zone Number’

Zone Category Name

Type: string
Possible length: max. 31 characters
Returns in a string the category name (such as ‘2 Office’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.

Zone Name

Type: string
Possible length: max. 31 characters
Returns in a string the name (such as ‘Living Room’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.

Zone Number

Type: string
Possible length: max. 31 characters
Returns in a string the number (such as ‘001’) of the Zone in which the element type is located as they are defined in the Zone Categories Dialog. The parameter returns a valid string for Columns, Beams, Objects and Lamps, maximum two strings for Walls, Doors and Windows.

Split Zone Number 1/ Split Zone Number 2/ Split Zone Number 3/ Split Zone Number 4

Type: string
Possible range: the total length of all 4 variable added together (with the 3 dots in between) is max. 31 characters
A Zone Number can be set in such a way that it is composed of a maximum of 4 numbers (or strings for that matter) separated by dots (‘.’) and these be used to express relationships between Zones and the Project itself. For example, “B.C.06.45” might mean Room 45 on Story 6 in Wing ‘C’ of Building ‘B’. These four listing parameters return for each Zone the first, second, third and fourth portion, respectively, of such a Zone Number. These four listing parameters return for each Wall, Column, Window/Door, Object or Lamp the first, second, third and fourth portion of such a Zone Number (‘B’, ‘C’, ‘06’ and ‘45’, respectively) of that Zone located next to them (for Walls, Windows/Doors) or in which they are located (for Columns, Objects and Lamps).

Story Index

Type: numerical (integer value)
Possible range: approx. -15000 – approx. 15000
Returns a number corresponding to the index of the Story the element is placed on.
Note: in case of Doors/Windows the same Story Index will be returned as that of the Wall into which they are placed.

The values returned in a list under ‘Story Index’ and ‘Story Name’

Story Name

Type: string
Possible length: max. 25 characters
Returns in a string the name of the Story the element is placed on.
Note: in case of Doors/Windows the same Story Name will be returned as that of the Wall into which they are placed.

Extra Parameters of the Selected Types:

Sill of the Window/Door

Type: numerical (real value)
Possible range: positive, negative or zero (in meters)
Returns the sill depth of Window/Door as was set in their Settings Dialog. If the Window/Door has a reveal the parameter will return the Reveal Depth value.
Note: the value can be even negative which means the body of the Window/Door can be outside the body of the Wall enclosing them.

The value returned in a list under ‘Sill of the Window/Door’

Window/Door jamb on the left side/ Window/Door jamb on the right side

Type: numerical (positive value)
Possible range: zero and up (in meters)
These two parameters return in the list the width of jamb on the left side and right side of the Window/Door, respectively. These are the values set in the Reveal Setup Subdialog of the Window/Door Settings Dialog (‘Jamb Depth 2’ for the left side and ‘Jamb Depth’ for the right).
Note: the parameters return these values even if no reveal is set for the Windows/Doors.

The values returned in a list under ‘Window/Door jamb on the left side’ and ‘Window/Door jamb on the right side’

Window/door sill/threshold depth

Type: numerical (positive value)
Possible range: zero and up (in meters)
This parameter returns in the list the depth (height) of the sill/threshold of the Window/Door. This value is set in the ‘Sill/Threshold Depth’ field of the Reveal Setup Subdialog of the Window/Door Settings Dialog.

Window/door head depth

Type: numerical (positive value)
Possible range: zero and up (in meters)
This parameter returns in the list the depth (height) of the head of the Window/Door as set in the ‘Sill/Threshold Depth’ field of the Reveal Setup Subdialog of the Window/Door Settings Dialog.

The values returned in a list under ‘Window/door sill/threshold depth’ and ‘Window/door head depth’

Reveal side is opposite to the opening side

Type: numerical (integer)
Possible values: 0 or 1
Returns in the list a number corresponding to state of the Window/Door as regards to the location of its reveal side relative to its opening side. It reflects changes caused by checking the ‘Flip’ checkbox in the Window/Door Settings Dialog. ‘0’ is returned when the reveal side is the same as the opening side (Window/Door is not flipped) and ‘1’ is returned when it is not the same side (its side is opposite to it).

The values returned in a list under ‘Reveal side is opposite to opening side’

Frame thickness of window/door

Type: numerical (real value)
Possible range: any value (in meters)
Returns the nominal thickness of the Window/Door frame. This value can be set in the ‘Nominal Frame Thickness’ field in the Details Subdialog of the Library Part Editor when a Window/Door is open for editing. For most ArchiCAD Library Objects the ‘frame depth’ or ‘frame thickness’ parameter of the Window/Door is returned by this value.
Note: the value returned can be negative as well meaning the body of the Window/Door extends toward the opposite direction.

The values returned in a list under ‘Frame thickness of window/door’

Offset of the door/window

Type: numerical (real value – in case of straight walls; angle value in case of curved walls)
Possible range: -[Door/Window size]/2 and up in case of straight walls (in meters); approx. -360.0000° – approx. 360.0000° in case of curved walls
Returns the offset value of the axis of the Door/Window relative to the normal vector of its enclosing wall projecting at the starting point of the wall. With straight walls this is a distance and with curved walls it is an angle value.

Window/door opening orientation

Type: string
Possible length: max. 31 characters
Returns in the list a string corresponding to the orientation of the Window/Door (L – left, R – right, or any other custom value). This value can be set in the ‘Orientation Displaying’ portion of the Details Subdialog of the Library Part Editor when a Window/Door is open for editing.

The values returned in a list under ‘Offset of the door/window’ and ‘Window/door opening orientation’

Window/door marker text

Type: string
Possible length: max. 3 characters
Returns in the list the marker text of the dimension of the Window/Door as set in the Window/Door Dimension Settings Subdialog accessible from the Door/Window Settings Dialog.

The values returned in a list under ‘Window/door marker text’, ‘Subfloor thickness (sill correction)’ and ‘Window/door sill height prefix’

Subfloor thickness (sill correction)

Type: numerical (positive value)
Possible range: 0 or up (in meters)
Returns in the list the subfloor thickness (sill correction value) of the Window/Door as set in the Window/Door Dimension Subdialog of the Door/Window Settings Dialog. The parapet height of the Window/Door is decreased by this value to give the final Window/Door sill height.

Window/door sill height prefix

Type: string
Possible length: max. 7 characters
Returns the string that is used as a prefix when the sill height of the Window/Door is displayed in its dimensioning. It can be set in the Window/Door Dimension Subdialog of the Window/Door Settings Dialog.

Distance of the local origin from the end of the wall

Type: numerical (real value)
Possible range: positive, negative or 0 (in meters)
Returns the distance of the center point of the curved Wall into which the Door/Window was placed from the local origin of the Door/Window. Since the variable applies only to curved walls, when the Door/Window is placed into a straight wall the returned value is 0.
The direction of the plus (+) range of the Window/Door’s local origin changes with the opening direction of the Door which is defined at the time of its placement. Depending on this the variable returns positive or negative values.

The values returned in a list under ‘Distance of the local origin from the end of the wall’ and ‘Parapet wall inset’

Parapet wall inset

Type: numerical (real value)
Possible range: any value (in meters)
Returns the distance by which the parapet wall is set in (or set back) from the outer surface of the Wall in case a parapet wall is present. The parapet wall is a small wall just below the Window/Door and is usually less in width than the Wall it is part of and into which the Window/Door is placed.

User ID of the wall

Type: string
Possible length: max. 15 characters
Returns in a string the user ID of the Wall into which the Window/Door is placed as it was set in the Wall Settings Dialog box or automatically generated for the Wall by the program.

The values returned in a list under ‘User ID of the wall’ and ‘Internal ID of the wall’

Internal ID of the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns a number that is the internal ID number of the Wall into which the Window/Door was placed. This number is automatically generated and internally used by ArchiCAD. It can not be changed.

Thickness of the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns in the list the thickness of the Wall into which the Window/Door was placed as it was set in the Wall Settings Dialog box. In the case of inclined Walls the thickness of the inclined Wall at the centerline of the Window/Door is returned. It is measured perpendicularly to the reference line of the Wall

The values returned in a list under ‘Thickness of the wall’ and ‘Inclination of the wall surfaces’

Inclination of the wall surfaces

Type: numerical (angle value)
Possible range: -90.0000º – 90.0000º
Returns the angle at which the Wall inclines. A valid value is returned for both Walls themselves and for Windows/Doors as well (the value for the Wall into which they are placed). As a rule, the returned angle value is positive if the thickness at the end of the Wall is larger than its thickness at its beginning. In the reverse case the returned value is negative. For straight and curved Walls the returned value is ‘0’.

Height of the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the height of the Wall into which the Window/Door is placed as set in the Wall Settings Dialog box.

The values returned in a list under ‘Height of the wall’, ‘3D resolution of a curved wall’ and ‘Direction of the wall’

3D resolution of a curved wall

Type: numerical (positive integer value)
Possible range: 3 and up
Returns the resolution of the Wall at which it is drawn in the 3D Window. A valid value is returned for both Walls themselves and for Windows/Doors as well (the value for the Wall into which they are placed). For straight and inclined Walls the default value of 36 is returned.

Direction of the wall

Type: numerical (angle value)
Possible range: 0.0000º – 359.9999º
Returns the direction of the reference line of the Wall or the reference line of the Wall into which the Window/Door is placed relative to the horizontal direction (positive direction goes counter-clockwise). The direction goes from the starting point of the reference line to its ending point. If the Window/Door is placed into a curved Wall the direction of the tangent of the Wall at the half of the Wall will be returned.

Length of the wall on the reference line side

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the Wall on the reference side of the Wall.
Note: unlike in the case of previous listing parameters, this parameter doesn’t return a value for Windows/Doors (information about their enclosing Walls).

The values returned in a list under ‘Length of the wall on the reference line side’ and ‘Length of the wall on the side opposite to the reference line’

Length of the wall on the side opposite to the reference line

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the Wall on its side that is opposite to its reference side.
Note: unlike in the case of previous listing parameters, this parameter doesn’t return a value for Windows/Doors (information about their enclosing Walls).

No. of doors in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Door openings/Doors placed into the Wall.

The values returned in a list under ‘No. of doors in the wall’, ‘No. of windows in the wall’ and ‘No. of empty openings’

No. of windows in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Window openings/Windows placed into the Wall.

No. of empty openings

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of empty openings placed into the Wall.

Surface of doors in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Doors that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Doors into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.

The values returned in a list under ‘Surface of doors in the wall’, ‘Surface of windows in the wall’ and ‘Surface of empty openings in the wall’

Surface of windows in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Windows that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Windows into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.

Surface of empty openings in the wall

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all Doors that are placed into the Wall. This is the area by which the surface of the Wall is reduced on its sides by reason of placement of Doors into it.
Note: the surface area of each opening is counted only if it is larger than the area limit that can be set for Wall openings in the Setup List Schemes Dialog.

Combined width of the windows in the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total of the nominal widths of all Windows that are placed into the Wall.
Note: the widths of empty Window openings are not added to the value as these are listed as ‘empty openings’.

The values returned in a list under ‘Combined width of the windows in the wall’ and ‘Combined width of the doors in the wall’

Combined width of the doors in the wall

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the total of the nominal widths of all Doors that are placed into the Wall.
Note: the widths of empty Door openings are not added to the value as these are listed as ‘empty openings’.

No. of columns in the wall

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Wall the total number of Columns that are placed into that Wall.

The values returned in a list under ‘No. of columns in the wall’

Thickness of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns for each Column in the list the thickness of the Column veneer as it was set in the Column Settings Dialog.

The values returned in a list under ‘Thickness of the veneer’, ‘Fill of the veneer’ and ‘Pen of the veneer fill’

Fill of the veneer

Type: string
Possible length: max. 31 characters
Returns for each Column the name of the Fill that is assigned to the Floor Plan and Section cut surfaces of the veneer as it was set in the Column Settings Dialog.

Pen of the veneer fill

Type: numerical (positive integer value)
Possible range: 1 – 255
Returns for each Column the index number of the pen with which the fill pattern of the fill assigned to the veneer is drawn as it was set in the Column Settings Dialog.

Pen of the veneer fill background

Type: numerical (positive integer value)
Possible range: 0 – 255
Returns for each Column the index number of the pen with which the background of the fill pattern of the fill assigned to the veneer is drawn as it was set in the Column Settings Dialog. 0 can be returned as a value meaning that it is a transparent fill background.

The values returned in a list under ‘Pen of the veneer fill background’, ‘Surface of the veneer’ and ‘Volume of the veneer’

Surface of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns the total surface area of all four outer sides of the veneer of the Column.
Note: placing a Column into a Wall does not change the value returned by this listing parameter.

Volume of the veneer

Type: numerical (positive value)
Possible range: 0 and up (in cubic meters)
Returns the volume of the veneer part of the Column.
Note: placing a Column into a Wall does not change the value returned by this listing parameter.

Beam Reference Line Offset

Type: numerical (real value)
Possible range: any value (in meters)
Returns for each Beam the offset of its reference line. This is the perpendicular distance between the reference line of the Beam and its axis. If – when looking at the Beam from the starting point of its reference line toward its ending point – the Beam extends to the right side of its reference line the returned value is negative, if it extends to the left the returned value is negative.

The values returned in a list under ‘Beam Reference Line Offset’, ‘Beam to Beam Priority Number’ and ‘Beam Reference Line Direction’

Beam to Beam Priority Number

Type: numerical (positive odd integer value)
Possible values: 4300, 4500, 4700, 4900, 5100, 5300, 5500 and 5700
Returns for each Beam a number that will determine which Beam takes precedence when generating intersections between Beams in 3D. The Beam with the higher priority number will cut into the body of the Beam will a lower number. In the Beam Settings Dialog you can set odd numbers between 1 and 15. The above values are calculated with the following formula:

Beam-to-Beam Priority= 4200 + Number*100

So in case of 7, it will return 4900 and so on.
Note: this number determines only Beam-to-Beam priority. Wall/Column-to-Beam priority is set somewhere else.

Beam Reference Line Direction

Type: numerical (angle value)
Possible range: -180.0000º – 179.9999º
Returns for each Beam the direction of its reference line relative to the horizontal direction. The direction goes from the starting point of the reference line to its ending point.

Beam Right Side Length

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the right side of the Beam. Its right side means the side to the right of its axis when looking from the beginning point of its reference line to its ending point.
Note: if another Beam or a Wall/Column cuts into the body of the Beam in 3D, it will not change the value returned by this listing parameter.

The values returned in a list under ‘Beam Right Side Length’, ‘Beam Left Side Length’ and ‘No. of holes in the beam’

Beam Left Side Length

Type: numerical (positive value)
Possible range: 0 and up (in meters)
Returns the length of the left side of the Beam. Its left side means the side to the left of its axis when looking from the beginning point of its reference line to its ending point.
Note: if another Beam or a Wall/Column cuts into the body of the Beam in 3D, it will not change the value returned by this listing parameter.

No. of holes in the beam

Type: numerical (positive integer value)
Possible range: 0 and up
Returns for each Beam the total number of holes that are placed into that Beam.

Surface of holes in the beam

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Beam the total surface area of all holes placed into the Beam.

The values returned in a list under ‘Surface of holes in the beam’, ‘Surface of hole edges in the beam’ and ‘Volume of holes in the beam’

Surface of hole edges in the beam

Type: numerical (positive value)
Possible range: 0 and up (in square meters)
Returns for each Beam the total surface area of all inside edges of all holes placed into the Beam. The edges of the Beam hole mean either the sides of the circular hole or the four inner sides of the rectangular hole