Share via


BIMonitoringServiceApplicationProxy.GetParameterDisplayData Method

Gets the display data for a parameter.

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

Syntax

'Declaration
Public Function GetParameterDisplayData ( _
    providerLocation As RepositoryLocation, _
    parameterDefinition As ParameterDefinition, _
    parameterSourceLocation As RepositoryLocation, _
    webPartContext As WebPartContext _
) As DataTable
'Usage
Dim instance As BIMonitoringServiceApplicationProxy
Dim providerLocation As RepositoryLocation
Dim parameterDefinition As ParameterDefinition
Dim parameterSourceLocation As RepositoryLocation
Dim webPartContext As WebPartContext
Dim returnValue As DataTable

returnValue = instance.GetParameterDisplayData(providerLocation, _
    parameterDefinition, parameterSourceLocation, _
    webPartContext)
public DataTable GetParameterDisplayData(
    RepositoryLocation providerLocation,
    ParameterDefinition parameterDefinition,
    RepositoryLocation parameterSourceLocation,
    WebPartContext webPartContext
)

Parameters

Return Value

Type: System.Data.DataTable
The display data for a parameter.

Implements

IBIMonitoringServiceApplicationProxy.GetParameterDisplayData(RepositoryLocation, ParameterDefinition, RepositoryLocation, WebPartContext)

Remarks

Before updating a filter object in the repository, custom editors must call GetParameterDisplayData(RepositoryLocation, ParameterDefinition, RepositoryLocation, WebPartContext) at least once. This initializes the filter by running its query and retrieving data from the data source.

Examples

The following code example calls GetParameterDisplayData(RepositoryLocation, ParameterDefinition, RepositoryLocation, WebPartContext) to initialize a filter.

Before you can compile this code example, you must do the following:

private static IBIMonitoringServiceApplicationProxy proxy;

// Get an instance of the service application proxy.
public IBIMonitoringServiceApplicationProxy Proxy
{
    get
    {
        if (null == proxy)
        {
            proxy = BIMonitoringServiceApplicationProxy.Default;
        }
        return proxy;
    }
}

// Initializes the ParameterDefinition.DisplayValues of each BeginPoint for the specified filter.
public void GetParameterDisplayData(ref Filter filter)
{
    if (null != filter)
    {
        if (null != filter.DataSourceLocation)
        {
            foreach (ParameterDefinition parameterDefinition in filter.BeginPoints)
            {
                DataTable dataTable = Proxy.GetParameterDisplayData(null, parameterDefinition,
                                                                               filter.DataSourceLocation, null);

                if (null != dataTable)
                {
                    parameterDefinition.DisplayValues = dataTable.Clone();
                    parameterDefinition.DisplayValues.Rows.Clear();
                }
            }
        }
    }
}

See Also

Reference

BIMonitoringServiceApplicationProxy Class

BIMonitoringServiceApplicationProxy Members

Microsoft.PerformancePoint.Scorecards Namespace