Parameters.Unit Property (FPScript)
Read access to the unit of an object parameter. Read/write access to the unit of a parameter of the current formula.
Syntax
[Object].Parameters(Name).Unit
The syntax of the Parameters.Unit property consists of the following elements:
Element |
Description |
|---|---|
Object |
Optional. The object being accessed. If you omit this element, then the current formula is accessed. In the case of embedded FPScript you have to use the This keyword. |
Name |
Required. A string with the name of the parameter. |
Available in
FlexPro Basic, Professional, Developer Suite
Remarks
Write access to the header information of a data object is only allowed for the formula where the FPScript code is located. You should only use this option in embedded FPScript. For standard formula objects, you should edit the attribute on the General tab of the Properties dialog box instead.
Examples
.\.Parameters("Calibration Value").Unit |
Accesses the unit of a parameter called "Calibration Value" that is stored in the folder where the formula is located. |
ChangeUnit(.Parameters("Sampling Rate"), .Parameters("Sampling Rate").Unit) |
Recombines the value and unit of a quantity "Sampling Rate", which is stored in the parameter list of the formula. |