Indicates whether a cell contains cell text. The method’s last argument takes a Boolean variable that indicates whether the cell specified by the other arguments contains cell text.
Note: | Cell text is the text entered when a user right-clicks a Data Explorer cell and selects the Cell Text option. |
Syntax
<HsvData>.DoesCellDescriptionExist lScenario, lYear, lPeriod, lEntity, lParent, lValue, lAccount, lICP, lCustom1, lCustom2, lCustom3, lCustom4, pvarbExists
Argument | Description |
---|
lScenario | Long (ByVal). The member ID of the cell's Scenario dimension member. |
lYear | Long (ByVal). The member ID of the cell's Year dimension member. |
lPeriod | Long (ByVal). The member ID of the cell's Period dimension member. |
lEntity | Long (ByVal). The member ID of the cell's Entity dimension member. |
lParent | Long (ByVal). The member ID of the parent of the lEntity argument's entity. |
lValue | Long (ByVal). The member ID of the cell's Value dimension member. |
lAccount | Long (ByVal). The member ID of the cell's Account dimension member. |
lICP | Long (ByVal). The member ID of the cell's Intercompany Partner dimension member. |
lCustom1 | Long (ByVal). The member ID of the cell's Custom 1 dimension member. |
lCustom2 | Long (ByVal). The member ID of the cell's Custom 2 dimension member. |
lCustom3 | Long (ByVal). The member ID of the cell's Custom 3 dimension member. |
lCustom4 | Long (ByVal). The member ID of the cell's Custom 4 dimension member. |
pvarbExists | Boolean. Returns TRUE if the cell contains cell text, otherwise FALSE. |
Example
This example shows how to call DoesCellDescriptionExist and then test the pvarbExists argument. If DoesCellDescriptionExist returns FALSE, any code placed in the If structure would be executed. The example assumes that the variables for the member ID arguments have been previously set in another procedure.