Method doAction
Description This function takes care of all control operations.
Return type Boolean
Return values
True (-1) The action was executed successfully
False (0) The action wasn't executed or an error occurred.
Parameters Action to execute. See below for a list of actions.
Example Cube1.setValue("openFile", "c:\OLAP_CUBE_DIR\gs3.cub")
if Cube1.doAction("OpenParam") = True then
 msgBox "Connection to cube gs3.cub successful"
else
 msgBox "Can't connect to gs3.cub"
end if
Explanation The program sets the openFile variable to a local cube file via the setValue method and then tries to open it with the openParam doAction action.
See also
getValue retrieves the value of a control variable
setValue gives value to a control variable
Notes By using doAction, getValue and setValue you have a very strong developing platform for OLAP applications. Use a call setValue("DisableAction", "action") and setValue("EnableAction", "action") to disable and enable actions. It can only be set programatically.
Below is a list of all the actions that can be called from DoAction. Click on a desired action to get more information.
CubeConnectNI Non interactive cube connection. There must be open... property defined.
OpenParam If an open... property is defined, the cube is opened. If not, then an interactive cube open is made.
OpenOlap Opens a cube with user interaction, erasing all open properties.
Connect Connects and opens a new cube, based on the open cube parameters, without displaying it.
InitCubeConnect Connects, opens and display a new cube, based on the open cube parameters. Used when initializing the control.
SaveView Saves the current cube view.
SaveViewAs Saves the current view, asking for a file name.
PrintPreview Calls the print preview dialog.
PrintPreviewPortfolio Calls the print preview dialog for the current open portfolio.
PrintView Calls the print dialog.
PrintPortfolio Calls the print dialog on the current portfolio.
CommitCube Commits to the cube all the data written back to the cube. It shows the Commit cube dialog.
RefreshCube Refreshes the cube view. For ROLAP local cubes, it refreshes the cube physically. Afterwards refreshes the cube view via a Refresh action. It asks to commit the current cube changes.
ForceRefreshCube Forces a cube refresh. For ROLAP local cubes, it refreshes the cube physically. Afterwards refreshes the cube MDX. It commits the current cube changes.
ForceAutoRefreshCube Forces a cube refresh when AutoRefreshCube is on. For ROLAP local cubes, it refreshes the cube physically each time a cube query is made. It commits the current cube changes.
RefreshTimer Asks for an interval in minutes in which the cube is refreshed via Refresh Cube. Use 0 to turn off this timer. You can set the RefreshTimerValue variable to skip this dialog.
ExportView Exports the current view to a file. Asks for the file.
ExportPortfolio Exports the current portfolio to a file. Asks for the file.
PageSetup Calls the page setup dialog.
CopyView Copies the current view to the clipboard. If some cells are selected in the data matrix, only those cells are copied.
PasteView Let the user paste values from Excel to a cube which is write enabled. It pastes the values to selected cell.
DirectMDX Calls the direct MDX dialog.
ShowElements Shows the show elements dialog, that let's you choose which cube areas to show: title, heading, data and chart. See the VisibleLayout property for more information.
CubeOption Shows the cube option dialog that lets you select filter, order and pareto options among others.
ShowChart Returns whether the chart is shown or not. If it's shown, then the chart is refreshed. It's ignored with the developer control.
DoSwapXY Swaps the grid's x and y axes.
ShowLayout Shows the layout dialog. It let's you position cube dimension in the different axis and heading.
DimensionOptions Calls the dimension options dialog. It let's you modify several dimension settings. Shows the first cube dimension as default.
GridOption Shows the grid option dialog. It let's you change fonts, colors, grid settings, etc.
AboutBox Shows the control About box.
Splash Shows the control Splash window for a few seconds.
ChangeTitle Changes or updates the cube view title. Set the caption>/span> property before.
WriteRegistry Writes to the windows registry, formatting information. This information will become default information.
WritePreviewRegistry Writes to the windows registry, page setup formatting information. This information will become default information.
WriteElementsRegistry Writes to the windows registry, the areas and cube layout information. This information will become default information.
WriteCubeRegistry Writes to the windows registry, cube options information
WriteLayerRegistry Writes to the windows registry, cell format information (only rotate with cube option).
ReadRegistry Reads from the windows registry control information saved by the write..registry actions. The cube format is updated according to the registry information.
StartLog Starts control's error logging.
EndLog Turns off the control's error logging.
Sort Sorts the grid according to sorting flags (SortFlag. Use the Col and Row variables to set the grid cell.
Drill Exchange dimensions or drills down or up on a dimension. Use the Col and Row variables to set the grid cell.
TransposeChart Transposes or rotates only the chart.
Reset Refreshes the actual cube view, updating the cube catalog to their default values.
UpdateFormat Refreshes the cube format, setting display values modified by calls to setValue method.
Refresh Refreshes the cube view, including format and all variables modified by calls to setValue method.
ExecuteMDX Executes an MDX and refreshes the cube. The MDX can be set to a call to the MDX variable and the setValue method.
ShowProperties Show dimension field properties. Use the Col and Row variables to set the grid cell.
ShowHierarchy Sets a new hierarchy type for a dimension. Use the AutoHierarchy variable to set the hierarchy type, Col and Row variables to set the grid cell.
ShowPareto Sets a new pareto type for a dimension. Use the AutoPareto variable to set the Pareto type.
ShowCubeView Sets a new cube view for a dimension, for example % of totals or % of parent. Set the AutoCubeView variable to set the cube view type.
ShowCubeFilter Calls the quick filter dialog box to create the filter. Use calls to setValue to create a filter programmatically.
Freeze Freezes the data grid. Use the Col and Row variables to set the grid cell.
CubeReport Writes to C:\OlapXCubeReport.xml) catalog information about the cube opened.
CellSetReport Writes to C:\OlapXCellSet.xml cell set (cube data) information of current cube query.
GetActions Retrieves the actions available for a cell. Use the Col and Row variables to set the grid cell.
ShowActions Shows the actions retrieved by getActions.
DoDrillThrough Shows the underlying database information of the current chosen cell.
MoveSequence Moves to a specified number in the history sequence. Use setValue to specify the number.
FirstSequence Moves to the first sequence in the history.
PrevSequence Returns to the previous sequence in the history.
NextSequence Advances to the next sequence in the history.
LastSequence Moves to the last sequence in the history.
FormatCell Shows the format cell dialog for a specific data area grid cell.
Format Shows the format cell dialog for a specific row or column.
ShowHide Shows the show/hide elements dialog. Use the setValue function and set the Row and Column parameters accordingly before.
AddPortfolio Adds the current view to the portfolio. Shows the add portfolio page dialog.
EditPortfolio Shows the edit portfolio dialog.
GotoPortfolio Shows the "go to" portfolio dialog.
PlayPortfolio Starts showing the current portfolio.
StopPortfolio Stops playing the current portfolio.
FirstPortfolio Shows the first page of the portfolio.
PrevPortfolio Returns to the previous page of the portfolio.
NextPortfolio Advances to the next page of the portfolio.
LastPortfolio Shows the last page of the portfolio.
PortfolioGoto Goes to a particular page or slide in the portfolio.
SetPreferences Shows the preferences dialog.