13 07 2016

Ao desenvolvermos um aplicativo que contenha relatórios, muito provavelmente esse aplicativo não terá somente um, mas sim, múltiplos relatórios. Em algumas situações surge a necessidade de juntarmos dois ou mais relatórios em um só. O que fazemos nesse caso? Desenvolvemos um terceiro relatório com o layout dos dois relatórios originais ou será que existe uma alternativa menos trabalhosa? No artigo de hoje eu vou mostrar para você como juntar dois relatórios do Report Viewer em um só de uma maneira menos dolorosa.

Essa situação é mais comum do que podemos imaginar. Muitas vezes queremos imprimir duas listagens pré-existentes dentro de um mesmo relatório principal. Outras vezes, pode ser que tenhamos a necessidade de imprimirmos duas ou mais vias do mesmo relatório. E temos também o exemplo clássico do boleto bancário em que a primeira via é parecida com a segunda via, mas, não necessariamente idêntica.

Em todos esses casos nós poderíamos criar um outro relatório copiando o layout dos dois ou mais relatórios originais. Porém, isso daria um trabalho muito grande, além do trabalho em dobro que teríamos caso alguma coisa seja alterada no layout do relatório original.

Qual seria a alternativa para essa situação? A utilização de sub-relatórios! A ideia é criarmos um relatório separado que exibirá os relatórios “filhos” através da funcionalidade de sub-reports. Dessa forma, caso algo seja alterado nos relatórios originais, a alteração será automaticamente refletida no relatório “mestre“.

Vamos ver como podemos resolver esse desafio com sub-relatórios? Primeiro, vamos criar dois relatórios que serão mesclados em um só.

Criando dois relatórios de exemplo

Poderíamos criar os mais diversos tipos de relatórios para demonstrarmos neste artigo. Porém, para não complicar muito as coisas, vamos desenhar rapidamente dois relatórios muito simples: um com uma listagem de clientes e outro com uma listagem de fornecedores. Não importa a complexidade dos relatórios que você quer juntar, a estratégia que vamos conferir neste artigo se aplica para qualquer tipo de relatório.

Primeiramente, vamos começar com um novo projeto do tipo “Windows Forms Application” e vamos criar duas classes bem simples que servirão de fonte de dados para os relatórios:

    // C#
    public class Cliente
    {
        public int ClienteID { get; set; }
        public string Nome { get; set; }
        public string Telefone { get; set; }
    }
    public class Fornecedor
    {
        public int FornecedorID { get; set; }
        public string Nome { get; set; }
        public string Telefone { get; set; }
    }

' VB.NET
Public Class Cliente
    Public Property ClienteID As Integer
    Public Property Nome As String
    Public Property Telefone As String
End Class
Public Class Fornecedor
    Public Property FornecedorID As Integer
    Public Property Nome As String
    Public Property Telefone As String
End Class

Em seguida, compile o projeto. Caso não façamos a compilação do projeto neste ponto, existe a possibilidade do Report Viewer não reconhecer essas classes que acabamos de criar.

Executada a compilação do projeto, vamos adicionar dois relatórios do Report Viewer no nosso projeto: um chamado “RelatorioCliente” e outro chamado “RelatorioFornecedor“. Ajuste o layout dos relatórios de forma que eles fiquem parecidos com as imagens abaixo:

Não vou detalhar neste artigo a criação desses dois relatórios, uma vez que eu já demonstrei a criação de inúmeros outros relatórios dos mais diversos tipos em outros artigos no passado. É só você dar uma olhada na categoria “Report Viewer“ aqui do meu site que você vai encontrar diversos exemplos.

Criando o relatório “mestre”

Agora que já temos os dois relatórios originais, vamos ver como podemos juntá-los em um só utilizando sub-relatórios. A primeira coisa que temos que fazer é adicionarmos um terceiro relatório no projeto. Vamos chamar esse relatório de “RelatorioMestre“. Dentro desse relatório, vamos adicionar dois controles do tipo “Subreport“:

Feito isso, temos que abrir a propriedade de cada um dos controles “Subreport” para configurarmos o nome do relatório que deverá ser exibido em cada um dos sub-relatórios. Ele deverá sempre ser o nome do relatório sem a extensão “rdlc“. Ou seja, no nosso caso, um dos sub-reports deverá conter o nome “RelatorioCliente” e o outro sub-report deverá conter o nome “RelatorioFornecedor“:

Agora que já temos o nosso relatório “mestre” criado, vamos tentar exibi-lo. Para isso, vamos até o formulário, arrastamos um controle do tipo “ReportViewer” e configuramos para que ele aponte para o “RelatorioMestre.rdlc“. Se executarmos o projeto neste momento, receberemos os seguintes erros:

