Formula patterns
FOR FORMULA FOR |
use |
YOU WILL SEE |
GENERAL |
||
CONCRETE PARAMETER IN 1UP |
$OneUpN.Cost.Parameter; format$ | Extracts the value of a specified parameter in the loaded cost model in the 1up drawing. |
CONCRETE PARAMETER IN LAYOUT |
$LayoutN.Cost.Parameter; format$ | Extracts the value of a specified parameter in the loaded cost model in the layout drawing. |
SELECTION PARAMETERS
To EXTRACT |
use |
YOU WILL SEE |
SELECTION PARAMETER IN 1UP |
$#OneUpN.Cost.Parameter$ | The name of a selected selection type entry, not its assigned value. For example, if the selection parameter ShapeComplexity has entries Simple, Medium and Complex, to each of which a numerical value is assigned, the formula returns the name of the selected entry, not the value assigned to it. |
SELECTION PARAMETER IN LAYOUT |
$#LAYOUTN.Cost.Parameter$ | |
SELECTION PARAMETER DESCRIPTION IN 1UP |
$OneUpN.Cost.Parameter.valdescr$ | The formula extracts the description text set for a selected selection type entry. For example, the selection parameter ShapeComplexity has entries Simple, Medium and Complex. If any descriptions are added to these entries, the texts of the descriptions will be displayed in the print drawing. |
SELECTION PARAMETER DESCRIPTION IN LAYOUT |
$layoutN.Cost.Parameter.valdescr$ |
IMPORTANT: N is a number from 1 through 9 that designates the consecutive number of the predefined rectangular areas in the design frame. The names of parameters are case-sensitive. In formulas they must be entered in the case in which they were created. For example, if a parameter was created as TotalCost, in formulas it must be referred to as TotalCost, not as totalcost, Totalcost or otherwise.
Examples
General
To EXTRACT |
use |
YOU WILL SEE |
TOTAL COST OF LAYOUT DRAWING |
$Layout1.Cost.TotalCost$ | The value of the parameter 'TotalCost' from the currently loaded cost model in the Layout1 drawing. |
EURO-DENOMINATED TOTAL COST OF LAYOUT DRAWING |
$Layout1.Cost.TotalCost$ EUR | The value, in euros, of the parameter 'TotalCost' from the currently loaded cost model in the Layout1 drawing. |
U.S. DOLLAR-DENOMINATED TOTAL COST OF LAYOUT DRAWING |
$$$Layout1.Cost.TotalCost$ | The value, in U.S. dollars, of the parameter 'TotalCost' from the currently loaded cost model in the Layout1 drawing. |
1UP DRAWING TOTAL COST |
$OneUp1.Cost.TotalCost; n2$ | The value of the parameter 'TotalCost' from the currently loaded cost model in the OneUp1 drawing in precision 2. |
PARAMETER IN LAYOUT DRAWING IN SPECIFIED PRECISION |
$Layout1.Cost.TotalRules; 3$ | The value of the parameter 'TotaRules' from the currently loaded cost model in the Layout1 drawing in precision 3. |
PARAMETER IN LAYOUT DRAWING IN SPECIFIED PRECISION & TEXT |
$Layout1.Cost.TotalRules; 3$ m | The value of the parameter 'TotaRules' from the currently loaded cost model in the Layout1 drawing in precision 3 and with an added explanatory text (in this case, the letter 'm'). |
TOTAL RULES COST IN 1UP |
$OneUp1.Cost.TotalRules; f2$ | The value of the parameter 'TotaRules' from the currently loaded cost model in the OneUp1 drawing in precision f2. |
NOTE: If you want to display the character '$' in front of a text, insert it two more times in front of the formula. For example, if the formula for extracting the total cost is $OneUp1.Cost.TotalCost$, write $$$OneUp1.Cost.TotalCost$. The program will return a number preceded by the $ sign — for example, $21.32. (In the table above, see the example in the third row.)
Selection Parameters
To EXTRACT |
use |
YOU WILL SEE |
SELECTED SELECTION ENTRY NAME (1UP) |
$#OneUp1.Cost.ShapeComplexity$ | The name of the selected selection type entry for the parameter ShapeComplexity in the drawing OneUp1. For example, if the parameter has the entries Simple, Medium and Complex, to each of which a numerical value is assigned, the formula returns the names of the entry selected in the cost model, not the value assigned to it. |
SELECTED SELECTION ENTRY NAME (LAYOUT) |
$#LAYOUT1.Cost.ShapeComplexity$ | |
SELECTION ENTRY NAME DESCRIPTION (1UP) |
$OneUp1.Cost.ShapeComplexity.VALDESCR$ | The text that describes the selected selection type entry for the parameter ShapeComplexity in the drawing OneUp1. For example, if the parameter has the entries Simple, Medium and Complex, to each of which a description is set, the formula returns the description text. By analogy, the formula is used for the WorkQualification parameter in the drawing Layout1. |
SELECTION ENTRY NAME DESCRIPTION (LAYOUT) |
$LAYOUT1.Cost.WORKQUALIFICATION.VALDESCR$ |
IMPORTANT: List separator type
Throughout this guide, semicolon — (;) — is used to separate formula attributes. List separators are critical for how the program interprets the attributes within formulas. Your own system, however, may use a default list separator that is different from semicolon — for example, comma (,). In this case, if you simply copy a formula from the help guide and then paste it, error messages will appear and the formula will not calculate.
So while typing a formula, ensure that the list separator used in the formula is identical with the one set for your system. This means that you may need to edit either your system's list separator setting or the formula you are typing. The examples that follow illustrate how you can use formulas with semicolons and colons as list separators:
As presented in the help guide. list separator is semicolon (;) |
type it like this if your list separator is comma (,) |
$Layout1.Area(m; Plotting); n2$ |
$Layout1.Area(m, Plotting), n2$ |
$Layout1.AreaEx(yes; mm); n2$ |
$Layout1.AreaEx(yes, mm), n2$ |
$Layout1.SheetHeight(mm); n2$ |
$Layout1.SheetHeight(mm), n2$ |
$Fold3D1.BoundingBoxWidth(Production; mm; yes)$ |
$Fold3D1.BoundingBoxWidth(Production, mm, yes)$ |