Mudanças entre as edições de "TPHRelatorio"

(Propriedades)
 
(12 revisões intermediárias por 3 usuários não estão sendo mostradas)
Linha 1: Linha 1:
==Conceito==
+
O objeto TPHRelatorio é utilizado para realizar a chamda de relatórios para visualização ou envio por e-mail.
O objeto TPHRelatorio é utilizado para realizar o chamda de relatórios para visualização envio de e-mail por meio de script.
 
  
 
===Propriedades===
 
===Propriedades===
Linha 26: Linha 25:
 
|Para
 
|Para
 
|String
 
|String
|E-Mail do destinatário. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'.
+
|E-Mail do destinatário. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
 
|-
 
|-
 
|CC
 
|CC
 
|String
 
|String
|E-Mail de destinatário de cópia. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'.
+
|E-Mail de destinatário de cópia. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
 
|-
 
|-
 
|CCO
 
|CCO
 
|String
 
|String
|E-Mail de destinatário de cópia oculta. Pode-se utilizar mais de uma e-mail utilizando a separação por ';'.
+
|E-Mail de destinatário de cópia oculta. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
 
|-
 
|-
 
|AssuntoStr
 
|AssuntoStr
 
|String
 
|String
 
|Descrição do assunto do e-mail.
 
|Descrição do assunto do e-mail.
|-
 
|UsarThread
 
|Boolean
 
|Determina se o sistema vai aguardar o envio do e-mail ou se será iniciar thread para execução em segundo plano.
 
 
|-
 
|-
 
|ExibirTelaEnvio
 
|ExibirTelaEnvio
Linha 50: Linha 45:
 
|MostrarProcesso
 
|MostrarProcesso
 
|Boolean
 
|Boolean
|Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando.
+
|Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando '''(Obsoleta)'''.
 +
|-
 +
|Usuario
 +
|Integer
 +
|Caso informado, será utilizado os dados do usuário informado no envio do e-mail.
 
|-
 
|-
 
|}
 
|}
Linha 58: Linha 57:
 
*'''AddCorpo(Texto:String):''' Adicionar um texto em uma nova linha no corpo do e-mail.
 
*'''AddCorpo(Texto:String):''' Adicionar um texto em uma nova linha no corpo do e-mail.
 
*'''AdicionarAnexo(Anexo:String):''' Informar o caminho do arquivo que será anexado no envio do e-mail.
 
*'''AdicionarAnexo(Anexo:String):''' Informar o caminho do arquivo que será anexado no envio do e-mail.
*'''EnviarEmail:''' Realiza o envio do e-mail.
+
*'''EnviarEmail:''' Realiza o envio do e-mail. Quando a base de dados estiver configurada
 
*'''Prever:''' Realizar o visualização do relatório.
 
*'''Prever:''' Realizar o visualização do relatório.
 
*'''Agendar Envio:''' Realiza o cadastro do e-mail junto ao cadastro de e-mails do sistema (DB_EMAIL). Nesse caso o envio vai ocorrer conforme determinado no agendamento de envio de e-mails.
 
*'''Agendar Envio:''' Realiza o cadastro do e-mail junto ao cadastro de e-mails do sistema (DB_EMAIL). Nesse caso o envio vai ocorrer conforme determinado no agendamento de envio de e-mails.
 
*'''VariavelDate(Nome: String; Value:TDateTime):''' Preencher variável do tipo data.
 
*'''VariavelDate(Nome: String; Value:TDateTime):''' Preencher variável do tipo data.
*'''procedure VariavelString(Nome:String; Value:String):''' Preencher variável do tipo texto.
+
*'''VariavelString(Nome:String; Value:String):''' Preencher variável do tipo texto.
*'''procedure VariavelInteger(Nome:String; Value:Integer):''' Preencher variável do tipo número.
+
*'''VariavelInteger(Nome:String; Value:Integer):''' Preencher variável do tipo número.
 +
 
 +
===Funções===
 +
