Methods are executed based on events occurring during the view lifecycle.
| Method Name | Description | Overloads |
|---|---|---|
| AddDataCache | Build a DataCache from the results of a script. |
|
| AddDataTableRangeRows | Adds rows to a DataTableRange's sheet range. | |
| AddDefinedName | Add a defined name. | |
| AddProperty | Add a property to the workbook script. | |
| AddToken | Add a token to the workbook script. | |
| AddTokensForSubstVars | Add tokens for Essbase substitution variables. | |
| AddWorksheet | Add a worksheet to the workbook. | |
| AttachmentOperations (8.1) | Operations related to Dodeca Attachments. | |
| BinaryArtifactOperations (7.7) | Use this method to Create, Update, Delete, Import from binary artifacts | |
| BuildDataSetRange | Builds a SQLPassthroughDataSetRange. | |
| BuildRangeFromScript | Build a range on a worksheet from the results of a script. | |
| BuildView | Build the view. | |
| Calculate | Calculates Excel formulas in the workbook. | |
| CancelEvent | Set the value of the event that is running the procedure. | |
| ClearRange | Clear a specified range in the workbook. | |
| Close | Closes the view. | |
| CloseApplication | Closes the application. | |
| CommentOperations (8.0) | Operations related to Dodeca Comments. | |
| CopyComments | Copies comments from one or more sets of intersections to one or more other sets of intersections. | |
| CopyFromBinaryArtifact (7.3) | Copy from a specifed Excel Binary Artifact. | |
| CopyRange | Copy a specifed range in the workbook. | |
| CopyWorksheet | Copy a specified worksheet in the workbook. | |
| DeleteBinaryArtifact (7.2) | Delete a specified binary artifact or binary artifact version. | |
| DeleteBreak (7.2) | Deletes a page break or breaks from one or all sheets. | |
| DeleteDataTableRangeRows | Deletes rows from a DataTableRange's sheet range. | |
| DeleteFile (7.2) | Deletes a specified file. | |
| DeleteRange | Delete cells from one or all sheets. | |
| EssbaseConnect | Connect an Essbase connection. | |
| EssbaseCustomFunction | Executes a custom Java service on the dodeca-essbase server using the specified arguments. | |
| EssbaseDisconnect | Disconnect an Essbase connection. | |
| EssbaseKeepOnly | Do an Essbase keep-only. | |
| EssbaseMdxQuery | Run an Essbase MDX query. | |
| EssbasePivot | Do an Essbase pivot. | |
| EssbaseRemoveOnly | Do an Essbase remove-only. | |
| EssbaseReport | Run an Essbase report. | |
| EssbaseRetrieve | Do an Essbase retrieve. | |
| EssbaseRunCalc | Run an Essbase calc. | |
| EssbaseRunMaxL (7.7) | Run a MaxL script. | |
| EssbaseRunScript | Run a script on the server using a specified command line. | |
| EssbaseSend | Do an Essbase send. | |
| EssbaseSetOptions | Set Essbase options. | |
| EssbaseUpdate | Do an Essbase update using a report spec. | |
| EssbaseZoomIn | Do an Essbase zoom-in. | |
| EssbaseZoomOut | Do an Essbase zoom-out. | |
| ExecuteProcedure | Execute a specified workbook script procedure. | |
| ExecuteSQLTransaction (8.1) (Hidden in: 8.0.0) | Execute one or more SQL statements. ExecuteSQLTransaction is no longer supported. | |
| ExitProcedure | Exit the workbook script procedure if the Method condition evaluates to TRUE. If run CellByCell then a CellCondition of TRUE in any cell will exit the procedure. | |
| ExportToExcel | Export the view to an Excel file. | |
| Filter (7.4) | Filter a specified range. | |
| ForEach | Execute a procedure for each value of a list or number range. | |
| InsertBreak (7.2) | Insert a break or breaks into one or all sheets. | |
| InsertRange | Insert a range into one or all sheets. | |
| LoadWorkbook | Load a workbook from an Excel Binary Artifact. | |
| MoveWorksheet | Move a specified worksheet within the workbook. | |
| OpenBinaryArtifact (7.2) | Open a specified binary artifact, using the default editor on the system. | |
| OpenView | Open a specified view. | |
| Print Selection, Sheet, or Workbook. | ||
| PromptForInput | Prompt the user for a value. | |
| RefreshView | Refresh the view. | |
| RemoveDefinedName | Remove a defined name. | |
| RemoveDuplicates (7.4) | Remove duplicate rows or columns. | |
| RemoveProperty | Remove a specified property from the workbook script. | |
| RemoveToken | Remove a specified token from the workbook script. | |
| RemoveWorksheet | Remove a specified worksheet from the workbook. | |
| RenameWorkbook | Renames a workbook. | |
| RenameWorksheet |
Rename a specified worksheet in the workbook. Note: Changing the worksheet name in an event that fires after the BeforeCommentsSetup event may break comment functionality in the view instance. |
|
| RepaintGrid | Repaints the grid control. | |
| Replace (7.4) | Find and replace a string. | |
| ReplaceTokens | Do token replacement. | |
| SQLPassthroughExecute | Executes a delimited list of SQL statements within a single server request. IMPORTANT: If the Statements argument contains a semicolon ";", then multiple statements should be delimited using a non-semicolon character, such as the pipe character "|", which should be specified as the StatementDelimiter argument. By default, the StatementDelimiter is a semicolon. | |
| SaveDataSetRange | Saves changes, including added, deleted, and modified rows, for a SQLPassthroughDataSetRange. | |
| SaveDataTableRangeRow | Saves an added or modified row within a DataTableRange's sheet range. | |
| SaveWorkbook | Save the workbook to an Excel file. | |
| SaveWorkbookAsCsv (7.3) | Save the workbook to a CSV file. | |
| SaveWorkbookAsPdf | Save the workbook to a PDF. | |
| SelectRange | Select a specified range in the workbook. | |
| SendEmail | Send an e-mail message. | |
| SetActiveSheet | Make the specified sheet active. | |
| SetActiveWorkbook | Make the specified workbook active. | |
| SetBorders | Set the borders of cells. | |
| SetCalculationOptions | Set workbook calculation options. | |
| SetCameraFrame (7.5) |
The SetCameraFrame method works similarly to Excel when Insert/Picture or Insert/Screenshot is used and the formula of the picture frame is set to a range on a worksheet. The range specified in the formula will be rendered as an image within the picture frame. The image is automatically updated with the contents of the rendered range whenever that range changes. The camera-frame is created if it doesn't exist. To have the camera image appear exactly like the camera range, do not specify Height, Width, EndColumn, or EndRow. |
|
| SetChart | Sets the specified properties of a chart. The chart is created if it doesn't exist. | |
| SetColor | Set the color of a specified Excel color palette index. | |
| SetColumnWidth | Set column widths. | |
| SetComment | Dodeca comments. | |
| SetConditionalFormat | Set or clear conditional formats. | |
| SetControl | Creates the specified Control if it doesn't exist, and sets the specified properties of it. | |
| SetCover | Set the value of the view's Cover property. | |
| SetCursor | Sets the Cursor as specified. | |
| SetDataTableRangesModificationTracking (8.0) | Any changes to cell values in existing data rows on the sheet, while modification tracking is disabled (FALSE), will not be detected as unsaved changes when the view is rebuilt or closed. | |
| SetDataValidation | Set or clear data validation. | |
| SetEntry | Enter a value or formula into a specified range in the workbook. Can also be used to clear cells or set the error value. | |
| SetEssbaseSendRangeModificationTracking (8.0) | Set the value of the view's SendRangeModificationTrackingEnabled property. | |
| SetEventLink | Set the value of an EventLink's Active property to control whether the EventLink's Procedure runs or not. | |
| SetExcelComment | Set, Add-to, or clear Excel comments from cell(s). | |
| SetFill | Set the fill colors and patterns of cells. | |
| SetFont | Set the font properties (font-name, color, size, etc.) of cells. | |
| SetFormulaBar | Sets whether the formula bar is visible. | |
| SetHidden | Set the Hidden property of rows, columns, or sheets to true or false. | |
| SetHyperlink | Create or clear hyperlinks in cells (web, e-mail, file, or address in the workbook). | |
| SetImage | Adds the specified Image with the specifed name and sets the specified properties. If the image/name already exists then the properties are modified. | |
| SetLine | Creates the specified Line if it doesn't exist, and sets the specified properties of it. | |
| SetNumberFormat | Set the number format of specific cells. | |
| SetOutlineLevel | Set outline/grouping level. | |
| SetPageBreak | Set page breaks to automatic, or add/clear print page breaks. | |
| SetPageSetup | Set the page setup options of one or all worksheets. | |
| SetProgressText | Set the progress text displayed at the bottom of the view. | |
| SetProtection | Set the protection properties of the workbook, worksheet, or specific cells. | |
| SetRowHeight | Set row heights. | |
| SetSelector | Sets the selected value(s) of the specified Selector. | |
| SetSelectorConfiguration | Adds, modifies, or removes a selector configuration before the view is displayed. This method should be called from either the AfterConstruct or BeforeInitializeUI event link. | |
| SetShape | Sets the specified properties of a Shape. The Shape is created if it doesn't exist. | |
| SetTextAlignment | Set the text alignment of cells. | |
| SetTextBox | Creates the specified TextBox if it doesn't exist, and sets the specified properties of it. | |
| SetTimer (7.2) | Starts a timer that executes a procedure at a specified interval until the timer is stopped. | |
| SetTool | Shows or hides a tool in the toolbars, enables or disables a tool, and/or sets or clears the text of a TextBoxTool or the value of a ComboBoxTool. | |
| SetToolbarVisible | Sets the Visible property of the specified toolbar (or group in a ribbon tab). | |
| SetTracing | Set values that control tracing or perform certain trace operations. | |
| SetUDA | Adds or removes one or more UDA's assigned to one or more members. | |
| SetViewPropertyValue | Set the value of a specified view property. | |
| SetViewStatus | Set the status-text and/or status-image of the view. | |
| SetWorkbookOptions | Set workbook options, including SaveLinkValues, ShowSheetTabs, TabRatio, ShowScrollBars, and DisplayObjects. | |
| SetWorksheetOptions | Set options to control the appearance and behavior of one or all worksheets. | |
| ShowFileDialog | Prompts the user to select a file to open (OpenFile) or select a location for saving a file (SaveFile). | |
| ShowLoginDialog (7.2) | Show a login dialog, optionally setting property values from the result. | |
| ShowMessageBox | Show a message box, optionally setting a property value from the result. | |
| ShowScriptDebugger | Show the workbook script debugger dialog. | |
| ShowSelectorControlAsDialog | Show the selector treeview or listview control as a modal dialog. | |
| SortRange | Sort a specified range in the workbook. | |
| ThrowException | Throw a custom exception. | |
| UnloadWorkbook | Unload a workbook. | |
| UpdateBinaryArtifact | Updates a Binary Artifact with a new file. | |
| UpdateSelectorCache | Update the cache of selector values. | |
| Wait (8.0) | Pauses execution of the current procedure. | |
| WriteLogMessage | Writes a message to a log file. |