ShapeCollection.GetChildIndex-Methode (Shape, Boolean)

Ruft den Index des angegebenen Shape in ShapeCollectionab und löst optional eine Ausnahme aus, wenn der angegebene Shape nicht in ShapeCollectionist.

Namespace: Microsoft.VisualBasic.PowerPacks
Assembly: Microsoft.VisualBasic.PowerPacks.Vs (in Microsoft.VisualBasic.PowerPacks.Vs.dll)

Syntax

'Declaration
Public Function GetChildIndex ( _
    child As Shape, _
    throwException As Boolean _
) As Integer

public int GetChildIndex(
    Shape child,
    bool throwException
)

public:
int GetChildIndex(
    Shape^ child, 
    bool throwException
)

member GetChildIndex : 
        child:Shape * 
        throwException:bool -> int

public function GetChildIndex(
    child : Shape, 
    throwException : boolean
) : int

Parameter

child
Typ: Microsoft.VisualBasic.PowerPacks.Shape
Die Shape, die in ShapeCollection gesucht werden soll.

throwException
Typ: System.Boolean
true , um eine Ausnahme auszulösen, wenn das im child-Parameter angegebene Shape kein Steuerelement in der ShapeCollection ist, andernfalls false.

Rückgabewert

Typ: System.Int32
Ein nullbasierter Indexwert, der die Position des angegebenen Shape in ShapeCollectiondarstellt.Oder -1, wenn das angegebene Shape nicht in ShapeCollectiongefunden wird.

Ausnahmen

Ausnahme	Bedingung
ArgumentException	Die child Form befindet sich nicht in ShapeCollection und der Parameterwert ist throwExceptiontrue.

Hinweise

Der Index wird die Reihenfolge an, in der die Formen der Auflistung hinzugefügt wurde.Wenn Forms aus der Auflistung entfernt wird, werden die Indizes der Forms erneut zugewiesen.

Der Wert "-1" wird nur dann zurückgegeben, wenn der throwException-Parameter auf false festgelegt ist.

Beispiele

Im folgenden Codebeispiel wird veranschaulicht, wie die GetChildIndex-Methode verwendet, um den Speicherort von Shape in ShapeCollectionabzurufen.Dieses Beispiel setzt voraus, dass Sie mindestens zwei OvalShape-Steuerelementen auf einem Formular verfügen.

Private Sub OvalShape1_Click() Handles OvalShape1.Click
    Dim i As Integer
    ' Find the index for OvalShape1.
    i = OvalShape1.Parent.Shapes.GetChildIndex(OvalShape2, False)
    ' If the shape is not in the collection, display a message.
    If i = -1 Then
        MsgBox("OvalShape2 is not in this collection.")
    Else
        MsgBox("The index for OvalShape2 is " & CStr(i))
    End If
End Sub

private void ovalShape1_Click(System.Object sender, System.EventArgs e)
{
    int i;
    // Find the index for OvalShape1.
    i = ovalShape1.Parent.Shapes.GetChildIndex(ovalShape2, false);
    // If the shape is not in the collection, display a message.
    if (i==-1)
    {
        MessageBox.Show("ovalShape2 is not in this collection.");
    }
    else
    {
        String index;
        index = i.ToString();
        MessageBox.Show("The index for ovalShape2 is " + index);
    }
}

.NET Framework-Sicherheit

Volle Vertrauenswürdigkeit für den unmittelbaren Aufrufer. Dieser Member kann von nur teilweise vertrauenswürdigem Code nicht verwendet werden. Weitere Informationen finden Sie unter Verwenden von Bibliotheken aus teilweise vertrauenswürdigem Code.