IMetricSetService.AddTopBottomSettings Method

Adds top/bottom settings to the metric set and then saves the metric set.

Namespace: Dundas.BI.Entities.MetricSets
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (25.1.0.1000)

Syntax

C++

Copy

TopBottomSettings AddTopBottomSettings(
	MetricSet metricSet,
	string measureUniqueName,
	int topRecords,
	int bottomRecords
)

Function AddTopBottomSettings ( 
	metricSet As MetricSet,
	measureUniqueName As String,
	topRecords As Integer,
	bottomRecords As Integer
) As TopBottomSettings

TopBottomSettings^ AddTopBottomSettings(
	MetricSet^ metricSet, 
	String^ measureUniqueName, 
	int topRecords, 
	int bottomRecords
)

abstract AddTopBottomSettings : 
        metricSet : MetricSet * 
        measureUniqueName : string * 
        topRecords : int * 
        bottomRecords : int -> TopBottomSettings

Parameters

metricSet: Type: Dundas.BI.Entities.MetricSets.MetricSet
The metric set.
measureUniqueName: Type: System.String
The unique name of the measure for which top/bottom analysis is performed.
topRecords: Type: System.Int32
The number of records with the highest values.
bottomRecords: Type: System.Int32
The number of records with the lowest values.

Return Value

Type: TopBottomSettings
The top/bottom settings property.

Exceptions

Exception	Condition
ArgumentNullException	metricSet is null.
ArgumentException	measureUniqueName does not reference a valid measure.
InvalidSessionException	The caller context is not associated with a valid session.

Reference

IMetricSetService Interface

Dundas.BI.Entities.MetricSets Namespace

IMetricSetService.AddLanguageSpecificTextSet("LST9F08635A_0?cpp=::|nu=.");AddTopBottomSettings Method

Parameters

Return Value

Reference

IMetricSetService.AddTopBottomSettings Method