HypIsFreeForm

Data Sources: Essbase, Planning, Financial Management, Hyperion Enterprise

Description

HypIsFreeForm() checks to see whether the worksheet is in free-form mode.

Syntax

HypIsFreeForm (vtSheetName [in])

By Val vtSheetName As Variant

Parameters

vtSheetName: For future use. Currently the active sheet is used.

Return Value

VARIANT_TRUE if the cell is in free-form state, i.e., either member cells or comment cells have been modified and the sheet has not been refreshed, otherwise VARIANT_FALSE.

Example

Public Declare Function HypIsFreeForm Lib "HsAddin" (ByVal vtSheetName As Variant) As BooleanSub TestIsSheetFreeForm()

Sub HypIsFreeForm() 
		Dim oRet As Boolean

		oRet = HypIsFreeForm(Empty)
		MsgBox (oRet)

End Sub