Instrucción For Each...Next (Visual Basic)
Repite un grupo de instrucciones para cada elemento de una colección.
For Each element [ As datatype ] In group
[ statements ]
[ Continue For ]
[ statements ]
[ Exit For ]
[ statements ]
Next [ element ]
Partes
Término |
Definición |
element |
Se requiere en la instrucción For Each. Opcional en la instrucción Next. Variable. Se usa para recorrer en iteración los elementos de la colección. |
datatype |
Es obligatorio, a menos que element no se haya declarado ya. Tipo de datos de element. |
group |
Obligatorio. Variable de objeto. Hace referencia a la colección sobre la que se debe repetir la ejecución de statements. |
statements |
Opcional. Una o más instrucciones entre For Each y Next que se ejecutan en cada elemento de group. |
Continue For |
Opcional. Transfiere el control al principio del bucle For Each. |
Exit For |
Opcional. Transfiere el control fuera del bucle For Each. |
Next |
Obligatorio. Termina la definición del bucle For Each. |
Comentarios
Utilice un bucle For Each...Next cuando desee repetir un conjunto de instrucciones para cada elemento de una colección o matriz.
Visual Basic evalúa la colección solo una vez, antes de que comience el bucle. Si el bloque de instrucciones cambia element o group, estos cambios no afectan a la iteración del bucle.
Cuando todos los elementos de la colección se han asignado correctamente a element, el bucle For Each se detiene y el control pasa a la instrucción que sigue a la instrucción Next.
Si element no se ha declarado fuera de este bucle, se debe declarar en la instrucción For Each. Puede declarar el tipo de element explícitamente mediante una instrucción As o bien puede basarse en la inferencia de tipos para asignar el tipo. En ambos casos, el ámbito de element es el cuerpo del bucle. Sin embargo, no se puede declarar element fuera y dentro del bucle.
Opcionalmente, puede especificarse element en la instrucción Next. Esto mejora la legibilidad del programa, sobre todo si se han anidado bucles For Each. La variable que se especifique debe ser igual a la que aparece en la instrucción For Each correspondiente.
Puede que desee evitar cambiar el valor de element dentro de un bucle. Esto puede hacer más difícil leer y depurar el código. Cambiar el valor de group no afecta a la colección o sus elementos, que se determinaron en el momento de entrar en el bucle.
.gif "Sugerencia") Sugerencia |
|---|
Una Instrucción For...Next (Visual Basic) funciona bien cuando se puede asociar cada iteración de un bucle con una variable de control y determinar los valores iniciales y finales de esa variable. Sin embargo, cuando se trata de colecciones, el concepto de valores iniciales y finales no es significativo, y no siempre se sabe cuántos elementos tiene la colección. En este caso, el bucle For Each...Next es la mejor opción. |
Si el código utilizado depende del recorrido de una colección en un orden concreto, un bucle For Each...Next no es la mejor opción, a menos que conozca las características del objeto enumerador que expone la colección. El orden de recorrido no lo determina Visual Basic, sino el método MoveNext del objeto enumerador. Por tanto, tal vez no pueda predecir qué elemento de la colección es el primero que se devuelve en element o qué elemento es el siguiente en ser devuelto tras un elemento dado. Es posible obtener resultados más confiables si se utiliza una estructura de bucle diferente, tal como For...Next o Do...Loop.
Bucles anidados
Se pueden anidar bucles For Each colocando un bucle dentro de otro. Sin embargo, cada bucle debe tener una variable element única.
También puede anidar distintos tipos de estructuras de control unos dentro de otros. Para obtener más información, vea Estructuras de control anidadas (Visual Basic).
Si una instrucción Next de un nivel de anidamiento externo se encuentra antes de la instrucción Next de un nivel interno, el compilador genera un error. Sin embargo, el compilador sólo puede detectar este error superpuesto si se especifica element en cada instrucción Next.
Salida de
La instrucción Exit For hace que la ejecución salga del bucle For...Next y transfiera el control a la instrucción que sigue a la instrucción Next.
Puede colocar cualquier número de instrucciones Exit For en un bucle For Each . Cuando se utiliza dentro de bucles For Each anidados, Exit For hace que la ejecución salga del bucle más profundo y transfiera el control al siguiente nivel de anidamiento.
Exit For se utiliza a menudo después de evaluar alguna condición, por ejemplo, en una estructura If...Then...Else. Puede que desee utilizar Exit For para las siguientes condiciones:
Continuar la iteración es innecesario o imposible. Esto podría deberse a un valor erróneo o una solicitud de terminación.
Se detecta una excepción en Try...Catch...Finally. Puede utilizar Exit For al final del bloque Finally .
Hay un bucle infinito, que es un bucle que se podría ejecutar muchas o incluso infinitas veces. Si se detecta este tipo de condición, se puede utilizar Exit For para escapar del bucle. Para obtener más información, vea Instrucción Do...Loop (Visual Basic).
la instrucción Continue For transfiere el control inmediatamente a la siguiente iteración del bucle. Para obtener más información, vea Continue (Instrucción, Visual Basic).
Tipos de datos
El tipo de datos de element debe ser tal que el tipo de datos de los elementos de group se pueda convertir en él.
El tipo de datos de group debe ser un tipo de referencia que hace referencia a una colección o una matriz enumerable. Normalmente, esto significa que group hace referencia a un objeto que implementa la interfaz IEnumerable del espacio de nombres System.Collections o la interfaz IEnumerable<T> del espacio de nombres System.Collections.Generic. System.Collections.IEnumerable define el método GetEnumerator, que devuelve un objeto enumerador para la colección. El objeto enumerador implementa la interfaz System.Collections.IEnumerator del espacio de nombres System.Collections y expone la propiedad Current y los métodos Reset y MoveNext. Visual Basic los utiliza para recorrer la colección.
Los elementos de group normalmente son del tipo Object pero pueden tener cualquier tipo de datos en tiempo de ejecución.
Conversiones de restricción
Cuando Option Strict está establecido en On, las conversiones de restricción suelen producir errores del compilador. Sin embargo, en una instrucción For Each, las conversiones de los elementos de group a element se evalúan y realizan en tiempo de ejecución, y se suprimen los errores del compilador causados por las conversiones de restricción.
En el ejemplo siguiente, la asignación de m como valor inicial de n no se compila si Option Strict está activado porque la conversión de Long a Integer es una conversión de restricción. En la instrucción For Each, sin embargo, no se informa de ningún error del compilador, a pesar de que la asignación a number requiere la misma conversión de Long a Integer. En la instrucción For Each que contiene un gran número, se produce un error en tiempo de ejecución cuando ToInteger se aplica al gran número.
Option Strict On
Module Module1
Sub Main()
' The assignment of m to n causes a compiler error when
' Option Strict is on.
Dim m As Long = 987
'Dim n As Integer = m
' The For Each loop requires the same conversion but
' causes no errors, even when Option Strict is on.
For Each number As Integer In New Long() {45, 3, 987}
Console.Write(number & " ")
Next
Console.WriteLine()
' Output: 45 3 987
' Here a run-time error is raised because 9876543210
' is too large for type Integer.
'For Each number As Integer In New Long() {45, 3, 9876543210}
' Console.Write(number & " ")
'Next
Console.ReadKey()
End Sub
End Module
Llamadas a IEnumerator
Cuando comienza la ejecución de un bucle For Each...Next, Visual Basic comprueba que group hace referencia a un objeto de colección válido. Si no, produce una excepción. De lo contrario, llama al método MoveNext y a la propiedad Current del objeto enumerador para devolver el primer elemento. Si MoveNext indica que no hay un elemento siguiente, es decir, si la colección está vacía, el bucle For Each se detiene y el control pasa a la instrucción que sigue a Next. De lo contrario, Visual Basic establece element en el primer elemento y ejecuta el bloque de instrucciones.
Cada vez que Visual Basic encuentra la instrucción Next, vuelve a la instrucción For Each. Llama de nuevo a MoveNext y Current para devolver el elemento siguiente, y una vez más ejecuta el bloque o se detiene el bucle según el resultado. Este proceso continúa hasta que MoveNext indica que no hay ningún elemento siguiente o se encuentra una instrucción Exit For.
Modificaciones
Modificar la colección. Normalmente, el objeto enumerador devuelto por GetEnumerator no permite cambiar la colección agregando, eliminando, reemplazando o reordenando elementos. Si se modifica la colección después de haber iniciado un bucle For Each...Next, el objeto enumerador deja de ser válido y el siguiente intento de acceso a un elemento produce una excepción InvalidOperationException.
Sin embargo, este bloqueo de la modificación no viene determinado por Visual Basic sino por la implementación de la interfaz IEnumerable. Es posible implementar IEnumerable de modo que se permita la modificación durante la iteración. Si piensa realizar este tipo de modificación dinámica, asegúrese de que conoce las características de la implementación de IEnumerable en la colección que está utilizando.
Modificar los elementos de colección. La propiedad Current del objeto enumerador es ReadOnly (Visual Basic) y devuelve una copia local de cada elemento de la colección. Esto significa que no es posible modificar los propios elementos en un bucle For Each...Next. Cualquier modificación que se realice afectará sólo a la copia local de Current y no se verá reflejada de nuevo en la colección subyacente. Sin embargo, si un elemento es un tipo de referencia, es posible modificar los miembros de la instancia a los que apunta. Esto se puede ver en el ejemplo siguiente.
Sub lightBlueBackground(ByVal thisForm As System.Windows.Forms.Form)
For Each thisControl As System.Windows.Forms.Control In thisForm.Controls
thisControl.BackColor = System.Drawing.Color.LightBlue
Next thisControl
End Sub
En el ejemplo anterior se puede modificar el miembro BackColor de cada elemento thisControl, aunque no se puede modificar el propio elemento thisControl.
Recorrer matrices. Dado que la clase Array implementa la interfaz IEnumerable, todas las matrices exponen el método GetEnumerator. Esto significa que es posible recorrer una matriz con un bucle For Each...Next. Sin embargo, solo se pueden leer los elementos de la matriz. No se pueden cambiar. Para obtener un ejemplo, vea Cómo: Ejecutar varias instrucciones para todos los elementos de una colección o matriz (Visual Basic).
Ejemplo
En el ejemplo siguiente se muestra cómo utilizar la instrucción For Each…Next.
' Create a list of strings by using a
' collection initializer.
Dim lst As New List(Of String) _
From {"abc", "def", "ghi"}
' Iterate through the list.
For Each item As String In lst
Debug.Write(item & " ")
Next
Debug.WriteLine("")
'Output: abc def ghi
El ejemplo siguiente demuestra estructuras For Each...Next anidadas.
' Create lists of numbers and letters
' by using array initializers.
Dim numbers() As Integer = {1, 4, 7}
Dim letters() As String = {"a", "b", "c"}
' Iterate through the list by using nested loops.
For Each number As Integer In numbers
For Each letter As String In letters
Debug.Write(number.ToString & letter & " ")
Next
Next
Debug.WriteLine("")
'Output: 1a 1b 1c 4a 4b 4c 7a 7b 7c
En el siguiente ejemplo se muestra cómo utilizar las instrucciones Continue For y Exit For.
Dim numberSeq() As Integer =
{1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12}
For Each number As Integer In numberSeq
' If number is between 5 and 7, continue
' with the next iteration.
If number >= 5 And number <= 8 Then
Continue For
End If
' Display the number.
Debug.Write(number.ToString & " ")
' If number is 10, exit the loop.
If number = 10 Then
Exit For
End If
Next
Debug.WriteLine("")
' Output: 1 2 3 4 9 10
El ejemplo siguiente muestra todas las carpetas del directorio C:\ utilizando la clase DirectoryInfo .
Dim dInfo As New System.IO.DirectoryInfo("c:\")
For Each dir As System.IO.DirectoryInfo In dInfo.GetDirectories()
Debug.WriteLine(dir.Name)
Next
En el ejemplo siguiente se muestra cómo ordenar una colección mediante la interfaz IComparable .
Public Sub ListCars()
' Create some new cars.
Dim cars As New List(Of Car) From
{
New Car With {.Name = "car1", .Color = "blue", .Speed = 20},
New Car With {.Name = "car2", .Color = "red", .Speed = 50},
New Car With {.Name = "car3", .Color = "green", .Speed = 10},
New Car With {.Name = "car4", .Color = "blue", .Speed = 50},
New Car With {.Name = "car5", .Color = "blue", .Speed = 30},
New Car With {.Name = "car6", .Color = "red", .Speed = 60},
New Car With {.Name = "car7", .Color = "green", .Speed = 50}
}
' Sort the cars by color, alphabetically, and then by speed
' in descending order.
cars.Sort()
' View all of the cars.
For Each thisCar As Car In cars
Debug.Write(thisCar.Color.PadRight(5) & " ")
Debug.Write(thisCar.Speed.ToString & " ")
Debug.Write(thisCar.Name)
Debug.WriteLine("")
Next
' Output:
' blue 50 car4
' blue 30 car5
' blue 20 car1
' green 50 car7
' green 10 car3
' red 60 car6
' red 50 car2
End Sub
Public Class Car
Implements IComparable(Of Car)
Public Property Name As String
Public Property Speed As Integer
Public Property Color As String
Public Function CompareTo(ByVal other As Car) As Integer _
Implements System.IComparable(Of Car).CompareTo
' Determine the relative order of the objects being compared.
' This is used to sort by color alphabetically, and then by
' speed in descending order.
' Compare the colors.
Dim compare As Integer
compare = String.Compare(Me.Color, other.Color, True)
' If the colors are the same, compare the speeds.
If compare = 0 Then
compare = Me.Speed.CompareTo(other.Speed)
' Use descending order for speed.
compare = -compare
End If
Return compare
End Function
End Class
En el ejemplo siguiente se incluye una clase de colección personalizada que tiene un enumerador personalizado.
Public Sub ListColors()
Dim colors As New AllColors()
For Each theColor As Color In colors
Debug.Write(theColor.Name & " ")
Next
Debug.WriteLine("")
' Output: red blue green
End Sub
' Collection class.
Public Class AllColors
Implements System.Collections.IEnumerable
Private _colors() As Color =
{
New Color With {.Name = "red"},
New Color With {.Name = "blue"},
New Color With {.Name = "green"}
}
Public Function GetEnumerator() As System.Collections.IEnumerator _
Implements System.Collections.IEnumerable.GetEnumerator
Return New ColorEnumerator(_colors)
' Instead of creating a using a custom enumerator, you could
' use the GetEnumerator of the array.
'Return _colors.GetEnumerator
End Function
' Custom enumerator.
Private Class ColorEnumerator
Implements System.Collections.IEnumerator
Private _colors() As Color
Private _position As Integer = -1
Public Sub New(ByVal colors() As Color)
_colors = colors
End Sub
Public ReadOnly Property Current() As Object Implements System.Collections.IEnumerator.Current
Get
Return _colors(_position)
End Get
End Property
Public Function MoveNext() As Boolean Implements System.Collections.IEnumerator.MoveNext
_position += 1
Return (_position < _colors.Length)
End Function
Public Sub Reset() Implements System.Collections.IEnumerator.Reset
_position = -1
End Sub
End Class
End Class
' Element class.
Public Class Color
Public Property Name As String
End Class
Vea también
Tareas
Referencia
Instrucción For...Next (Visual Basic)
Instrucción While...End While (Visual Basic)
Instrucción Do...Loop (Visual Basic)
Conceptos
Estructuras de bucles (Visual Basic)
Conversiones de ampliación y de restricción (Visual Basic)
Inicializadores de objeto: Tipos con nombre y anónimos (Visual Basic)
Información general de los inicializadores de colección (Visual Basic)
Historial de cambios
Fecha |
Historial |
Motivo |
|
Diciembre de 2010 |
Reorganizada la sección Comentarios y agregados ejemplos. |
Mejora de la información. |