HypGetGlobalOption

Describes the Oracle Smart View for Office VBA function, HypGetGlobalOption.

Cloud data provider types: Oracle Essbase, Planning, Planning Modules, Financial Consolidation and Close, Tax Reporting

On-premises data provider types: Oracle Essbase, Oracle Hyperion Planning, Oracle Hyperion Financial Management

Description

HypGetGlobalOption() returns information about Smart View global (default) options. Global options are options that apply to the entire current workbook and to any workbooks and worksheets that are created henceforth.

Tip:

Use HypGetOption to set both global (default) and sheet specific Smart View options so that you do not need separate VBA commands for the two option types.

Syntax

HypGetGlobalOption(vtItem)

ByVal vtItem As Long

Parameters

vtItem: The number that indicates which option is to be retrieved

Table 13-1 lists the numbers of options and their return data types.

Table 13-1 HypGetGlobalOption Parameter Numbers and Options

vtItem Option Return Data Type
1 Use Excel formatting Boolean
2 Use double-click for ad hoc operations Boolean
3 Enable undo Boolean
4 Not used --
5 Specify message level setting:

  • 0 = Information

  • 1 = Warnings

  • 2 = Errors

  • 3 = None

  • 4 = Extended info

See Notes in HypSetGlobalOption for information about this option and backward compatibility.

Integer
6 Use thousands separator Boolean
7 Route messages to log file Boolean
8 Clear log file on next launch Boolean
9 Navigate without data Boolean
10 Not used --
11 Not used --
12 Specify Meaningless label Text
13 Reduce Excel file size Boolean
14 Enable formatted strings Boolean
15 Retain numeric formatting Boolean
16 Enable enhanced comment handling Boolean
17 Enable retain ribbon context Boolean
18 Display Smart View Panel on startup Boolean
19 Always show on refresh (in Comment Edit dialog box; available only if Enhanced comment handling is enabled and the grid contains comments) Boolean
20 Enable profiling. Includes extended Info log entries and most function calls. Creates XML files for each Office application with active Smart View. Intended for debugging. Severely impacts performance.

See Notes in HypSetGlobalOption for information about backward compatibility.

Boolean

Return Value

Returns the appropriate return data type as shown in Table 13-1; otherwise, returns the appropriate error code.

Example

The following example sets the message level option and checks whether the value set is valid.

Declare Function HypGetGlobalOption Lib "HsAddin" (ByVal vtItem As Long) As Variant

Sub Example_HypGetGlobalOption()
   sts = HypGetGlobalOption(5)
   If sts = -15 then
      Msgbox ("Invalid Parameter")
   Else
      Msgbox ("Message level is set to" & sts)
	End If
End Sub