Methods

You work with the following methods for IBM® Cognos® PowerPlay® OLE automation.

Name	Description
Accumulation Method	Accumulates all the values of the categories in an object or a collection.
Activate Method	Sets the focus on an object.
Active Method	Returns the active object in the collection.
ActiveReport Method	Returns the active Report object for the Application object.
Add Method (CategoryList)	Adds one or more categories to a CategoryList object.
Add Method (Columns, Layers, Rows)	Adds one or more objects a collection, or to an object that maintains a list of other objects.
Add Method (Exceptions)	Adds an Exception object to the Exceptions collection.
Add Method (Graphs)	Adds a Graph object to the Graphs collection.
Add Method (Ranges)	Adds a Range object to the Ranges collection.
Add Method (ReportQueries)	Adds a query object to the ReportQueries collection.
Add Method (Reports)	Adds a Report object to the Reports collection.
AddBlanks Method (Reporter)	Adds a single blank row or column to a nested crosstab.
Addition Method (Collections)	Adds a constant value or a category to one or more objects in the collection.
Addition Method (Objects)	Adds a constant value or a category to an object.
AddLevel Method	Adds a row, column, or layer level to a nested crosstab.
AddLowestLevelCategories Method (Reporter))	Adds the lowest-level categories to a report.
AddToReport Method	Adds query results to a report.
AddToReportAtSpecificNestingLevel Method	Adds query results to a report at a specific nesting level.
Add Method (CategoryList)	Returns the average of a constant value or a category, and either one or more categories.
Average Method (Objects) (Reporter)	Determines the average between a constant value or another category and an object.
CanDrillDown Method	Returns whether you can drill down the category object.
CanDrillUp Method	Returns whether you can drill up the category object.
Category Method	Sets the parent category or dimension for the ParentageQuery subset definition.
CategoryList Method	Creates a CategoryList object which is used to identify categories to be inserted in the Report object.
CellValue Method	Gets the value of a cell in a Report object.
Change Method	Changes the current category for the Dimension.
ChangeToParent Method	Changes the current category for the Dimension object to the category one level higher in the hierarchy.
ChangeToTop Method	Changes the current category for the Dimension object to top-level category.
Children Method	Returns the next child in the hierarchy for an object.
Close Method	Closes one or all the Report objects.
Columns Method	Returns a collection that contains all the Column objects.
Copy Method	Copies the Row, Column, or Layer objects currently selected in the report to the Clipboard.
CumPercentOfBase Method	Adds one or more Cumulative Percent of Base category using a category from a different dimension as the base.
Cut Method (Reporter)	Moves the Row, Column, or Layer objects currently selected to the Clipboard.
DeleteAllMDCAccessInfo Method	Deletes PowerCube security access information from memory for all cubes.
DeleteExplorerRank Method	Deletes the rank category from an Explorer report.
DeleteDataSourceInfo Method	Deletes PowerCube security access information from memory for the specified cube.
DeleteAllDataSourceInfo Method	Deletes security access information from memory for all PowerCubes.
DeleteMDCAccessInfo Method	Deletes security access information for a local PowerCube from memory.
DeleteSelected Method	Deletes selected objects from a Report collection.
DeploymentOptions Method	Returns the distribution options for a report published to the IBM Cognos portal.
Depth Method	Returns whether the Graph object is three-dimensional (3D).
DimensionFilter Method	Sets the filter category for an indexed dimension.
DimensionLine Method	Returns a DimensionLine object for the current Report object.
Division Method	Divides one or more categories by either a constant value or another category.
DrillDown Method	Drills down the category object.
DrillUp Method	Drills up the category object.
Exceptions Method	Returns one Exception object or the entire collection.
Exclude Method	Sets the categories to exclude from the query.
Execute Method	Runs a query on the cube.
Exponentiation Method	Raises one or more categories to the power of either another category or a constant value.
Find Method	Specifies the name of the FindQuery object to include in an AdvancedQuery.
FindNext Method	Finds the next matching category label in a report.
FindPrevious Method	Finds the previous matching category label in a report.
Forecast Method (Explorer)	Creates a specified number of forecast categories, based on the existing time dimensions.
GetDataNow Method	Updates the data in the Report object.
Graphs Method	Returns one Graph object or the entire collection.
HasParent Method	Returns whether the current category has a parent.
Hide Method	Hides the category.
HideSelected Method	Hides selected objects in a collection.
HideUnselected Method	Hides any object in a collection that is not selected.
Include Method	Sets the categories to include in the query.
Item Method	Returns an object from the collection or object that maintains a list of other objects.
ItemAtLevel Method	Returns either a row or column object from a nested report.
Layers Method	Returns one Layer object or the entire collection.
Level Method	Sets the level used by the AdvancedQuery object to retrieve categories for the query.
Levels Method	Returns all levels available in the dimension for a category.
Logon Method	Logs on to IBM Cognos Analytics as an authenticated user to provide the application object access to secured IBM Cognos Analytics resources such as packages.
Logoff Method	Revokes authentication to all IBM Cognos Analytics namespaces for the application object. Even if you used multiple namespaces in the session, you logoff only once.
Maximize Method	Maximizes the object window.
Maximum Method (Collections) (Reporter)	Determines the maximum between either a constant value or a category, and one or more categories.
Maximum Method (Objects) (Reporter)	Determines the maximum between either a constant value or a category, and one or more categories.
Minimize Method	Minimizes the object window.
Minimum Method (Collections) (Reporter)	Determines the minimum between either a constant value or a category, and one or more categories.
Minimum Method (Objects) (Reporter)	Determines the minimum between either a constant value or a category, and one or more categories.
Multiplication Method (Collections)	Multiplies a constant value or a category by one or more categories.
Multiplication Method (Objects)	Multiplies a constant value or a category by an object.
New Method	Creates a new Report object.
Open Method (Report)	Opens an existing Report object.
Open Method (Reports)	Opens a collection of Report objects.
OpenRemoteReport Method	Opens an existing remote report object.
Parent Method	Returns the name of the parent category.
Paste Method (Reporter)	Pastes the contents of the Clipboard into the selected categories of the Report object.
PDFFile Method	Sets the file name of the PDF object when it is saved.
Percent Method	Adds one or more percent categories based on either a category or a constant value.
PercentGrowth Method	Calculates the percentage change between two categories or measures.
PercentOfBase Method	Adds one or more percent of base categories using a category from a different dimension as the base.
Print Method	Returns a Print object.
PrintOut Method	Prints the Report object.
PublishToPortal Method	Creates a report in the IBM Cognos Analytics content store. Users access the report using the Cognos Analytics portal.
Quit Method	Exits PowerPlay.
Ranges Method	Returns one Range object or the entire collection.
Rank2 Method	Ranks and sorts Row or Column objects.
Remove Method	Removes a single object or all objects from a collection.
Remove Method (ReportQueries)	Removes all query objects from the ReportQueries collection.
RemoveLevel Method	Removes a column, layer, or row level from a nested crosstab in a report.
ReportQueries Method	Returns a ReportQueries collection.
Reports Method	Returns one Report object or the entire collection.
ResetPrintOptionsToDefault Method	Resets print options back to the default settings.
Restore Method	Restores the object window to its original size and position.
Rollup Method	Groups categories containing calculated values to create a new, dynamic calculation.
Rows Method	Returns one Row object or the entire collection.
Save Method	Saves one or all Report objects.
SaveAs Method	Saves the Report object with a different name, and if desired, a different format.
Select Method	Selects categories.
SelectAllDimensions Method	Selects all the dimension objects in the dimension line that can be filtered when a report is opened in the IBM Cognos portal.
SelectBlank Method	Selects a specific blank row or column.
SetChartToPrint Method	Specifies which Graph object of a report to print.
SetChartToSave Method	Specifies which Graph object to save in a PDF.
SetDataSourceInfo Method	Stores security information for a data source in memory.
SetDrivingCategory Method	Sets the driving category for the Exception object.
SetListOfLayersToPrint Method	Specifies the range of layers of the report to print.
SetListOfLayersToSave Method	Specifies the range of layers to save in a PDF.
SetListOfRowsToPrint Method	Specifies the range of rows of the report to print.
SetListOfRowsToSave Method	Specifies the range of rows to save in a PDF.
SetMacro Method	Sets the name and style for the macro used by the Exception object.
SetMDCAccessInfo Method	Stores PowerCube security access information in memory.
SetType Method	Sets the Graph object type.
SizeSelected Method	Applies a size to selected objects.
Sort Method	Sorts columns, layers, or rows in ascending or descending order.
StyleSelected Method	Applies a style to the selected object.
Subset Method	Returns a subset of objects from the current collection.
Subtraction Method (Collections)	Subtracts a constant value or a category from one or more categories in the collection, or subtracts all categories from a constant value or another category.
Subtraction Method (Objects)	Subtracts a constant value or another category from an object, or subtracts an object from the category or constant value.
SwapColumnsAndLayers Method	Exchanges the positions of the Column objects and Layer objects.
SwapRowsAndColumns Method	Exchanges the positions of the Row objects and Column objects.
SwapRowsAndLayers Method	Exchanges the positions of the Row objects and Layer objects.
UnhideAllCategories Method	Makes all hidden categories visible.
Unselect Method	De-selects categories.
UnselectBlank Method	Unselects a specific blank row or column.
UnselectAllDimensions Method	Clears all selected dimension objects in the dimension line that can be filtered when a report is opened in the IBM Cognos portal.
UpdatePublishedReport Method	Updates a report previously published to the IBM Cognos Analytics content store.
ValueRestriction Method	Returns the value restriction for an AdvancedQuery object.
Vertical Method	Returns whether the Graph object is a vertical display.