Functions

Functions are used inside of script methods.

Function / Usage Description
ActiveCell
@ACell()
Returns the address of the active cell.
ActiveSheetName
@ASheet()
Returns the name of the active sheet.
ActiveSheetNumber
@ASheetNumber()
Returns the number of the active sheet.
AddressOfRange
@AddrOfRng(<address>, [<Absolute>]) || @AddrOfRng(<StartRow>, <StartColumn>, <EndRow>, <EndColumn>, [<Absolute>]))
Returns the address of the specified range.
ApplicationID
@AppID()
Returns the Dodeca Application's ID.
AuthenticatedUserName
@AuthenticatedUserName()
Returns the authenticated user ID.
AuthenticatedUserRoles
@AuthenticatedUserRoles(<Delimiter>))
Returns a delimited list of roles, based on the roles of the authenticated user.
BinaryArtifactExists
@BinaryArtifactExists(<BinaryArtifactID>, [<VersionNumber>]))
Determines whether the specified binary artifact exists.
CanConnect
@CanConnect(<ConnectionID>, [<Username>], [<Password>]))
Returns whether the specified Essbase connection can be connected to using the current crendentials or the specified credentials.
CascadeSheetCount
@CascadeSheetCount()
Returns the number of worksheets that will be created based on the current selections in selectors designated as CascadeSources.
CellFillColor
@CellFillColor([<Address>]))
Returns the background color of a cell.
CellIsHidden
@CellIsHidden([<Address>]))
Returns True or False based on whether the cells in the specified range are hidden.
CellIsLocked
@CellIsLocked([<Address>]))
Returns True or False based on whether the cells in the specified range are locked.
CellsAddress
@CellsAddress()
Returns the address of the range of all the cells on the current worksheet.
Checksum
@Checksum(<Range>))
Returns an SHA-1 hash of the values in the given range. This function can be used to compute changes within a range, which can be specified as a defined name or an address. This function can work with discontiguous ranges.
ColumnLetter
@ColL(<ColumnNumber>))
Returns the Alphabetic respresentation of the specified column number.
ColumnWidth
@ColWidth([<Address>]))
Returns the column width of a cell.
CommandLineArg
@CommandLineArg(<argument>))
Returns the value of the specified standard or custom command-line argument. The standard command-line arguments include tenant, servletPath, userDomain, username, machineName, appID, defaultViewID, and savedViewID.
CommentProperty
@CmtProp(<PropertyName>))
Returns the value of the specified comment property from the comment that triggered a comment-related event. This function only works when used within the context of a comment-related event that exposes the comment as an event arguments.
CommentPropertyForCell
@CmtPropForCell(<PropertyName>, [<CellAddress>]))
Returns the value of the specified comment property from the most recent comment associated with the specified cell.
Contains
@Contains(<Substring>, <WithinString>, [<IgnoreCase>], [<HonorWildcards>]))
Returns True or False, based on whether the first specified string contains the second specified string.
CurrentColumn
@CCol()
Returns the number of the current column.
CurrentRow
@CRow()
Returns the number of the current row.
CurrentSelection
@Selection()
Returns the address of the current selection.
DataCacheContents
@DCC(<DataCacheName>))
Returns the contents of a specfied DataCache.
DataCacheCount
@DCCount(<DataCacheName>))
Returns the number of rows in ther specfied DataCache.
DataPointDimGeneration
@DPDimGen([<CellAddress>], <Dimension>))
Returns the generation of the member for the specified dimension.
DataPointDimLevel
@DPDimLevel([<CellAddress>], <Dimension>))
Returns the level of the member for the specified dimension.
DataPointDimOrientation
@DPDimOr([<CellAddress>], <Dimension>))
Returns the orientation of the specified dimension.
DataPointDimValueAlias
@DPDimValAlias([<CellAddress>], <Dimension>, [<AliasTableName>]))
Returns the alias for the specified dimension.
DataPointDimValueDisplayed
@DPDimValDisp([<CellAddress>], <Dimension>))
Returns the displayed member-name or alias for the specified dimension.
DataPointDimValueMember
@DPDimValMbr([<CellAddress>], <Dimension>, [<AliasTableName>]))
Returns the member-name for the specified dimension.
DataPointDimValuesAliases
@DPDimValsAliases([<CellAddress>], [<AliasTableName>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>]))
Returns a delimited list of dimension names and aliases for the specified cell.
DataPointDimValuesDisplayed
@DPDimValsDisp([<CellAddress>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>]))
Returns a delimited list of dimension names and displayed values for the specified cell.
DataPointDimValuesMembers
@DPDimValsMbrs([<CellAddress>], [<AliasTableName>], [<ColumnDelimiter>], [<RowDelimiter>], [<Dimensions>]))
Returns a delimited list of dimension names and member names for the specified cell.
DataPointHasCellNote
@DPHasCellNote([<CellAddress>]))
Returns true or false based on whether the specified cell has cell note(s) associated with it.
DataPointHasLinkedObjects
@DPHasLinkedObjects([<CellAddress>]))
Returns true or false based on whether the specified cell has linked objects associated with it.
DataPointIsBlank
@DPIsBlank([<CellAddress>]))
Returns true or false based on whether the specified cell is blank.
DataPointIsDouble
@DPIsDouble([<CellAddress>]))
Returns true or false based on whether the specified datapoint cell contains a double value.
DataPointIsError
@DPIsError([<CellAddress>]))
Returns true or false based on whether the specified datapoint cell contains an error value.
DataPointIsMissing
@DPIsMissing([<CellAddress>]))
Returns true or false based on whether the specified datapoint is missing.
DataPointIsNoAccess
@DPIsNoAccess([<CellAddress>]))
Returns true or false based on whether the specified datapoint is NoAccess.
DataPointIsReadOnly
@DPIsReadOnly([<CellAddress>]))
Returns true or false based on whether the specified datapoint cell is ReadOnly.
DataPointIsReadWrite
@DPIsReadWrite([<CellAddress>]))
Returns true or false based on whether the specified datapoint cell is ReadWrite.
DataPointIsZero
@DPIsZero([<CellAddress>]))
Returns true or false based on whether the specified datapoint cell contains a value or zero.
DataSetRangeIndex
@DataSetRangeIndex(<SQLPassthroughDataSetID>))
Returns the zero-based index representing the relative position of the specified SQLPassthroughDataSet range within the view's DataSetRanges collection.
DataTableRangeRowHasChanges
@DataTableRangeRowHasChanges([<Address>]))
Returns whether a specific data row within a DataTableRange's sheet range has any unsaved changes. The address of any cell within the data row or the address of the sheet row may be used to identify the data row. If an address is not specified, the current cell address is used.
DataTableRangeRowState
@DataTableRangeRowState([<Address>]))
Returns whether a specific data row within a DataTableRange's sheet range was Added, Modified, or is Unchanged. The address of any cell within the data row or the address of the sheet row may be used to identify the data row. If an address is not specified, the current cell address is used.
DataTableSheetRangeName
@DataTableSheetRangeName([<Address>]))
Returns the name of the DataTableRange's sheet range that contains the specified cell. If a cell address is not specified, the current cell is used.
DefinedNameExists
@DefinedNameExists(<DefinedName>))
Returns TRUE if the specified DefinedName exists.
DelimitedStringFromRangeValues
@StringFromRange(Range, [ColumnDelimiter], [RowDelimiter]))
Returns a delimited string containing the values of a worksheet range.
EssConnectionPropertyValue
@EssConnPVal(<ConnectionID>, <PropertyName>))
Returns the value of the specified EssbaseConnection property.
EssbaseCalcScript
@EssCalcScript(<CalcScriptName>, [<ConnectionID>]))
Returns the specified calc script from the server.
EssbaseDatabaseNote
@EssDatabaseNote([<ConnectionID>]))
Returns the database note attached to an Essbase cube.
EventPropertyValue
@EPVal(<PropertyName>))
Returns the value of the specified property of the event that triggered the method. A null string is returned without error if the property does not exist.
ExcelComment
@ExcelComment([<Address>]))
Returns the Excel comment text, if any, for the specified cell. If the cell does not have a comment, returns an empty string.
FileExists
@FileExists(<FileName>, [<SpecialFolder>]))
Returns True or False, based on whether the file exists on the client filesystem.
FirstColumn
@FCol([<Address>], [<AdjustBy>]))
Returns the index of the first column of a range.
FirstColumnLetter
@FColL([<Address>], [<AdjustBy>]))
Returns the letter value of the first column of a range.
FirstRow
@FRow([<Address>], [<AdjustBy>]))
Returns the index of the first row of a range.
FormulaBarIsVisible
@FormulaBarIsVisible()
Returns True/False indicating whether the Formula Bar is visible.
Guid
@Guid()
Returns a string representation of a globally unique identifier, GUID, that can be used wherever a unique identifier is required.
HasExcelComment
@HasExcelComment([<Address>]))
Returns True or False based on whether the specified cell has a comment.
IntersectionOfRanges
@Intersection(<Range1>, <Range2>))
Returns the address of the intersection of the two specified ranges.
IsConnected
@IsConnected(<ConnectionID>))
Returns whether the specified Essbase connection is connected.
IsDataCell
@IsDataCell(<CellAddress>))
Returns true or false based on whether the specified cell is an Essbase datapoint cell.
IsDrillthroughSheet
@IsDrillThroughSheet()
Returns a boolean indicating whether the active sheet is a drill-through sheet.
IsEven
@IsEven(<Number>))
Returns True/False indicating whether the specified number is even.
IsInCharacterRange
@IsInCharacterRange(<Character Range>, <String>))
Returns True/False indicating whether the specified string is limited to the specified character range.
IsInRole
@IsInRole(<Role>))
Returns True or False, based on whether the authenticated user ID has the specified role.
IsMemberCell
@IsMemberCell(<CellAddress>))
Returns true or false based on whether the specified cell is an Essbase member cell.
IsOdd
@IsOdd(<Number>))
Returns True/False indicating whether the specified number is odd.
IsProtectedSheet
@IsProtectedSheet([<SheetNameOrIndex>]))
Returns True/False indicating whether the active (or specified) sheet is protected.
IsSavedView
@IsSavedView()
Returns True/False indicating whether the view is a SavedView.
IsSharedView
@IsSharedView()
Returns True/False indicating whether the view was shared by another user.
LastColumn
@LCol([<Address>], [<AdjustBy>]))
Returns the index of the last column of a range.
LastColumnLetter
@LColL([<Address>], [<AdjustBy>]))
Returns the letter value of the last column of a range.
LastRow
@LRow([<Address>], [<AdjustBy>]))
Returns the index of the last row of a range.
LookupValue
@LookupValue(<DataCacheName>, <Value>, <ColumnNumber>, [<KeyColumnNumber>], [<MatchType>]))
Returns the value of a specified column from the row specified by a row key, from a DataCache specfied by the DataCacheName.
MachineName
@MachineName()
Returns the name of the workstation the user is on.
MemberAlias
@MbrAlias(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the Essbase Alias of the specified member.
MemberCellDimensionName
@MemberCellDimensionName([<CellAddress>]))
Returns the dimension name of the specified member cell. If the cell is not a member cell, returns an empty string "".
MemberCellDimensionNumber
@MemberCellDimensionNumber([<CellAddress>]))
Returns the dimension number of the specified member cell. If the cell is not a member cell, returns 0.
MemberCellIsDimension
@MemberCellIsDimension([<CellAddress>]))
Returns true or false based on whether the specified member cell is the dimension member.
MemberCellIsExplicitlyShared
@MemberCellIsExplicitlyShared([<CellAddress>]))
Returns true or false based on whether the specified member cell is an explicit share.
MemberCellIsImplicitlyShared
@MemberCellIsImplicitlyShared([<CellAddress>]))
Returns true or false based on whether the specified member cell is an implicit share.
MemberCellIsLabelOnly
@MemberCellIsLabelOnly([<CellAddress>]))
Returns true or false based on whether the specified member cell is label only.
MemberCellIsNeverShare
@MemberCellIsNeverShare([<CellAddress>]))
Returns true or false based on whether the specified member cell is marked as never share.
MemberCellIsParent
@MemberCellIsParent([<CellAddress>]))
Returns true or false based on whether the specified member cell is a parent member.
MemberCellIsStoredData
@MemberCellIsStoredData([<CellAddress>]))
Returns true or false based on whether the specified member cell is a stored data member.
MemberChildCount
@MbrChildCnt(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the number of children of the specified member.
MemberDimension
@MbrDim(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue="">]))
Returns the DimensionName of the specified member.
MemberFirstChild
@MbrFirstChild(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue="">]))
Returns the name of the first child of the specified member.
MemberGeneration
@MbrGeneration(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the Essbase Generation of the specified member.
MemberHasUDA
@MbrHasUDA(<MemberName>, <UDA>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns TRUE if the specified member has the specified UDA.
MemberKey
@MbrKey(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the Key of the specified member.
MemberLevel
@MbrLevel(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the Essbase Level of the specified member.
MemberName
@MbrName(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the Essbase Name of the specified member.
MemberNextSibling
@MbrNextSib(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the name of the next sibling of the specified member.
MemberParentKey
@MbrPKey(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue="">]))
Returns the Key of the specified member.
MemberPreviousSibling
@MbrPrevSib(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns the name of the previous sibling of the specified member.
MemberRelatedMembers
@MbrRelatedMbrs(<MemberName>, <Relationship>, [<Delimiter>], [<MemberFormat>], [<EscapeSingleQuotes>], [<ReturnAliases>], [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns a delimited list of members that are related to the specified member.
MemberUDAs
@MbrUDAs(<MemberName>, [<AliasTable>], [<ConnectionID>], [<DefaultValue>]))
Returns a semicolon delimited list of UDA's for the specified member.
PropertyExists
@PropertyExists(<PropertyName>))
Returns True/False indicating whether a Property with the specified name exists.
PropertyIsNullOrEmpty
@PropertyIsNullOrEmpty(<PropertyName>))
Returns True/False indicating whether a Property has a null value or, if the data type is string, whether the value is an empty string. If the property does not exist, returns True.
PropertyValue
@PVal(<PropertyName>))
Returns the value of the specified script property.
RangeContainsRange
@RangeContainsRange(<Range1>, <Range2>))
Returns TRUE or FALSE depending on whether the first range contains all of the second range.
ReplaceTokens
@ReplTokens())
Does token replacement on the specified string.
RowHeight
@RowHeight([<Address>]))
Returns the row height of a cell.
SavedViewID
@SavedViewID()
Returns the value of the SavedViewID property.
SectionBreakRowOrColumnCount
@SectionBreakRowOrColumnCount(<SectionValuesRange>, <StartCell>, <SectionValue>, <RowOrColumn>))
Returns the number of rows or columns in a section. This function can be used to compute the address of a section to enable dynamic formulas to calculate a given view section. This function starts at the bottom or right of a given range and counts each row or column as it processes upward or leftward until it finds the next section break value. If the value is not found, this function returns the number of cells from the starting cell range to the start of the SectionValuesRange.
SelectorDisplayedValue
@SDVal(<SelectorID>, [<Delimiter>]))
Returns the displayed value of the specified Selector.
SelectorMemberAlias
@SMbrAlias(<SelectorID>, [<Delimiter>]))
Returns the alias(es) of the selected members for the specified Essbase selector.
SelectorMemberName
@SMbrName(<SelectorID>, [<Delimiter>]))
Returns the name(s) of the selected members for the specified Essbase selector.
SelectorValue
@SVal(<SelectorID>, [<Delimiter>]))
Returns the value of the specified Selector.
SelectorValueCount
@SValCount(<SelectorID>))
Returns the number of selected items in the specified Selector.
SheetCount
@SheetCount([<IncludeHiddenSheets>]))
Returns the number of sheets in the active workbook.
SourceViewID
@SourceViewID()
Returns the value of the SourceViewID property.
SpecialFolder
@SpecialFolder(<FolderID>))
Returns the directory path to a system special folder on the client.
Substitute
@Substitute(<Text>, <OldText>, <NewText>, [<CaseSensitive>], [<InstanceNumber>]))
Replaces existing text with new text in a text string. Unlike the Excel SUBSTITUTE function, this function does not limit the text argument values to 255 characters, and also allows for specifying whether a match is based on a case-sensitive or a case-insensitive comparison.
SubstitutionVariable
@SubstVar(<SubstitutionVariableName>, [<connection-ID>], [<scope>]))
Returns the value of the specified Essbase SubstitutionVariable.
TempFolder
@TempFolder()
Returns the directory path to the client system's temporary folder.
Tenant
@Tenant()
Returns the tenant key for the current application.
TextBoxValue
@TextBoxValue(<Name>))
Returns the text value of a textbox.
TokenExists
@TokenExists(<TokenName>, [<UseTargetView>]))
Returns True/False indicating whether a Token with the specified name exists.
TokenIsNullOrEmpty
@TokenIsNullOrEmpty(<TokenName>, [<UseTargetView>]))
Returns True/False indicating whether a Token has a null value or the value is an empty string. If the Token does not exist, returns True.
TokenValue
@TVal(<TokenName>, [<UseTargetView>]))
Returns the value of the specified Token.
UsedRange
@UsedRange()
Returns the address of the used range.
UserDomainName
@UserDomainName()
Returns the user domain name.
ValueError
@ValueError([<Address>]))
Returns the error-value of a cell. If a range is not specified the current cell is used.
ValueFormula
@ValueFormula([<Address>]))
Returns the formula of a cell. If a range is not specified the current cell is used.
ValueLogical
@ValueLogical([<Address>]))
Returns the logical-value of a cell. If a range is not specified the current cell is used.
ValueNumber
@ValueNumber([<Address>]))
Returns the number-value of a cell. If a range is not specified the current cell is used.
ValueText
@ValueText([<Address>]))
Returns the text-value of a cell. If a range is not specified the current cell is used.
ViewCultureCurrencyDecimal
@CDec()
Returns the decimal separator used in currency values as defined by the view's culture.
ViewCultureCurrencyGroupSeparator
@CSep()
Returns the string that separates groups of digits to the left of the decimal in currency values as defined by the view's culture.
ViewCultureCurrencySymbol
@CSym()
Returns the currency symbol defined by the view's culture.
ViewCultureDateSeparator
@DSep()
Returns the string that separates the components of a date (year, month, and day) as defined by the view's culture.
ViewCultureListSeparator
@Sep()
Returns the list separator defined by the view's culture.
ViewCultureNegativeSign
@Neg()
Returns the string that denotes that a number is negative as defined by the view's culture.
ViewCultureNumberDecimal
@NDec()
Returns the decimal separator used in numeric values as defined by the view's culture.
ViewCultureNumberGroupSeparator
@NSep()
Returns the string that separates groups of digits to the left of the decimal in numeric values as defined by the view's culture.
ViewCulturePercentDecimal
@PDec()
Returns the decimal separator used in percent values as defined by the view's culture.
ViewCultureTimeSeparator
@TSep()
Returns the string that separates the components of time (hours, minutes, and seconds) as defined by the view's culture.
ViewPropertyValue
@ViewPVal(<PropertyName>, [<UseTargetView>]))
Returns the value of the specified view property.
WindowsCultureName
@WindowsCultureName()
Returns the abbreviated name of the Regional Options setting, such as en-US.
WindowsUserName
@WindowsUserName()
Returns the Windows user ID.
WorkbookName
@WorkbookName([<Index>]))
Returns the name of the workbook.
WorksheetEvaluate
@WSEval(<Formula>))
Evaluates the specified formula via the worksheet and returns the result.