Comments: Add
Tag: AddComment
The AddComment function does exactly that -- it adds a comment in the grid.
<AddComment columnTitle="grannotation" text="Le gras c'est la vie" ColumnID="displayName" color="#666069"/>
XML

Tag Attributes
Attributes | Attribute Values | Value Description | Comment |
---|---|---|---|
Text | N/A | Comment content | N/A |
ColumnID | N/A | Unique ID of column where you want to add the comment. | N/A |
ColumnTitle | N/A | Title of new Comment column | N/A |
Color | N/A | Hexadecimal RGB color code - background cell color | N/A |
IsFormula | True / False (defaults to False) | If True, the comment text is evaluated as a Javascript formula whose resulting output is displayed in the grid cell. | N/A |
IsPrivate | True / False (defaults to False) | If false, comment is stored on the shared or cloud DB (e.g. Cosmos, provided the user license Cosmos info matches the current tenant in sapio365 - see About panel) | N/A |
Target | N/A | Grid target name (unnecessary in sapio365). | N/A |
IsVolatile | N/A | One of: Left, Center, Right - Sets text alignment in column format (cell && group) | Not stored in DB - Better to use with volatile comments only |
TextAlignment | N/A | Hexadecimal RGB color code - Grid cell text color | Not stored in DB. Better to use with volatile comments only |
TextColor | True / False (Defaults to False) | If False, the comment is only added if the text is not blank (contains other characters than spaces). | N/A |
AddIfBlank | True / False (Defaults to False) | If False, the comment is only added if the text is not blank (contains other characters than spaces). | N/A |
Detailed Description
Referencing a column will put that column text into the comment. To reference a column, enclose its unique ID with # signs:
NOTE: | Beware of circular references ! If comment A refers to Comment B, and B refers to Comment A, you lose. |
---|
Example Script
<ytriaAutomation Application="sapio365">
<AddComment columnTitle="grannotation" text="Le gras c'est la vie" ColumnID="displayName" color="#666069"/>
</ytriaAutomation>
<ytriaAutomation Application="sapio365" console="false">
<Select Lines="ByValue" Top="3">
<SetParam ColumnID="groupType" Value="Security Group"/>
</Select>
<AddComment columnTitle="My Group Type Phrase" text="++ zer 666 CHAISE '#displayName' type is '#groupType#'" ColumnID="displayName" color="#AAAAAA" IsVolatile="True"
TextAlignment="Center" TextColor="#00FF00"/>
</ytriaAutomation>
XML