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

(Criou página com 'A classe TPHExcel serve para realizar a importação de arquivos do excel com a extensão xlsx. A classe TPHExcel suporta execução no cliente e no servidor e o ambiente esco...')
 
m (Procedimentos)
 
(3 revisões intermediárias por um outro usuário não estão sendo mostradas)
Linha 7: Linha 7:
 
!Descrição
 
!Descrição
 
|-
 
|-
|ID
+
|QtdLinhas
|Int64
+
|Integer
|Corresponde ao ID do registro (Opcional).
+
|Quantidade de linhas do arquivo.
 +
|-
 +
|QtdColunas
 +
|Integer
 +
|Quantidade de colunas do arquivo.
 
|}
 
|}
  
 
===Criação do Objeto===
 
===Criação do Objeto===
* '''NewPHServerClass''': Cria o objeto, espera como parâmetro o nome do cadastro.
+
* '''NewPHExcel''': Cria o objeto, espera como parâmetro o nome do cadastro.
* '''NewPHServerClassName''': Cria o objeto, espera como parâmetro o nome da classe, utilizada para classes sem cadastro.
 
  
 
===Procedimentos===
 
===Procedimentos===
* '''NovoRegistro''': Inicia o cadastro de um novo registro. Nesse ponto são consideradas as regras presentes no evento AfterInsert da classe e do script;  
+
* '''Importar(pArquivoExcel:String)''': Realizar importação do arquivo com extensão xlsx informado no parâmetro do pArquivoExcel do procedimento;
* '''CampoDoNome(Campo:String)''': Permite atribuir ou retornar valores para os campos. Exemplo: CampoDoNome('CODIGO').AsInteger := 1;
+
* '''RetornaCSV''': Após a importação do arquivo xlsx, é possível retornar o texto correspondente no formado CSV (Seperado por ponto e virgura);
* '''Salvar''': Realiza gravação do registro. Nesse ponto são considerados as regras presentes nos eventos BeforePost e AfterPost da classe e do script;
+
*'''RetornaCelula(const pColuna:Integer;const pLinha:Integer):String''': Retorna o texto correspondente a célula da coluna e linha informados nos parâmetros do procedimento;
 +
*'''AtribuirCelula(const pColuna:Integer;const pLinha:Integer;pTexto:String)''': Atribuir o texto informado no parâmetro pTexto, na célula correspondente a coluna e linha informada;  
 +
*'''Limpar''': Limpar propriedades do objeto da classe TPHExcel, quando houver um arquivo que já foi importado.
  
 
===Exemplo Conversão para CSV===
 
===Exemplo Conversão para CSV===
Linha 30: Linha 35:
 
   Excel := NewPHExcel;
 
   Excel := NewPHExcel;
 
   try
 
   try
     Excel.Importar('C:\Users\paulo\Área de Trabalho\teste.xlsx');                                   
+
     Excel.Importar('C:\teste.xlsx');                                   
 
     Result := Excel.RetornaCSV;     
 
     Result := Excel.RetornaCSV;     
 
   finally
 
   finally
Linha 36: Linha 41:
 
   end;             
 
   end;             
 
  end;           
 
  end;           
 
 
  begin
 
  begin
 
   Informacao(RetornarCSV);                       
 
   Informacao(RetornarCSV);                       
 
  end.
 
  end.

Edição atual tal como às 13h58min de 24 de agosto de 2023

A classe TPHExcel serve para realizar a importação de arquivos do excel com a extensão xlsx. A classe TPHExcel suporta execução no cliente e no servidor e o ambiente escolhido requer a aplicação do Excel do office instalada. Para execução no servidor deve-se realizar implementação em um script especifico, e a chamada do script no cliente deverá ocorrer através do classe TPHProcScript.

Propriedades

Nome Tipo Descrição
QtdLinhas Integer Quantidade de linhas do arquivo.
QtdColunas Integer Quantidade de colunas do arquivo.

Criação do Objeto

  • NewPHExcel: Cria o objeto, espera como parâmetro o nome do cadastro.

Procedimentos

  • Importar(pArquivoExcel:String): Realizar importação do arquivo com extensão xlsx informado no parâmetro do pArquivoExcel do procedimento;
  • RetornaCSV: Após a importação do arquivo xlsx, é possível retornar o texto correspondente no formado CSV (Seperado por ponto e virgura);
  • RetornaCelula(const pColuna:Integer;const pLinha:Integer):String: Retorna o texto correspondente a célula da coluna e linha informados nos parâmetros do procedimento;
  • AtribuirCelula(const pColuna:Integer;const pLinha:Integer;pTexto:String): Atribuir o texto informado no parâmetro pTexto, na célula correspondente a coluna e linha informada;
  • Limpar: Limpar propriedades do objeto da classe TPHExcel, quando houver um arquivo que já foi importado.

Exemplo Conversão para CSV

{ Retornar CSV da planilha }                                                                    
function RetornarCSV:String;
var
  Excel:TPHExcel;                                           
begin
  Excel := NewPHExcel;
  try
    Excel.Importar('C:\teste.xlsx');                                  
    Result := Excel.RetornaCSV;    
  finally
    Excel.Free;                        
  end;            
end;          
begin
  Informacao(RetornarCSV);                       
end.