HypRemovePreservedFormats

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

Description

HypRemovePreservedFormats() removes preserved formats.

Note:

Users must refresh before the original formatting is applied.

Syntax

HypRemovePreservedFormats (vtSheetName [in], vtRemoveAllPreservedFormats [in],vtSelectionRange [in])

ByVal vtSheetName As Variant

ByVal vtbRemoveAllPreservedFormats As Variant

ByVal vtSelectionRange As Variant

Parameters

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

vtbRemoveAllPreservedFormats: Boolean to indicate whether all preserved formats on the grid should be deleted. (If this parameter is true, the next parameter value is not used, so users can pass NULL for vtSelectionRange.)

vtSelectionRange: Range of the cell(s) for which formatting needs to be preserved. (Multiple ranges are supported)

Return Value

Returns SS_OK if successful; otherwise, the appropriate error code.

Example

Public Declare Function HypRemovePreservedFormats Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtbRemoveAllPreservedFormats As Variant, ByVal vtSelectionRange As Variant) As Long

Sub TestRemovePreservedFormatting()

		Dim oRet As Long
		Dim oSheetName As String
		Dim oSheetDisp As Worksheet

		oSheetName = "Sheet1"

		Set oSheetDisp = Worksheets(oSheetName)
		'oRet = HypRemovePreservedFormats(Empty, False, oSheetDisp.Range("B2"))
		oRet = HypRemovePreservedFormats(Empty, True, Null)
		MsgBox (oRet)

End Sub