CommentsY Property (FPScript)
Read access to the comments on the data object's Y component. Read/write access to the comments on the current formula's Y component.
Syntax
[DataObject].CommentsY
or
[this].CommentsY = Comments
The syntax of the CommentsY property consists of the following elements:
Element |
Description |
|---|---|
DataObject |
Optional. The data object being accessed. If you omit this element, then the current formula is accessed. For an embedded FPScript, you need to use the This keyword. |
Comments |
The string to be assigned as the comments for the Y component of the actual formula. |
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 theGeneral tab of the Properties dialog box instead.
Available in
FlexPro Basic, Professional, Developer Suite
Examples
\DataSet.CommentsY |
Returns a string with the comments on a data set's Y component in the root folder. |
.CommentsY = "Channel 1" |
Sets the comments on the actual formula's Y component to "Channel 1". |