ShapeCollection.GetChildIndex-Methode (Shape, Boolean)

Artikel
05/16/2015

Ruft den Index der angegebenen Shape in der ShapeCollection ab und löst optional eine Ausnahme aus, wenn die angegebene Shape nicht in der ShapeCollection ist.

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: 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: Int32
Ein nullbasierter Indexwert, der den Ort der angegebenen Shape in der ShapeCollection darstellt.Oder -1, wenn die angegebene Shape nicht im angegebenen Abschnitt "ShapeCollection" gefunden wurde.

Ausnahmen

Ausnahme	Bedingung
ArgumentException	Die child-Form ist nicht in der ShapeCollection enthalten und der throwException-Parameterwert ist true.

Hinweise

Der Index stellt dar die Reihenfolge, in der die Formen zur Auflistung hinzugefügt wurden. Wenn Formen aus der Auflistung entfernt werden, werden die Indizes der Formen neu zugewiesen.

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

Beispiele

Das folgende Codebeispiel zeigt, wie die GetChildIndex-Methode verwendet, um den Speicherort von Shape in ShapeCollection. Dieses Beispiel erfordert, dass sich mindestens zwei OvalShape-Steuerelementen auf einem Formular befinden.

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.