HypGetSheetOption

Data provider types: Essbase, Planning, Financial Management, Hyperion Enterprise

Description

HypGetSheetOption() returns information about sheet level options.

Syntax

HypGetSheetOption(vtSheetName, vtItem)

ByVal vtSheetName As Variant

ByVal vtItem As Variant

Parameters

vtSheetName: The name of worksheet on which to run the function. If vtSheetName is Null or Empty, the active worksheet is used.

vtItem: The number that indicates which option is to be retrieved. See Table 5 for a list of values.

Table 5. Options for vtItem

vtItemOptionData Type and Values
1Set zoom in level:

  • 0 = Next level

  • 1 = All levels

  • 2 = Bottom level

  • 3 = Sibling level

  • 4 = Same level

  • 5 = Same generation

  • 6 = Formulas

Number
2Enable Include Selection settingBoolean
3Enable Within Selection Group settingBoolean
4Enable Remove Unselected Groups settingBoolean
5Specify Indent setting:

  • 0 = No indentation

  • 1 = Indent sub items

  • 2 = Indent totals

Number
6Enable suppress missing settingBoolean
7Enable suppress zeros settingBoolean
8Enable suppress underscores settingBoolean
9Enable No Access settingBoolean
10Enable Repeated Member settingBoolean
11Enable Invalid settingBoolean
12Ancestor Position:

  • 0 = Top

  • 1 = Bottom

Number
13Specify Missing Text label Text
14Specify No Access labelText
15Cell Status:

  • 0 = Data

  • 1 = Calculation Status

  • 2 = Process Management

Number
16Member Name Display options:

  • 0 = Name Only

  • 1 = Name and Description

  • 2 = Description only

Number

Return Value

Returns 0 if successful; otherwise, returns the appropriate error code.

Example

Declare Function HypGetSheetOption Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtItem As Variant) As Variant

Sub Example_HypGetSheetOption()
sts = HypGetSheetOption("Sheet", 5)
If sts = -15 then
   Msgbox ("Invalid Parameter")
Else
   Msgbox ("Indentation is set to" & sts)
End If
End Sub