Share via

  • Article

KpiCollection.Move Method (String, Int32)

Moves a Kpi, with the specified identifier, to the specified index in the collection.

Namespace:  Microsoft.AnalysisServices
Assembly:  Microsoft.AnalysisServices (in Microsoft.AnalysisServices.dll)

Syntax

'Declaration
Public Function Move ( _
    id As String, _
    toIndex As Integer _
) As Kpi
'Usage
Dim instance As KpiCollection
Dim id As String
Dim toIndex As Integer
Dim returnValue As Kpi

returnValue = instance.Move(id, toIndex)

public Kpi Move(
    string id,
    int toIndex
)

public:
Kpi^ Move(
    String^ id, 
    int toIndex
)

member Move : 
        id:string * 
        toIndex:int -> Kpi 

public function Move(
    id : String, 
    toIndex : int
) : Kpi

Parameters

  • toIndex
    Type: System.Int32
    The zero-based index to which to move the Kpi specified by id.

Return Value

Type: Microsoft.AnalysisServices.Kpi
The Kpi to be moved.

Exceptions

Exception Condition
ArgumentOutOfRangeException

fromIndex is less than zero.

-or-

fromIndex is equal to or greater than [H:Microsoft.AnalysisServices.ModelComponentCollection.Count].

-or-

id is not contained by the collection.