Share via

KpiCollection.Move Method (Int32, Int32)

Moves a Kpi, at the current specified index, to a new specified index in the collection.

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

Syntax

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

returnValue = instance.Move(fromIndex, _
    toIndex)

public Kpi Move(
    int fromIndex,
    int toIndex
)

public:
Kpi^ Move(
    int fromIndex, 
    int toIndex
)

member Move : 
        fromIndex:int * 
        toIndex:int -> Kpi 

public function Move(
    fromIndex : int, 
    toIndex : int
) : Kpi

Parameters

  • fromIndex
    Type: System.Int32
    The zero-based index of the Kpi to be moved.
  • toIndex
    Type: System.Int32
    The zero-based index to which to move the Kpi specified by fromIndex.

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-

toIndex is less than zero.

-or-

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