DrillThrough (Method)

Applies To:

TopLabels collection, SideLabels collection, Measures collection

Description:

Executes the drill-through from a multi-dimensional database to a relational database. The DrillThrough() method assumes that a connection to relational and OLAP queries exists. Each method uses the BqDrillThroughPrompt constant group.

Note:

The dialog prompt for DrillThrough() is not a requirement in the EPM Workspace. The Prompt Dialog is ignored and the default Prompt Option is taken. If a Prompt Option is not specified, the default of New Pivot is assumed.

Syntax:

Expression.DrillThrough([optional] Number [promptOption, [optional] String pivotName, [optional] Boolean promptDialog]

Also note these optional arguments:

promptOption (Number)—Specific one of the following prompt options: select 1 for an UpdatePivot, 3 for a NewPivot, or 2 for a Cancel. If you do not specify a prompt option, the default option is 1 (NewPivot).
pivotName (String)—Specify the name of either the existing pivot to update if UpdatePivot is selected as the PromptOption. If the name is required but not specified, the default name used is the first pivot in the drop-down list (which is also the first in Catalog pane).
promptDialog (Boolean)—Specify whether the dialog prompts will display. If this option is enabled, all related prompts display. If this option is not enabled, no prompts display and default values are assumed.

Expression Required:

An expression that executes a drill through command

Constants:

The DrillThrough (Method) uses the BqDrillThroughPrompt constant group, which consists of these values:

bqDrillThroughPromptCancel = 2

bqDrillThroughPromptNew = 3

bqDrillThroughPromptUpdate = 1

Example:

This example shows how to drill up a drilled-down value:

ActiveDocument.Sections["OLAPQuery"].DrillThrough( 2,"Pivot",true)