Recebemos essa mensagem porque nós basicamente não alimentamos os relatórios de cliente e fornecedor. Para alimentarmos sub-relatórios no Report Viewer, nós temos que utilizar o evento SubreportProcessing do LocalReport. Vamos então criar um hook para esse evento no code-behind do formulário, dentro do construtor (ou no evento Load, caso você esteja trabalhando com VB.NET):

        // C#
        public Form1()
        {
            InitializeComponent();
            reportViewer1.LocalReport.SubreportProcessing += LocalReport_SubreportProcessing;
        }

        void LocalReport_SubreportProcessing(object sender, Microsoft.Reporting.WinForms.SubreportProcessingEventArgs e)
        {
            
        }

    ' VB.NET
    Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
        AddHandler ReportViewer1.LocalReport.SubreportProcessing, AddressOf LocalReport_SubreportProcessing

        Me.ReportViewer1.RefreshReport()
    End Sub

    Private Sub LocalReport_SubreportProcessing(Sender As Object, E As Microsoft.Reporting.WinForms.SubreportProcessingEventArgs)

    End Sub

Dentro da implementação do evento SubreportProcessing, temos que configurar a fonte de dados dos sub-relatórios. Como estamos mostrando dois relatórios completamente diferentes, as fontes de dados também serão diferentes. Para sabermos qual relatório está sendo carregado em cada chamada desse evento, nós temos que analisar o valor da propriedade “e.ReportPath“. Essa propriedade trará o caminho do relatório sendo carregado, ou seja, no nosso caso o caminho conterá “RelatorioCliente” ou “RelatorioFornecedor“:

        // C#
        void LocalReport_SubreportProcessing(object sender, Microsoft.Reporting.WinForms.SubreportProcessingEventArgs e)
        {
            if (e.ReportPath.Contains("RelatorioCliente"))
            {
                var clientes = new List<Cliente>();
                clientes.Add(new Cliente() { ClienteID = 1, Nome = "Cliente 1", Telefone = "Tel. Cliente 1" });
                clientes.Add(new Cliente() { ClienteID = 2, Nome = "Cliente 2", Telefone = "Tel. Cliente 2" });
                clientes.Add(new Cliente() { ClienteID = 3, Nome = "Cliente 3", Telefone = "Tel. Cliente 3" });
                e.DataSources.Add(new Microsoft.Reporting.WinForms.ReportDataSource("DataSetCliente", clientes));
            }
            else if (e.ReportPath.Contains("RelatorioFornecedor"))
            {
                var fornecedores = new List<Fornecedor>();
                fornecedores.Add(new Fornecedor() { FornecedorID = 1, Nome = "Fornecedor 1", Telefone = "Tel. Fornecedor 1" });
                fornecedores.Add(new Fornecedor() { FornecedorID = 2, Nome = "Fornecedor 2", Telefone = "Tel. Fornecedor 2" });
                fornecedores.Add(new Fornecedor() { FornecedorID = 3, Nome = "Fornecedor 3", Telefone = "Tel. Fornecedor 3" });
                e.DataSources.Add(new Microsoft.Reporting.WinForms.ReportDataSource("DataSetFornecedor", fornecedores));
            }
        }

    ' VB.NET
    Private Sub LocalReport_SubreportProcessing(Sender As Object, E As Microsoft.Reporting.WinForms.SubreportProcessingEventArgs)
        If (E.ReportPath.Contains("RelatorioCliente")) Then
            Dim Clientes = New List(Of Cliente)
            Clientes.Add(New Cliente() With {.ClienteID = 1, .Nome = "Cliente 1", .Telefone = "Tel. Cliente 1"})
            Clientes.Add(New Cliente() With {.ClienteID = 2, .Nome = "Cliente 2", .Telefone = "Tel. Cliente 2"})
            Clientes.Add(New Cliente() With {.ClienteID = 3, .Nome = "Cliente 3", .Telefone = "Tel. Cliente 3"})
            E.DataSources.Add(New Microsoft.Reporting.WinForms.ReportDataSource("DataSetCliente", Clientes))
        ElseIf (E.ReportPath.Contains("RelatorioFornecedor")) Then
            Dim Fornecedores = New List(Of Fornecedor)
            Fornecedores.Add(New Fornecedor() With {.FornecedorID = 1, .Nome = "Fornecedor 1", .Telefone = "Tel. Fornecedor 1"})
            Fornecedores.Add(New Fornecedor() With {.FornecedorID = 2, .Nome = "Fornecedor 2", .Telefone = "Tel. Fornecedor 2"})
            Fornecedores.Add(New Fornecedor() With {.FornecedorID = 3, .Nome = "Fornecedor 3", .Telefone = "Tel. Fornecedor 3"})
            E.DataSources.Add(New Microsoft.Reporting.WinForms.ReportDataSource("DataSetFornecedor", Fornecedores))
        End If
    End Sub