*'''GerarPDF(var Stream:TMemoryStream):String:''' Realiza a geração do PDF do relatório e popula o Stream passada pelo parâmetro, e resulta no nome do arquivo PDF.
  
 
===Exemplo===
 
===Exemplo===
Linha 78: Linha 80:
 
       PHRel.ExibirTelaEnvio := False;
 
       PHRel.ExibirTelaEnvio := False;
 
       PHRel.MostrarProcesso := False;
 
       PHRel.MostrarProcesso := False;
       PHRel.AdicionarVariavel('DateDATAINICIAL',Date-360);
+
       PHRel.VariavelDate('DATAINICIAL',Date-360);
       PHRel.AdicionarVariavel('DateDATAFINAL',Date);         
+
       PHRel.VariavelDate('DATAFINAL',Date);         
 
       PHRel.EnviarEmail;                       
 
       PHRel.EnviarEmail;                       
 
     finally
 
     finally

Edição atual tal como às 09h38min de 5 de abril de 2024

O objeto TPHRelatorio é utilizado para realizar a chamda de relatórios para visualização ou envio por e-mail.

Propriedades

Nome Tipo Descrição
Filtro String Texto SQL correspondente ao filtro. O texto será atribuido a variável padrão "Filtro" junto ao relatório.
FormatoID Integer Informar o número correspondente ao ID do formato do relatório. Tabela DB_RELATORIOFORMATOS.
NomeFormato String Quando informado o nome do formato, a propriedade "FormatoID" será preenchida com ID correspondente ao formato do relatório. Tabela DB_RELATORIOFORMATOS.
De String E-mail do responsável pelo envio.
Para String E-Mail do destinatário. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
CC String E-Mail de destinatário de cópia. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
CCO String E-Mail de destinatário de cópia oculta. Pode-se utilizar mais de um e-mail utilizando a separação por ';'.
AssuntoStr String Descrição do assunto do e-mail.
ExibirTelaEnvio Boolean Quando enviar, será exibida tela de envio de e-mail.
MostrarProcesso Boolean Caso estiver sendo utilizado objeto de exibição de processo, será exibido o procedimento que o e-mail esta executando (Obsoleta).
Usuario Integer Caso informado, será utilizado os dados do usuário informado no envio do e-mail.

Procedimentos

  • SetCorpo(Corpo:String): Determina o texto utilizado no corpo do e-mail.
  • AddCorpo(Texto:String): Adicionar um texto em uma nova linha no corpo do e-mail.
  • AdicionarAnexo(Anexo:String): Informar o caminho do arquivo que será anexado no envio do e-mail.
  • EnviarEmail: Realiza o envio do e-mail. Quando a base de dados estiver configurada
  • Prever: Realizar o visualização do relatório.
  • Agendar Envio: Realiza o cadastro do e-mail junto ao cadastro de e-mails do sistema (DB_EMAIL). Nesse caso o envio vai ocorrer conforme determinado no agendamento de envio de e-mails.
  • VariavelDate(Nome: String; Value:TDateTime): Preencher variável do tipo data.
  • VariavelString(Nome:String; Value:String): Preencher variável do tipo texto.
  • VariavelInteger(Nome:String; Value:Integer): Preencher variável do tipo número.

Funções

  • GerarPDF(var Stream:TMemoryStream):String: Realiza a geração do PDF do relatório e popula o Stream passada pelo parâmetro, e resulta no nome do arquivo PDF.

Exemplo

 procedure EnviarRelatorio;
 var
   PHRel:TPHRelatorio;                                                 
 begin
   PHRel := NewPHRelatorio;
   try
     PHRel.IDFormato       := 151;
     PHRel.Filtro          := '1';
     PHRel.Para            := 'email@exemplo.com.br';
     PHRel.ExibirTelaEnvio := False;
     PHRel.MostrarProcesso := False;
     PHRel.VariavelDate('DATAINICIAL',Date-360);
     PHRel.VariavelDate('DATAFINAL',Date);        
     PHRel.EnviarEmail;                      
   finally
     PHRel.Free;                        
   end;            
 end;