Adicionado na versão 1.0

Classe AppExcSheet

Visão Geral


Classe de gerenciamento das abas na planilha Excel, esta classe é utilizada e manipulada pela classe AppExcel

Sumário


Sumário dos Métodos

AppExcSheet:New([<cSheetName>])
Método construtor da classe AppExcSheet
AppExcSheet:AddCell(<nRow >, <nCol >, <xContent >, <[oStyle] >, <[cFormula] >, <[nMergeAcross] >, <[nMergeDown] >)
Método com os tratamentos para adicionar uma nova célula na aba, sendo de tipo váriavel, podendo ter: estilo, fórmula ou junções com outras células
AppExcSheet:SetName(<cNameSheet>)
Altera o nome de apresentação da aba
AppExcSheet:GetName()
Retorna o nome definido na aba
AppExcSheet:GetColumnCount()
Retorna a quantidade de colunas que a aba possui
AppExcSheet:GetRowCount()
Retorna a quantidade de linhas que a aba possui
AppExcSheet:OrderRows()
Ordena as linhas adicionadas a aba
AppExcSheet:OrderSheet()
Ordena as linhas e abas da planilha
AppExcSheet:AddIndexRows()
Adiciona indices as células, para evitar ter de adicionar células vazias na planilha gerada
AppExcSheet:HasOptions()
Verificar se a worksheet possui opções personalizadas
AppExcSheet:OptionsToString()
Retorna a serialização das opções da worksheet no padrão XML Excel
AppExcSheet:SetHorzFrozen(<nRows>)
Congela as linhas superiores na rolagem de tela
AppExcSheet:SetVertFrozen(<nCols>)
Congela as linhas laterais na rolagem de tela
AppExcSheet:RowToString(<nRow>)
Serialização da linha para o padrão XML Excel
AppExcSheet:ClassName()
Método responsável por retornar o nome da classe
AppExcSheet:Destroy()
Método destrutor do objeto, responsável pela desalocação da memória

Métodos


AppExcSheet:New([<cSheetName>])

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

AppExcSheet:AddCell(<nRow >, <nCol >, <xContent >, <[oStyle] >, <[cFormula] >, <[nMergeAcross] >, <[nMergeDown] >)

Adicionado na versão 1.0
Método com os tratamentos para adicionar uma nova célula na aba, sendo de tipo váriavel, podendo ter: estilo, fórmula ou junções com outras células
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]"
[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

AppExcSheet:SetName(<cNameSheet>)

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

AppExcSheet:GetName()

Adicionado na versão 1.0
Retorna o nome definido na aba

AppExcSheet:GetColumnCount()

Adicionado na versão 1.0
Retorna a quantidade de colunas que a aba possui

AppExcSheet:GetRowCount()

Adicionado na versão 1.0
Retorna a quantidade de linhas que a aba possui

AppExcSheet:OrderRows()

Adicionado na versão 1.0
Ordena as linhas adicionadas a aba

AppExcSheet:OrderSheet()

Adicionado na versão 1.0
Ordena as linhas e abas da planilha

AppExcSheet:AddIndexRows()

Adicionado na versão 1.0
Adiciona indices as células, para evitar ter de adicionar células vazias na planilha gerada

AppExcSheet:HasOptions()

Adicionado na versão 1.0
Verificar se a worksheet possui opções personalizadas

AppExcSheet:OptionsToString()

Adicionado na versão 1.0
Retorna a serialização das opções da worksheet no padrão XML Excel

AppExcSheet: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

AppExcSheet: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

AppExcSheet:RowToString(<nRow>)

Adicionado na versão 1.0
Serialização da linha para o padrão XML Excel
Parametros
Nome Tipo Uso Descrição
nRow inteiro Obrigatório número da linha que será serializada
Retorno
Tipo Descrição
caractere String contendo a linha especificada no padrão XML

AppExcSheet: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

AppExcSheet:Destroy()

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