Atenção! Tome cuidado com o nome do DataSet! Ele deve ser exatamente o mesmo nome do DataSet utilizado nos relatórios “filhos” (por exemplo, nos relatórios utilizados acima, os nomes dos DataSets são “DataSetCliente” e “DataSetFornecedor“). Se o nome dos DataSets não bater (inclusive letras maiúsculas e minúsculas), você continuará recebendo o mesmo erro falando que o DataSet não foi especificado.

Vamos executar o projeto novamente para vermos o resultado:

OK. Os dois relatórios foram exibidos, mas, cadê o título que estava no cabeçalho dos relatórios filhos?

Ajustando o cabeçalho e rodapé dos relatórios filhos

Ao utilizarmos um relatório dentro de um “SubReport” do Report Viewer, somente a área de detalhes é exibida. Ou seja, tudo o que estiver no cabeçalho e rodapé de página será completamente ignorado. Para contornarmos essa limitação, se soubermos que um relatório será utilizado dentro de um controle “SubReport“, temos que mover todo o conteúdo do cabeçalho para dentro da área de detalhes, mais especificamente, dentro da tabela.

Veja o antes:

E o depois:

Feito isso, temos que configurar essas linhas do topo da tabela para que elas repitam em todas as páginas. Conseguimos fazer isso ativando o modo avançado na janela de agrupamentos e configurando a propriedade “RepeatOnNewPage” como “true” em cada uma das seções estáticas do agrupamento de linhas:

Ainda não entendeu o que eu fiz ali em cima? Não tem problema, eu mostro para você um passo a passo neste gif animado:

Repita o mesmo processo para o segundo relatório e o resultado será este:

Quebra de páginas entre os sub-relatórios

Muito bem, até agora conseguimos mostrar os dois relatórios “filhos” dentro de um relatório “mestre“, inclusive com os seus respectivos cabeçalhos. Porém, como é que podemos fazer para quebrar a página entre o relatório de clientes e o relatório de fornecedores? A maioria dos controles do Report Viewer possuem configurações de quebra de página, de forma que podemos configurá-los para quebrar página antes ou depois do controle. Entretanto, o controle “Subreport” não possui essa capacidade, então, como resolver isso?

Um pequeno ajuste (leia-se “gambiarra“) que podemos fazer para termos uma quebra de página entre os sub-relatórios é coloca-los dentro de um controle “Rectangle“. O controle “Rectangle” possui as propriedades de quebra de página, então, tudo o que estiver dentro dele respeitará essa configuração:

E com esse pequeno “ajuste“, o relatório de clientes ficará na primeira página e o relatório de fornecedores ficará na segunda página. Legal, não?

Concluindo

Não é difícil exibirmos mais de um relatório “filho” dentro de um relatório “mestre” no Report Viewer. Com a funcionalidade de sub-relatórios essa tarefa acaba sendo até mesmo muito simples. Existem alguns pequenos “segredos” nesse processo, como o carregamento dos dados dos sub-relatórios, o ajuste do cabeçalho e rodapé dos relatórios “filhos” e a certa “gambiarra” que temos que fazer para adicionarmos quebra de páginas entre um sub-relatório e outro. Tudo isso você conferiu neste artigo de hoje.

E você, já precisou juntar dois relatórios do Report Viewer em um só? Se sim, você utilizou a metodologia que eu apresentei neste artigo ou você fez algo diferente? Se não, você já tinha parado para pensar que isso é possível? Pode ser que essa seja uma boa alternativa para alguns relatórios do seu sistema. De qualquer forma, não esqueça de dar uma passada ali na caixa de comentários para nos contar o que você achou do artigo e como foi a sua experiência com a utilização das técnicas apresentadas.

Por fim, convido você a inscrever-se na minha newsletter. Ao fazer isso, você receberá um e-mail toda semana sobre o artigo publicado e ficará sabendo também em primeira mão sobre o artigo da próxima semana, além de receber dicas “bônus” que eu só compartilho por e-mail. Inscreva-se utilizando o formulário logo abaixo.

Até a próxima!

André Lima

Image by Juhan Sonin used under Creative Commons
https://www.flickr.com/photos/juhansonin/5135576565

Revisão de meio de ano 2016 – como estão suas metas? Utilizando o Crystal Reports com MVVM no WPF