ShapeCollection.GetChildIndex, méthode (Shape, Boolean)

Article
05/16/2015

Récupère l'index de la Shape spécifiée dans la ShapeCollection et lève éventuellement une exception si la Shape spécifiée n'est pas dans la ShapeCollection.

Espace de noms : Microsoft.VisualBasic.PowerPacks
Assembly : Microsoft.VisualBasic.PowerPacks.Vs (dans Microsoft.VisualBasic.PowerPacks.Vs.dll)

Syntaxe

'Déclaration
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

Paramètres

child
Type : Microsoft.VisualBasic.PowerPacks.Shape

Shape à rechercher dans la ShapeCollection.

throwException
Type : Boolean

true pour lever une exception si le Shape spécifié dans le paramètre child n'est pas un contrôle de ShapeCollection ; sinon, false.

Valeur de retour

Type : Int32
Valeur d'index de base zéro représentant l'emplacement de la classe Shape spécifiée dans la classe ShapeCollection.Ou -1 si la Shape spécifiée est introuvable dans la ShapeCollection.

Exceptions

Exception	Condition
ArgumentException	La forme child n'est pas dans la ShapeCollection et la valeur du paramètre l'throwException est true.

Notes

L'index représente l'ordre dans lequel les formes ont été ajoutées à la collection. Si des formes sont supprimées de la collection, les index des formes sont attribués à nouveau.

La valeur de retour -1 est retournée uniquement lorsque le paramètre throwException a la valeur false.

Exemples

L'exemple de code suivant montre comment utiliser la méthode de GetChildIndex pour extraire l'emplacement d'Shape dans ShapeCollection. Cet exemple requiert que vous disposez d'au moins deux contrôles d'OvalShape sur un formulaire.

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);
    }
}

Sécurité .NET Framework

Confiance totale accordée à l'appelant immédiat. Ce membre ne peut pas être utilisé par du code d'un niveau de confiance partiel. Pour plus d'informations, voir Utilisation de bibliothèques à partir de code d'un niveau de confiance partiel.