Adicionado na versão 1.0

Classe AppExcel

Visão Geral


Classe principal da biblioteca AppExcel que fornece métodos para gerar Excel com abas no formato XML no Microsiga Protheus

Sumário


Sumário dos Métodos

AppExcel:New(<cSheetName>)
Método construtor da classe AppExcel
AppExcel:SetFileName(<cNamePar>)
Método para alterar o nome do arquivo XML a ser gerado, o nome do arquivo não deve conter a extensão
AppExcel:SetSheetName(<cNamePar>)
Método para alterar o nome da aba (Sheet) atual
AppExcel:SetDestPath(<cDestPath>)
Método para alterar a pasta destino
AppExcel:AddSheet(<cNameSheet>)
Cria uma nova aba na planilha
AppExcel:AddCell(<nRow >, <nCol >, <xContent >, <[oStyle] >, <<cFormula> >)
Adiciona uma nova célula na aba atual
AppExcel:Merge(<nRow >, <nCol >, <nMergeAcross >, <nMergeDown >, <xContent >, <[oStyle] >, <[cFormula] >)
Realiza a junção entre células de uma sheet
AppExcel:SetHorzFrozen(<nRows>)
Congela as linhas superiores na rolagem de tela
AppExcel:SetVertFrozen(<nCols>)
Congela as linhas laterais na rolagem de tela
AppExcel:Make()
Realiza a geração do arquivo XML
AppExcel:OpenXML()
Abre o XML criado pelo método Make
AppExcel:ClassName()
Método responsável por retornar o nome da classe
AppExcel:Destroy()
Método destrutor do objeto, responsável pela desalocação da memória

Métodos


AppExcel:New(<cSheetName>)

Adicionado na versão 1.0
Método construtor da classe AppExcel
Parametros
Nome Tipo Uso Descrição
cSheetName caractere Obrigatório nome que será apresentada na aba (Sheet) do Excel

AppExcel:SetFileName(<cNamePar>)

Adicionado na versão 1.0
Método para alterar o nome do arquivo XML a ser gerado, o nome do arquivo não deve conter a extensão
Parametros
Nome Tipo Uso Descrição
cNamePar caractere Obrigatório nome do arquivo XML a ser gerado

AppExcel:SetSheetName(<cNamePar>)

Adicionado na versão 1.0
Método para alterar o nome da aba (Sheet) atual
Parametros
Nome Tipo Uso Descrição
cNamePar caractere Obrigatório nome a ser atribuido a aba (Sheet) atual

AppExcel:SetDestPath(<cDestPath>)

Adicionado na versão 1.0
Método para alterar a pasta destino
Parametros
Nome Tipo Uso Descrição
cDestPath caractere Obrigatório caminho do qual será gerado o arquivo XML

AppExcel:AddSheet(<cNameSheet>)

Adicionado na versão 1.0
Cria uma nova aba na planilha
Parametros
Nome Tipo Uso Descrição
cNameSheet caractere Obrigatório nome da aba (Sheet) que será adicionada na planilha

AppExcel:AddCell(<nRow >, <nCol >, <xContent >, <[oStyle] >, <<cFormula> >)

Adicionado na versão 1.0
Adiciona uma nova célula na aba atual
Parametros
Nome Tipo Uso Descrição
nRow inteiro Obrigatório número da linha a qual a célula será atribuida
nCol inteiro Obrigatório número da coluna a qual a célula será atribuida
xContent indefinido Obrigatório conteudo da célula, podendo ser: numérico, string ou data
[oStyle] objeto Obrigatório objeto AppExcCell com a definição (estilo) da célula
<cFormula> String Obrigatório Formula no padrão Excel, ex.: "=RC[-3]+RC[-2]+RC[-1]"

AppExcel:Merge(<nRow >, <nCol >, <nMergeAcross >, <nMergeDown >, <xContent >, <[oStyle] >, <[cFormula] >)

Adicionado na versão 1.0
Realiza a junção entre células de uma sheet
Parametros
Nome Tipo Uso Descrição
nRow inteiro Obrigatório número da linha inicial da célula que será mesclada, nRow e nCol formam a célula de referência
nCol inteiro Obrigatório número da coluna inicial da célula que será mesclada
nMergeAcross inteiro Obrigatório número de células a frente da referência que serão mescladas
nMergeDown inteiro Obrigatório número de células a abaixo da referência que serão mescladas
xContent indefinido Obrigatório conteudo da célula, podendo ser: numérico, string ou data
[oStyle] objeto Obrigatório objeto AppExcCell com a definição (estilo) da célula
[cFormula] String Obrigatório Formula no padrão Excel, ex.: "=RC[-3]+RC[-2]+RC[-1]"

AppExcel:SetHorzFrozen(<nRows>)

Adicionado na versão 1.0
Congela as linhas superiores na rolagem de tela
Parametros
Nome Tipo Uso Descrição
nRows inteiro Obrigatório numero de linhas que serão congeladas

AppExcel:SetVertFrozen(<nCols>)

Adicionado na versão 1.0
Congela as linhas laterais na rolagem de tela
Parametros
Nome Tipo Uso Descrição
nCols inteiro Obrigatório numero de colunas que serão congeladas

AppExcel:Make()

Adicionado na versão 1.0
Realiza a geração do arquivo XML

AppExcel:OpenXML()

Adicionado na versão 1.0
Abre o XML criado pelo método Make

AppExcel:ClassName()

Adicionado na versão 1.0
Método responsável por retornar o nome da classe
Retorno
Tipo Descrição
caractere retorna o nome da classe

AppExcel:Destroy()

Adicionado na versão 1.0
Método destrutor do objeto, responsável pela desalocação da memória