BIMonitoringServiceApplicationProxy.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
Public 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 BIMonitoringServiceApplicationProxy
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)

public string GetDrillThroughPreview(
    RepositoryLocation fcoLocation,
    string isScorecard,
    string page,
    string tupleXml,
    string resultTableIndex,
    string isAccessibleMode,
    out string title,
    out byte[] officeDocumentBytes,
    out string documentFileName
)

Parameters

• fcoLocation
  Type: Microsoft.PerformancePoint.Scorecards.RepositoryLocation

  The location of the report in the repository.

• isScorecard
  Type: System.String

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

• page
  Type: System.String

  The data to return: A value that specifies the page of data to return with the results (for example, 1 returns 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.

• title
  Type: System.String

  The title.

• 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.

Implements

IBIMonitoringServiceApplicationProxy.GetDrillThroughPreview(RepositoryLocation, String, String, String, String, String, String, [], String)

See Also

Reference

BIMonitoringServiceApplicationProxy Class

BIMonitoringServiceApplicationProxy Members

Microsoft.PerformancePoint.Scorecards Namespace