Row Object

An object used to manipulate a row in a report.

Discussion

A Row object is a category that shows related information in a horizontal list. To use this object, first add categories to the report from the CategoryList object or open an existing report.

You can perform calculations, drill-up, drill-down, hide, rank and remove Row objects. You use an index to refer to the position of a Row object in the Rows collection.

Certain methods are only available in Reporter mode.

Name

Description

Accumulation Method

Accumulates all the values of the categories in the Row object.

Activate Method

Sets the focus on the Row object.

Addition Method (Objects)

Adds a constant value or a category to the Row object.

AddLowestLevelCategories Method (Reporter)

Adds the lowest-level categories to a report.

Average Method (Objects) (Reporter)

Determines the average between either a constant value or another category and the Row object.

CanDrillDown Method

Returns whether you can drill down the Row object.

CanDrillUp Method

Returns whether you can drill up the Row object.

Children Method

Returns the next child in the hierarchy for the Row object.

CumPercentOfBase Method

Adds a Cumulative Percent of Base Row object using a Column object as the base category.

Division Method

Divides the Row object by either a constant value or another category.

DrillDown Method

Drills down the Row object.

DrillUp Method

Drills up the Row object.

Exponentiation Method

Raises the Row object to the power of either another category or a constant value.

Hide Method

Hides the Row object.

Maximum Method (Objects) (Reporter)

Determines the maximum between either a constant value or another category and the Row object.

Minimum Method (Objects) (Reporter)

Determines the minimum between either a constant value or another category and the Row object.

Multiplication Method (Objects)

Multiplies a constant value or another category by the Row object.

Percent Method

Adds a percent Row object based on either another category or a constant value.

PercentGrowth Method

Calculates the percentage change between two categories or measures.

PercentOfBase Method

Adds a Percent of Base Row object using a Column object as the base category.

Rank2 Method

Ranks and sorts the Column objects based on the Row object.

Remove Method

Removes the Row object from the report.

Rollup Method

Groups categories containing calculated values to create a new, dynamic calculation.

Select Method

Selects the Row object.

SelectBlank Method

Selects a specific blank row.

Subtraction Method (Objects)

Subtracts a constant value or another category from the Row object, or subtracts the Row object from the category or constant value.

Unselect Method

De-selects the Row object.

UnselectBlank Method

Unselects a specific blank row.

Name

Description

Application Property

Returns the Application object.

CellText Property

Returns the text in a cell.

CellValueAlignment Property

Returns the alignment applied to a cell value in a report.

CellValueFontColor Property

Returns the font color applied to a cell value in a report.

CellValueFontName Property

Returns the name of the font applied to a cell value in a report.

CellValueFontSize Property

Returns the size of the font applied to a cell value in a report.

Exception Property

Sets or returns the exception for the Row object.

Index Property

Returns the position of the Row object in the Rows collection.

IsAlternate Property

Returns whether the drill-down path is primary or alternate.

IsCalculatedCategory Property

Returns whether the category is a calculated category.

LabelAlignment Property

Returns the alignment applied to a category label in a report.

LabelFontColor Property

Returns the font color applied to a category label in a report.

LabelFontName Property

Returns the name of the font applied to a category label in a report.

LabelFontSize Property

Returns the size of the font applied to a category label in a report.

Level Property

Returns the level of the category in a dimension.

Name Property

Sets or returns the name of the Row object.

NestedName Property

Returns the nested name for a category.

ParentCategory Property

Returns the name of the parent category for the object.

Precedence Property

Sets or returns the precedence used in complex calculations.

Style Property

Sets or returns the style used for the Row object.

TopLevelParentCategory Property

Returns the name of the dimension for the object.

Example

This example opens a report, looks for the Column object "1996" in the Columns collection, changes the name to "Last Year", and saves the report.

Sub Main()
   Dim objPPRep as Object
   Set objPPRep = CreateObject ("CognosPowerPlay.Report")
   objPPRep.Open "C:\Cubes and Reports\Sample1.ppr"
   objPPRep.Rows.Item("1996").Name = "Last Year"
   objPPRep.Save
   Set objPPRep = Nothing
End Sub

Related Topics