HypRemovePreservedFormats
Describes the Oracle Smart View for Office VBA function, HypRemovePreservedFormats.
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
HypRemovePreservedFormats() removes preserved formats.
Note:
Users must refresh before the original formatting is applied.
Syntax
HypRemovePreservedFormats (vtSheetName, vtbRemoveAllCapturedFormats,vtSelectionRange)
ByVal vtSheetName As Variant
ByVal vtbRemoveAllCapturedFormats As Variant
ByVal vtSelectionRange 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.
vtbRemoveAllCapturedFormats: Set to True to remove all preserved formats in the selected range. Otherwise, set to False. If set to True, the next parameter value is not used, so users can pass Null for vtSelectionRange.)
vtSelectionRange: The range of the cell(s) in which formatting is to be preserved. Multiple ranges are supported.
Return Value
Returns 0 if successful; otherwise, the appropriate error code.
Example
Public Declare Function HypRemovePreservedFormats Lib "HsAddin" (ByVal vtSheetName As Variant, ByVal vtbRemoveAllCapturedFormats As Variant, ByVal vtSelectionRange As Variant) As Long
Sub Example_HypRemovePreservedFormats()
Dim Ret As Long
Dim SheetName As String
Dim SheetDisp As Worksheet
SheetName = "Sheet1"
Set oSheetDisp = Worksheets(SheetName)
'Ret = HypRemovePreservedFormats(Empty, False, SheetDisp.Range("B2"))
Ret = HypRemovePreservedFormats(Empty, True, Null)
MsgBox (oRet)
End Sub