C-Sharp Foreach Ienumerable Ienumerator

Compreendendo a Iteração em C#: Usando `IEnumerator<T>` em Loops `foreach`

Em C#, colaborar com coleções e iterar dados é uma prática comum para desenvolvedores. Uma pergunta frequente surge ao tentar retornar um IEnumerator<T> de um método e usá-lo em um loop foreach. Essa questão se torna ainda mais interessante quando você precisa percorrer controles aninhados dentro de uma interface de usuário.

Vamos nos aprofundar nessa situação, explorando o cerne do problema e apresentando uma solução prática.

O Problema

Imagine que você tem um Formulário do Windows onde precisa ajustar dinamicamente a altura de vários controles TextBox. Esses TextBoxes podem não apenas residir no nível raiz do formulário, mas alguns podem estar aninhados dentro de outros controles, criando uma estrutura complexa. Você quer usar um método que utilize yield para retornar os TextBoxes encontrados um por um.

Sua abordagem inicial pode se parecer com isto:

private static IEnumerator<TextBox> FindTextBoxes(Control rootControl)
{
    foreach (Control control in rootControl.Controls)
    {
        if (control.Controls.Count > 0)
        {
            // Busca recursivamente por qualquer TextBox dentro de cada controle filho
            foreach (TextBox textBox in FindTextBoxes(control))
            {
                yield return textBox;
            }
        }

        TextBox textBox2 = control as TextBox;
        if (textBox2 != null)
        {
            yield return textBox2;
        }
    }
}

No entanto, ao usar este método dentro de um loop foreach assim:

foreach(TextBox textBox in FindTextBoxes(this))
{
    textBox.Height = height;
}

Você encontra um erro do compilador. O erro ocorre porque o loop foreach está esperando um IEnumerable, mas seu método retorna um IEnumerator.

A Solução

A chave para resolver esse problema está em mudar o tipo de retorno do seu método de IEnumerator<T> para IEnumerable<T>. A sintaxe de yield return em C# permite que o método produza efetivamente um iterador sem precisar de uma classe enumeradora separada.

Aqui está como modificar seu método:

Método Modificado

private static IEnumerable<TextBox> FindTextBoxes(Control rootControl)
{
    foreach (Control control in rootControl.Controls)
    {
        // Verifica se há controles filhos
        if (control.Controls.Count > 0)
        {
            // Busca recursivamente por TextBoxes em controles filhos
            foreach (TextBox textBox in FindTextBoxes(control))
            {
                yield return textBox;
            }
        }

        // Se o controle atual é um TextBox, retorne-o
        if (control is TextBox textBox2)
        {
            yield return textBox2;
        }
    }
}

Explicação

Alterar Tipo de Retorno: O método agora retorna IEnumerable<TextBox> em vez de IEnumerator<TextBox>. Isso significa que agora ele pode ser usado diretamente em um loop foreach.
Utilizando yield return: O uso de yield return fornece uma maneira limpa e eficiente de recuperar controles TextBox à medida que o loop avança.

Com essa mudança, a utilização do método em seu loop foreach agora funcionará perfeitamente, e cada TextBox será processado individualmente.

Conclusão

Trabalhar com coleções em C# e loops foreach pode, às vezes, levar a armadilhas inesperadas, especialmente ao lidar com métodos recursivos e estruturas de controle. Ao alterar o tipo de retorno de IEnumerator<T> para IEnumerable<T>, você pode utilizar facilmente a enumeração em construções de loops sem complexidades adicionais.

Seguindo essa abordagem, você não apenas evitará erros de compilação, mas também melhorará a manutenibilidade e legibilidade do seu código ao gerenciar controles aninhados em seu formulário.