Share via


IBIMonitoringServiceApplicationProxy.GetDrillThroughPreview method

Performs a drillthrough query on an OLAP data cell.

Namespace:  Microsoft.PerformancePoint.Scorecards
Assembly:  Microsoft.PerformancePoint.Scorecards.ServerCommon (in Microsoft.PerformancePoint.Scorecards.ServerCommon.dll)

Syntax

'Declaration
Function GetDrillThroughPreview ( _
    fcoLocation As RepositoryLocation, _
    isScorecard As String, _
    page As String, _
    tupleXml As String, _
    resultTableIndex As String, _
    isAccessibleMode As String, _
    <OutAttribute> ByRef title As String, _
    <OutAttribute> ByRef officeDocumentBytes As Byte(), _
    <OutAttribute> ByRef documentFileName As String _
) As String
'Usage
Dim instance As IBIMonitoringServiceApplicationProxy
Dim fcoLocation As RepositoryLocation
Dim isScorecard As String
Dim page As String
Dim tupleXml As String
Dim resultTableIndex As String
Dim isAccessibleMode As String
Dim title As String
Dim officeDocumentBytes As Byte()
Dim documentFileName As String
Dim returnValue As String

returnValue = instance.GetDrillThroughPreview(fcoLocation, _
    isScorecard, page, tupleXml, resultTableIndex, _
    isAccessibleMode, title, officeDocumentBytes, _
    documentFileName)
string GetDrillThroughPreview(
    RepositoryLocation fcoLocation,
    string isScorecard,
    string page,
    string tupleXml,
    string resultTableIndex,
    string isAccessibleMode,
    out string title,
    out byte[] officeDocumentBytes,
    out string documentFileName
)

Parameters

  • isScorecard
    Type: System.String

    true if the request originated from a scorecard view; otherwise false.

  • page
    Type: System.String

    A value that specifies the data to return with the results. For example, 1 to return the first page of data; 0 to return all data; or excel to export the data and include the result elements of officeDocumentBytes and documentFileName.

  • tupleXml
    Type: System.String

    The named filters to apply to the results.

  • resultTableIndex
    Type: System.String

    If specified, the zero-based value that indicates the index of the drillthrough cell-level action to retrieve. For example, a value of "0" returns the first drillthrough cell-level action that is associated with this cell.

  • isAccessibleMode
    Type: System.String

    true if the client is in accessibility mode; otherwise false.

  • officeDocumentBytes
    Type: []

    The document returned with the exported results (if page is set to excel).

  • documentFileName
    Type: System.String

    The name of the Microsoft Excel file returned with the exported results (if page is set to excel).

Return value

Type: System.String
The preview results, as specified by the page parameter.

See also

Reference

IBIMonitoringServiceApplicationProxy interface

IBIMonitoringServiceApplicationProxy members

Microsoft.PerformancePoint.Scorecards namespace