Report Object

Syntax A

GetObject(pathname)

Syntax B

GetObject( , class )

Parameter	Description
PathName	Required. Specifies the path and file name for the object to retrieve. Type: String
Class	Required. Specifies a string containing the class of the object, "CognosPowerPlay.Report". Type: String

Parameter

Description

PathName

Required. Specifies the path and file name for the object to retrieve.

Type: String

Class

Required. Specifies a string containing the class of the object, "CognosPowerPlay.Report".

Type: String

Name	Description
Activate Method	Sets the focus on the Report object.
AddBlanks Method (Reporter)	Adds a single blank row or column to a nested crosstab.
CategoryList Method	Creates a CategoryList object used to identify categories to be inserted in the Report object.
CellValue Method	Gets the value of a cell in a Report object.
Close Method	Closes the Report object.
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 object to the Clipboard.
Cut Method (Reporter)	Moves the Row, Column, or Layer object currently selected in the Report object to the Clipboard.
DeleteSelected Method	Deletes selected objects in a collection.
DimensionLine Method	Returns a DimensionLine object for the current Report object.
Exceptions Method	Returns one Exception object or the entire collection.
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.
HideSelected Method	Hides selected objects in a collection.
HideUnselected Method	Hides any object in a collection that is not selected.
Layers Method	Returns one Layer object or the entire collection.
Maximize Method	Maximizes the Report object window.
Minimize Method	Minimizes the Report object window.
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.
Print Method	Returns a Print object.
PublishToPortal Method	Creates a report in the IBM Cognos Analytics content store. Users access the report using the Cognos Analytics portal.
ReportQueries Method	Returns a ReportQueries collection.
Restore Method	Restores the Report object window to its original size and position.
Rows Method	Returns one Row object or the entire collection.
Save Method	Saves one or all Report objects.
Select Method	Selects all the categories in the Report object.
SizeSelected Method	Applies a size to selected objects.
StyleSelected Method	Applies a style to the selected object.
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 all the categories in the Report object.
UpdatePublishedReport Method	Updates a report previously published to the IBM Cognos Analytics content store.

Name	Description
Application Property	Returns the Application object.
AutomaticExceptions Property	Sets or returns whether automatic highlighting of exceptions is on or off.
AutomaticExceptionSensitivity Property	Sets or returns the exceptional highlighting sensitivity.
CalculatedCategories Property	Sets or returns whether calculated categories are on or off, or whether a PowerCube contains calculated categories.
CubeName Property	Returns the file name of the cube for the active report.
ExplorerMode Property	Sets or returns whether the Report object is an Explorer or Reporter report.
FooterText Property	Sets or returns the text in the footer of a report.
FullName Property	Returns the full name, including the location, of the Report object.
GetDataAutomatically Property	Sets or returns whether the Report object retrieves data automatically each time it is modified.
HeaderText Property	Sets or returns the text in the header of a report.
Index Property	Returns the position of the Report object in the Reports collection.
Name Property	Returns the name of the Report object.
Path Property	Returns the path of the Report object.
Saved Property	Returns whether the Report object has been saved.
ShareDimensionLine Property	Sets or returns whether open reports share a dimension line.
ShowValuesAs Property (Explorer)	Sets or returns how to show values in a report.
Suppress8020 Property (Explorer)	Sets or returns the 80/20 suppress mode for report dimensions.
SuppressZeros Property	Sets or returns the suppress mode for the Report object.
TitleText Property	Sets or returns the text in the title of a report.
Visible Property	Sets or returns whether the Report object is visible to the user.

Discussion

This object is the basis for building and managing a report. Use this object to set and operate on the attributes of a report. Each Report object is a separate PowerPlay® report.

Use the GetObject function when there is a current instance of the Report object or if you want to create the object with a file already loaded. If there is no current instance and you do not want the object started with a file loaded, use the CreateObject function.

Use only the following syntax to retrieve an existing PowerPlay report with the GetObject function. Using other syntax will cause an error.

Example

This example opens an IBM Cognos PowerPlay report and sets a number of properties.

Sub Main()

   Dim objPPRep As Object

   Set objPPRep = CreateObject ("CognosPowerPlay.Report")

   objPPRep.Open ("C:\Cubes and Reports\Sample1.ppr")

   objPPRep.ExplorerMode = True

   objPPRep.Visible = True

   objPPRep.ShowValuesAs = 2

   objPPRep.ShareDimensionLine = 1

   objPPRep.Suppress8020 = 3

   objPPRep.SuppressZeros = 3

   objPPRep.CalculatedCategories = True

   Set objPPRep = Nothing

End Sub