Data source types: Essbase, Planning, Financial Management, Hyperion Enterprise
HypGetSheetOption() returns information about individual spreadsheet options.
HypGetSheetOption(vtSheetName, vtItem)
ByVal vtSheetName As Variant ByVal vtItem As Variant
vtSheetName: For future use. Currently the active sheet is used.
vtItem: Number indicating which option is to be retrieved. See Table 19 for a list of values.
Table 19. Options for vtItem
vtItem | Option | Data Type and Values |
|---|
1 | Set zoom in level: 0 Next level 1 All levels 2 Bottom level 3 Sibling level 4 Same level 5 Same generation 6 Formulas | Number |
2 | Enable Include Selection setting | Boolean |
3 | Enable Within Selection Group setting | Boolean |
4 | Enable Remove Unselected Groups setting | Boolean |
5 | Specify Indent setting: 0 No indentation 1 Indent sub items 2 Indent totals | Number |
6 | Enable suppress missing setting | Boolean |
7 | Enable suppress zeros setting | Boolean |
8 | Enable suppress underscores setting | Boolean |
| 9 | Enable No Access setting | Boolean |
| 10 | Enable Repeated Member setting | Boolean |
| 11 | Enable Invalid setting | Boolean |
| 12 | Ancestor Position: 0 Top 1 Bottom | Number |
13 | Specify Missing Text label | Text |
| 14 | Specify No Access label | Text |
| 15 | Cell Status: 0 Data 1 Calculation Status 2 Process Management | Number |
16 | Member Name Display options: 0 Name Only 1 Name and Description 2 Description only | Number |
Returns the value of the current setting as a string, number, or Boolean. Returns an error code if parameter item is out of range.
Declare Function HypGetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant) As Variant
Sub GetSheet()
sts = HypGetSheetOption(“Sheet”, 5)
If sts = -15 then
Msgbox ("Invalid Parameter")
Else
Msgbox ("Indentation is set to" & sts)
End Sub