Histórico da Página

O que é?

Classe responsável por auxiliar a printer.exe na geração de arquivos .xlsx. Esta classe faz o processo de escrever o arquivo intermediário com as instruções a serem convertidas e que gerarão o arquivo .xlsx.

Aviso
O recurso depende primariamente da `printer.exe` ter a versão igual ou superior a `2.1.0`.

...

Classe disponível na lib com label igual ou superior a 20201009.

Índice

Métodos

New()

Cria a instância de um objeto da classe FwPrinterXlsx.

Permite a configuração se deve excluir o arquivo auxiliar .rel de construção da planilha .xlsx.

Sintaxe: FwPrinterXlsx():New(lDelBase) → objeto FwPrinterXlsx

Parâmetros:

...

Nome

...

Tipo

...

Descrição

...

Default

...

Obrigatório

...

Referência

...

Exemplo:

Bloco de código

language	cpp

local oFwXlsx := FwPrinterXlsx():New()

Activate()

Prepara o objeto para realizar a escrita do arquivo base. O resultado do método indica se conseguiu preparar com sucesso o arquivo base.

Permite a configuração do objeto utilizado na escrita considerando como base a classe FwFileWriter.

...

Caso seja utilizada versão anterior será lançada uma exceção

Expandir

title	Exceção

Image Added

Sem Formato

language	cpp
title	Exceção

THREAD ERROR ([92092], izac.ciszevski, SPON019400005)   30/09/2020 16:22:46
erro no parâmetro FwPrinterXlsx: Versão da printer.exe não suporta a geração de arquivos .xlsx. on FWPRINTERXLSX:ACTIVATE(FWPRINTERXLSX.TLPP) 25/09/2020 18:06:04 line : 140

Obs.: O binário da printer precisa estar atualizado no servidor e também no cliente, pois conforme condições, a impressão pode utilizar um ou outro.

Aviso
Classe disponível na lib com label igual ou superior a `20201009 e release igual ou superior a 12.1.23`

Métodos

New()

Cria a instância de um objeto da classe FwPrinterXlsx.

Permite a configuração se deve excluir o arquivo auxiliar .rel de construção da planilha .xlsx.

Sintaxe: FwPrinterXlsx():New(lDelBase) → objeto FwPrinterXlsx

Parâmetros:

Nome

Tipo

...

FwPrinterXlsx():New()

Activate()

Prepara o objeto para realizar a escrita do arquivo base. O resultado do método indica se conseguiu preparar com sucesso o arquivo base.

Permite a configuração do objeto utilizado na escrita considerando como base a classe FwFileWriter.

Sintaxe: FwPrinterXlsx():Activate(cFile, oFile) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`cFile`	caractere	x			caminho do arquivo para o .rel e .xlsx final
`oFile`	objeto		objeto `FwFileWriter()`	x	objeto para realizar a escrita dos comandos no arquivo base

Bloco de código

language	cpp

local cPath := "\spool\"  // /spool/ para uma geração no server
local cArquivo := cPath + "xls_class_rel.rel"

lRet := oXlsx:Activate(cArquivo)

// informando o FwFileWriter
// oFileW := FwFileWriter():New(cFilename)
// lRet := oXlsx:Activate(cFilename, oFileW)

Aviso

title	Observações

Informe caminhos de diretórios completos (a partir do cliente ou do rootpath) para não ter comportamentos inesperados com a execução da printer no final.

Prefira o uso de diretório e nomes de arquivos como: /spool/nome_arquivo.rel ou c:\temporários\relatório\nome_arquivo.rel.

toXlsx()

Faz a criação do arquivo .xlsx depois de ter completado o preenchimento e configuração das informações na classe

Aviso

title	Observações

Informe caminhos de diretórios completos (a partir do cliente ou do rootpath) para não ter comportamentos inesperados com a execução da printer no final.

Prefira o uso de diretório e nomes de arquivos como: /spool/nome_arquivo.rel ou c:\temporários\relatório\nome_arquivo.rel.

toXlsx()

Faz a criação do arquivo .xlsx depois de ter completado o preenchimento e configuração das informações na classe.

Sintaxe: FwPrinterXlsx():toXlsx() → nil

Bloco de código

language	cpp

lRet := oFwXlsx:Activate(cGenFile)
oFwXlsx:toXlsx()

cGenFile := StrTran(cGenFile, ".rel", ".xlsx")

if file(cGenFile)
	CpyS2T(cGenFile, cDestFile)
else
	// arquivo não gerado
endif

Aviso

title	Observações

Fica sob responsabilidade do programa/código cliente verificar se o arquivo foi .xlsx gerado onde desejado e eventualmente mover para um destino desejado como a máquina da pessoa ou diretório compartilhado.

EraseBaseFile()

Exclui o arquivo base .rel gerado com uma instância da classe FwPrinterXlsx.

Sintaxe: FwPrinterXlsx():EraseBaseFile() → nil

DeActivate()

...

Destroy()

Remove os recursos conhecidos que prendem memória em múltiplas execuções da classe.

Sintaxe: FwPrinterXlsx():Destroy() → nil

SetFontConfig()

SetFont()

ResetFont()

SetColumnsWidth()

SetRowsHeight()

MergeCells()

SetCellsFormatConfig()

SetCellsFormat()

ResetCellsFormat()

SetBorderConfig()

SetBorder()

ResetBorder()

ApplyFormat()

AddSheet()

SetValue()

SetText()

SetNumber()

SetFormula()

SetDate()

SetDateTime()

SetHyperlink()

SetBoolean()

AddImageFromBuffer()

UseImageFromBuffer()

AddImageFromAbsolutePath()

SetVerticalBarCodeContent()

ApplyAutoFilter()

Exemplos

Uso simples

O exemplo a seguir mostra como gerar uma planilha simples.

...

language	cpp
linenumbers	true

...

Bloco de código

language	cpp

lRet := oFwXlsx:Activate(cGenFile)
oFwXlsx:toXlsx()

cGenFile := StrTran(cGenFile, ".rel", ".xlsx")

if file(cGenFile)
	CpyS2T(cGenFile, cDestFile)
else
	// arquivo não gerado
endif

Aviso

title	Observações

Fica sob responsabilidade do programa/código cliente verificar se o arquivo foi .xlsx gerado onde desejado e eventualmente mover para um destino desejado como a máquina da pessoa ou diretório compartilhado.

EraseBaseFile()

Exclui o arquivo base .rel gerado com uma instância da classe FwPrinterXlsx.

Sintaxe: FwPrinterXlsx():EraseBaseFile() → nil

DeActivate()

Remove os elementos preparados com a criação e escrita do arquivo no Activate.

Sintaxe: FwPrinterXlsx():DeActivate() → nil

Destroy()

Remove os recursos conhecidos que prendem memória em múltiplas execuções da classe.

Sintaxe: FwPrinterXlsx():Destroy() → nil

SetFont()

Faz a indicação da fonte para ser utilizada nas novas atribuições de conteúdos que acontecer nas células.

Sintaxe: FwPrinterXlsx():SetFont(cFont, nSize, lItalic, lBold, lUnderlined) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
cFont	caractere	x			código da fonte - Utilize a classe FwPrinterFont como referência
nSize	numérico	x			tamanho da fonte
lItalic	lógico	x			deve exibir em itálico?
lBold	lógico	x			deve exibir em negrito?
lUnderlined	lógico	x			deve exibir sublinhado?

Exemplo:

Bloco de código

language	cpp
linenumbers	true

// cFont :=	 FwPrinterFont():getFromName("Calibri")
cFont := FwPrinterFont():Calibri()
nSize := 14
lItalic := .T.
lBold := .T.
lUnderlined := .T.
// Comando 'Fonte' com Calibri 14, itálico, negrito e sublinhado
lRet := oXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

ResetFont()

Redefine a fonte padrão para uma planilha.

A fonte padrão é Calibri, tamanho 11 e sem itálico, sem negrito e sem sublinhado.

Sintaxe: FwPrinterXlsx():ResetFont() → lRet

SetFontConfig()

Faz a definição de uma fonte através de um objeto de configuração.

Facilita os casos de troca repetida de fontes, permitindo ter um objeto pré configurado com as características desejadas. Internamente é utilizado o método setFont.

O objeto de configuração é o retorno do método estático da classe FwXlsxPrinterConfig:MakeFont().

Sintaxe: FwPrinterXlsx():SetFontConfig(jFont) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`jFont`	objeto `JsonObject`	x			configuração com as propriedades para fontes veja: `FwXlsxPrinterConfig():MakeFont()`

Exemplo:

Bloco de código

language	cpp

jFontItalic := FwXlsxPrinterConfig():MakeFont()
jFontItalic['italic'] := .T.

jFontBold := FwXlsxPrinterConfig():MakeFont()
jFontBold['bold'] := .T.

lRet := self:oPrintXlsx:SetFontConfig(jFontItalic)
// escreve no arquivo

lRet := self:oPrintXlsx:SetFontConfig(jFontBold)
// escreve novamente no arquivo

SetColumnsWidth()

Define a largura para uma lista de colunas.

O valor da largura segue a especificação de unidade do excel e o valor padrão das colunas é de 8,43.

Sintaxe: FwPrinterXlsx():SetColumnsWidth(nColFrom, nColTo, nWidth) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nColFrom`	numérico	x			determina a partir de qual coluna aplicar o ajuste de largura
`nColTo`	numérico	x			determina até qual coluna deve aplicar o ajuste de largura
`nWidth`	numérico	x			determina a nova largura

Exemplo:

Bloco de código

language	cpp

// Largura 23,71
lRet := oXlsx:SetColumnsWidth(5, 10, 23.71)

SetRowsHeight()

Define a altura para uma lista de linhas.

Este valor segue a especificação de unidade do excel e o valor padrão das linhas é de 15.00.

Sintaxe: FwPrinterXlsx():SetRowsHeight(nRowFrom, nRowTo, nHeight) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRowFrom`	numérico	x			determina a partir de qual linha aplicar o ajuste de altura
`nRowTo`	numérico	x			determina até qual linha deve aplicar o ajuste de altura
`nHeight`	numérico	x			determina a nova altura

Exemplo:

Bloco de código

language	cpp

nRowFrom := 26
nRowTo := 30
nHeight := 18.75
// Altura 18,75 nas linhas 26 a 30
lRet := oXlsx:SetRowsHeight(nRowFrom, nRowTo, nHeight)

SetCellsFormat()

Define a formatação a ser aplicada nas células, aplicando alinhamento, cores e formatação dos valores.

Os alinhamentos de conteúdo possuem classes de apoio para a recuperação dos códigos a serem utilizados. As classes são FwXlsxCellAlignment, FwXlsxHorizontalAlignment e FwXlsxVerticalAlignment.

Os valores para as cores seguem o padrão RGB contudo sem a marcação

Sintaxe: FwPrinterXlsx():SetCellsFormat(cHorAlign, cVertAlign, lTextWrap, nRotDegrees, cTextColor, cBgColor, cCustomFormat)→ lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`cHorAlign`	caractere	x			determina o alinhamento horizontal do conteúdo veja: `FwXlsxHorizontalAlignment`
`cVertAlign`	caractere	x			determina o alinhamento vertical do conteúdo veja: `FwXlsxVerticalAlignment`
`lTextWrap`	lógico	x			deve aplicar quebra de linha?
`nRotDegrees`	numérico	x			define a rotação do texto em graus 0 - 359
`cTextColor`	caractere	x			define a cor para o texto na célula
`cBgColor`	caractere	x			define a cor de fundo da célula
`cCustomFormat`	caractere		""		determina tipo personalizado de formatação do conteúdo

Exemplo:

Bloco de código

static oCellHorAlign := FwXlsxCellAlignment():Horizontal()
static oCellVertAlign := FwXlsxCellAlignment():Vertical()

cHorAlignment := oCellHorAlign:Center()
cVertAlignment := oCellVertAlign:Center()
lWrapText := .F.
nRotation := 270
cCustomFormat := ""
// Seta texto vermelho com alinhamento horizontal e vertical centralizado e com rotação de texto vertical
lRet := oXlsx:SetCellsFormat(cHorAlignment, cVertAlignment, lWrapText, nRotation, "FF0000", "FFFFFF", cCustomFormat)

ResetCellsFormat()

Redefine para a formatação padrão de células.

O padrão das células é alinhamento horizontal e vertical Default sem quebra de texto, sem rotação, texto na cor preta e fundo da célula na cor branca e sem formatação de conteúdo

Sintaxe: FwPrinterXlsx():ResetCellsFormat()→ lRet

SetCellsFormatConfig()

Aplica as configurações de formatação utilizando um objeto com as propriedades necessárias.

Sintaxe: FwPrinterXlsx():SetCellsFormatConfig(jFormat) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`jFormat`	objeto `JsonObject`	x			configuração com as propriedades para fontes `FwXlsxPrinterConfig():MakeFormat()`

Exemplo:

Bloco de código

jFormat := FwXlsxPrinterConfig():MakeFormat()
jFormat['hor_align'] := oCellHorAlign:Center()
jFormat['vert_align'] := oCellVertAlign:Center()

// formatação para todas as células a seguir
lRet := oXlsx:SetCellsFormatConfig(jFormat)

MergeCells()

Aplica a unificação de um conjunto de células que esteja no intervalo matricial informado (células de - até).

Sintaxe: FwPrinterXlsx():MergeCells(nRowFrom, nColFrom, nRowTo, nColTo) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRowFrom`	numérico	x			indica a partir de qual linha aplicar a unificação
`nColFrom`	numérico	x			indica a partir de qual coluna aplicar a unificação
`nRowTo`	numérico	x			indica até qual linha aplicar a unificação
`nColTo`	numérico	x			indica até qual coluna aplicar a unificação

Exemplo:

Bloco de código

language	cpp

nRowFrom := 2
nColFrom := 2
nRowTo := 21
nColTo := 3
// Mescla intervalo B2:C21
lRet := oXlsx:MergeCells(nRowFrom, nColFrom, nRowTo, nColTo)

SetBorder()

Determina as bordas para as próximas células que receberão conteúdo.

Sintaxe: FwPrinterXlsx():SetBorder(lLeft, lTop, lRight, lBottom, cStyle, cColor)

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`lLeft`	lógico	x			deve usar borda à esquerda?
`lTop`	lógico	x			deve usar borda superior?
`lRight`	lógico	x			deve usar borda à direita?
`lBottom`	lógico	x			deve usar borda inferior?
`cStyle`	caractere	x			define qual o tipo de borda (`FwXlsxBorderStyle`)
`cColor`	caractere	x			define a cor para as bordas

Exemplo:

Bloco de código
lTop := .T. lBottom := .T. lLeft:= .T. lRight := .T. cStyle := FwXlsxBorderStyle():DashDot() cColor := "008000" // Borda lRet := oXlsx:SetBorder(lLeft, lTop, lRight, lBottom, cStyle, cColor)

ResetBorder()

Redefine para as bordas de células para o padrão.

O padrão das bordas é sem indicação de uso de bordas (falso para os quatro lados), estilo None (não aplica estilo algum) e cor de linha preta.

Sintaxe: FwPrinterXlsx():ResetBorder() → lRet

SetBorderConfig()

Aplica as configurações de borda utilizando um objeto com as propriedades necessárias.

Sintaxe: FwPrinterXlsx():SetBorderConfig(jBorder) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`jBorder`	objeto `JsonObject`	x			configuração com as propriedades para as bordas `FwXlsxPrinterConfig():MakeBorder()`

Exemplo:

Bloco de código

// Bordas para o header
jBorderHeader := FwXlsxPrinterConfig():MakeBorder()
jBorderHeader['top'] := .T.
jBorderHeader['bottom'] := .T.
jBorderHeader['border_color'] := "B1B1B1"
jBorderHeader['style'] := FwXlsxBorderStyle():Double()
lRet := oXlsx:SetBorderConfig(jBorderHeader)

AddSheet()

Adiciona uma aba à planilha. Este é um dos comandos obrigatórios para a geração de uma planilha.

Sintaxe: FwPrinterXlsx():AddSheet(cSheetName) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`cSheetName`	caractere		`nil`		nome para a aba

Exemplo:

Bloco de código
// Nova aba lRet := oXlsx:AddSheet("Minha Plan2") // lRet := oXlsx:AddSheet()

ApplyFormat()

Comando que força a aplicação de uma formatação à célula.

Este comando pode ser usado para atribuir um formato às células e minimizar a quantidade de escrita no arquivo base.

A formatação envolvida são: configuração de bordas, formatação de conteúdo, alinhamento e cor e definição de fonte.

Sintaxe: FwPrinterXlsx():ApplyFormat(nRow, nCol) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			número da linha da célula para aplicar as formatações
`nCol`	numérico	x			número da linha da célula para aplicar as formatações

Exemplo:

Bloco de código

lTop := .T.
lBottom := .T.
lLeft:= .T.
lRight := .T.
cStyle := FwXlsxBorderStyle():DashDot()
cColor := "008000"
// Borda
lRet := oXlsx:SetBorder(lLeft, lTop, lRight, lBottom, cStyle, cColor)

nRow := 12
nCol := 1
// blank - Usado somente para aplicar a formatação
lRet := oXlsx:ApplyFormat(nRow, nCol)

SetValue()

Atribuição genérica de um valor para a célula conforme os tipos do Advpl, a atribuição é redirecionada internamente para o tipo de atribuição apropriada por exemplo, caractere → setText e numérico → setNumber.

Nenhum dos comandos de atribuição de valor aplica a formatação para o tipo, ou seja é necessário que indique o formato que queira exibir o conteúdo na célula antes da atribuição ou então aplique depois de ter atribuído o valor com o método ApplyFormat para cada uma das células escritas antes.

Sintaxe: FwPrinterXlsx():SetValue(nRow, nCol, xValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`xValue`	caractere \| data \| lógico \| numérico	x			valor para atribuição de algum dos tipos: caractere, numérico, data ou lógico de Advpl

Exemplo:

Bloco de código

language	cpp

lRet := oXlsx:SetValue(1, 3, "Mês")
lRet := oXlsx:SetValue(2, 3, 1)
lRet := oXlsx:SetValue(3, 3, .F.)
lRet := oXlsx:SetValue(4, 3, STOD("20200827")) // ficará sem formatação de data

cHorAlignment := oCellHorAlign:Default()
cVertAlignment := oCellVertAlign:Default()
lWrapText := .F.
nRotation := 0
cCustomFormat := "dd-mm-yyyy"
// Seta formato de data dd-mm-yyyy
lRet := oXlsx:SetCellsFormat(cHorAlignment, cVertAlignment, lWrapText, nRotation, "000000", "FFFFFF", cCustomFormat)
lRet := oXlsx:SetValue(5, 3, STOD("20200827")) // terá formatação de data

SetText()

Atribui um valor de texto a uma célula.

Sintaxe: FwPrinterXlsx():SetText(nRow, nCol, cValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`cValue`	caractere	x			texto para atribuição

SetNumber()

Atribui um valor numérico a uma célula.

Sintaxe: FwPrinterXlsx():SetNumber(nRow, nCol, nValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`nValue`	numérico	x			número para atribuição

SetFormula()

Atribui uma fórmula a uma célula. Esta fórmula não tem sua validade consistida na atribuição.

Sintaxe: FwPrinterXlsx():SetFormula(nRow, nCol, cValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`cValue`	caractere	x			fórmula para atribuição

Exemplo:

SetDate()

Atribui o valor de data do Advpl a uma célula.

Sintaxe: FwPrinterXlsx():SetDate(nRow, nCol, dValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`dValue`	data	x			data para atribuição

SetDateTime()

Atribui o valor de data e hora a uma célula.

Espera que este valor no formato aceito pela printer.exe.

Veja a classe FwXlsxDateFormat para os detalhes de como gerar o formato da printer para data e hora.

Sintaxe: FwPrinterXlsx():SetDateTime(nRow, nCol, cValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`cValue`	caractere	x			valor formatado para atribuição ver: `FwXlsxDateFormat():toPrinterFormat()`

Exemplo:

Bloco de código

cHorAlignment := oCellHorAlign:Default()
cVertAlignment := oCellVertAlign:Default()
lWrapText := .F.
nRotation := 0
cCustomFormat := "dd/mm/yy hh:mm:ss.000"
// Define o formato de data e hora dd/mm/yy hh:mm:ss.000
lRet := oXlsx:SetCellsFormat(cHorAlignment, cVertAlignment, lWrapText, nRotation, "000000", "FFFFFF", cCustomFormat)

nRow := 6
nCol := 3
oXlsxDate := FwXlsxDateFormat():New()
oXlsxDate:SetYear("2019")
oXlsxDate:SetMonth("8")
oXlsxDate:SetDay("23")
oXlsxDate:SetHour("17")
oXlsxDate:SetMinute("55")
oXlsxDate:SetSeconds("43.123")
cValue := oXlsxDate:toPrinterFormat()
// data e hora completas na célula
lRet := oXlsx:SetDateTime(nRow, nCol, cValue)

SetHyperlink()

Atribui um hiperlink interno ou externo (URL) a uma célula.

Sintaxe: FwPrinterXlsx():SetHyperlink(nRow, nCol, cValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`cValue`	caractere	x			url ou hiperlink para o documento para atribuição

SetBoolean()

Atribui um valor lógico a uma célula.

Sintaxe: FwPrinterXlsx():SetBoolean(nRow, nCol, lValue) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para atribuição do valor
`nCol`	numérico	x			coluna da célula para atribuição do valor
`lValue`	lógico	x			valor lógico para atribuição

AddImageFromBuffer()

Adiciona uma imagem para a planilha a partir de uma string contendo os bytes da imagem (buffer).

O tamanho da imagem está limitado à 999.999 bytes (aproximadamente 976Kb), caso a imagem ultrapasse este tamanho é necessário informar o endereço de diretório absoluto para a imagem com o método AddImageFromAbsolutePath.

Apesar de receber a indicação de célula (linha e coluna) a renderização das imagens no arquivo gerado não será reduzida ao tamanho da célula. A imagem será exibida em seu tamanho original, podendo ser indicado os novos valores em pixels para a largura e altura com os parâmetros nWidthResize e nHeightResize.

Sintaxe: FwPrinterXlsx():AddImageFromBuffer(nRow, nCol, cImageId, cBuffer, nWidthResize, nHeightResize) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para início da exibição da imagem
`nCol`	numérico	x			coluna da célula para início da exibição da imagem
`cImageId`	caractere	x			id da imagem para referências futuras com o método `UseImageFromBuffer`
`cBuffer`	caractere	x			string com o buffer da imagem
`nWidthResize`	numérico		0		nova largura para a imagem
`nHeightResize`	numérico		0		nova altura para a imagem

Informações
Um ponto de atenção é a configuração do limite para o tamanho de strings no Appserver e no Smartclient, pois a leitura de arquivo de imagens pode facilmente exceder os limites configurados.

Exemplo:

Bloco de código

cImgRel := 'logo'

nHndImagem:= fOpen(cImgDir, FO_READ)
nLenImagem := 0

nLenImagem := fSeek( nHndImagem, 0, FS_END)
fSeek( nHndImagem, 0, FS_SET)
fRead( nHndImagem, @cBuffer, nLenImagem)

lRet := oXlsx:AddImageFromBuffer(5, 8, cImgRel, cBuffer, 0, 0)

UseImageFromBuffer()

Usa uma imagem já adicionada à planilha através do método AddImageFromBuffer anteriormente no arquivo.

Sintaxe: FwPrinterXlsx():UseImageFromBuffer(nRow, nCol, cImageId, nWidthResize, nHeightResize) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para início da exibição da imagem
`nCol`	numérico	x			coluna da célula para início da exibição da imagem
`cImageId`	caractere	x			id da imagem adicionada por buffer anteriormente
`nWidthResize`	numérico		0		nova largura para a imagem
`nHeightResize`	numérico		0		nova altura para a imagem

Exemplo:

Bloco de código
cImgId := 'id_de_imagem_adicionada_por_buffer' lRet := oPrtXlsx:UseImageFromBuffer(20, 8, cImgId, 114, 33)

AddImageFromAbsolutePath()

Adiciona uma imagem à planilha a partir de um endereço de diretório absoluto.

Este método tem seu resultado influenciado pelo local/endereço de geração do arquivo base .rel. Os comportamentos possíveis são:

Quando o arquivo é gerado no servidor (/spool/, /system/ ou qualquer outro diretório no rootpath) o endereço absoluto da imagem precisa ser desde a unidade do disco local do servidor. Por exemplo, com o .rel no endereço /planilhas/arquivo.rel a imagem precisa ser em e:\totvs\protheus\protheus_data\minhas_imagens\imagem_que_quero_usar.png ou l:/opt/totvs/protheus/protheus_data/minhas_imagens/imagem_que_quero_user.png.
Quando o arquivo .rel é gerado local (endereço do cliente/terminal/smartclient) o endereço absoluto da imagem precisa ser a partir do disco local da máquina cliente. Por exemplo, com o .rel no endereço c:\planilhas\minha_planilha.rel a imagem precisa estar em um diretório acessível pela máquina cliente como c:\temporários\imagens\imagem.png.

Sintaxe: FwPrinterXlsx():AddImageFromAbsolutePath(nRow, nCol, cImgPath, nWidthResize, nHeightResize) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			linha da célula para início da exibição da imagem
`nCol`	numérico	x			coluna da célula para início da exibição da imagem
`cImgPath`	caractere	x			diretório absoluto da imagem
`nWidthResize`	numérico		0		nova largura para a imagem
`nHeightResize`	numérico		0		nova altura para a imagem

Exemplo:

Bloco de código

// usando imagem no server no mesmo endereço do .rel
cRootPath := 'C:\Especif\Protheus12\sistemico\protheus_data_27'
cPath := "\spool\"  // /spool/ para uma geração no server

cArquivo := cPath + "base_planilha.rel"
cImgDir := cRootPath + cPath + 'protheus_logo.png'

lRet := oXlsx:Activate(cArquivo)

lRet := oXlsx:AddImageFromAbsolutePath(10, 8, cImgDir, 200, 100)

// usando imagem no cliente/local no mesmo endereço do .rel
cPath := GetClientDir() // diretório do smartclient

cArquivo := cPath + "base_planilha.rel"
cImgDir := cPath + "protheus_logo.png"

lRet := oXlsx:Activate(cArquivo)

lRet := oXlsx:AddImageFromAbsolutePath(10, 8, cImgDir, 200, 100)

ApplyAutoFilter()

Aplica um auto filtro no conjunto de células da matriz (de célula até célula).

Sintaxe: FwPrinterXlsx():ApplyAutoFilter(nRowFrom, nColFrom, nRowTo, nColTo) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRowFrom`	numérico	x			linha da célula inicial (superior esquerda)
`nColFrom`	numérico	x			coluna da célula inicial (superior esquerda)
`nRowTo`	numérico	x			linha da célula final (inferior direita)
`nColTo`	numérico	x			coluna da célula final (inferior direita)

Exemplo:

Bloco de código

language	cpp

// Aplica auto filtro no intervalo A1:C7
lRet := oXlsx:ApplyAutoFilter(1,1,7,3)

SetVerticalBarCodeContent()

Adiciona um código de barras vertical.

Sintaxe: FwPrinterXlsx():SetVerticalBarCodeContent(nRow, nCol, cContent) → lRet

Parâmetros:

Nome	Tipo	Obrigatório	Default	Referência	Descrição
`nRow`	numérico	x			posição de linha da célula para atribuição
`nCol`	numérico	x			posição de coluna da célula para atribuição
`cContent`	caractere	x			conteúdo para a montagem do código de barras

Exemplo:

Bloco de código

language	cpp

nRow := 23
nCol := 13
cContent := "01005000000001001010111010001010111000111011101000101000111010111000101000111011100010101000111000101010111000111010"
lRet := oXlsx:SetVerticalBarCodeContent(nRow, nCol, cContent) // Comando 'Código de barra vertical'

Outros códigos de barras

Os demais códigos de barras suportados são indicados a seguir. Estes são atribuições de conteúdos do tipo texto com fontes e valores específicos a cada um dos tipos.

Como a atribuição é do tipo texto, o controle da fonte fica sob responsabilidade do programa que está usando a FwPrinterXlsx.

Code128

Possui as fontes Code128b e Code128c como opções para a impressão do código de barras.

Exemplo:

Bloco de código

language	cpp

// cFont := FwPrinterFont():getFromName('code128b')
cFont := FwPrinterFont():Code128b()
nSize := 50
lItalic := .F.
lBold := .F.
lUnderlined := .F.
// Fonte Code 128 (para código de barras)
lRet := oPrtXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

nRow := 2
nCol := 13
// Texto para o código de barras Code128
lRet := oPrtXlsx:SetText(nRow, nCol, "Ò,BX'hÓ")

QrCode

Possui a fonte QrCode disponível para uso.

Exemplo:

Bloco de código

language	cpp

// cFont := FwPrinterFont():getFromName('qrcode')
cFont := FwPrinterFont():QrCode()
nSize := 50
lItalic := .F.
lBold := .F.
lUnderlined := .F.
// Fonte QRCode (para código de barras 2D)
lRet := oPrtXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

nRow := 6
nCol := 13
// Texto para o código de barras QRCode
lRet := oPrtXlsx:SetText(nRow, nCol, "QRCode gerado para o Excel")

DataMatrix

Possui a fonte Datamatrix disponível para uso.

Exemplo:

Bloco de código

language	cpp

// cFont := FwPrinterFont():getFromName('datamatrix')
cFont := FwPrinterFont():DataMatrix()
nSize := 50
lItalic := .F.
lBold := .F.
lUnderlined := .F.
// Fonte DataMatrix (para código de barras 2D)
lRet := oPrtXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

SetTypeDisplayLineGrid

Informa o tipo de visualização de linhas do grid, esse método está disponível na lib 20231009

Exemplo:

Bloco de código

language	cpp

lRet := oPrtXlsx:SetTypeDisplayLineGrid( totvs.framework.xlsx.LinesGridDisplay():getHideAll() )

GetStatusPrinter

Retorna o status da printer sobre a geração do XLSX, esse método está disponível na lib 20231009. Esse status não deve ser utilizado para validar a geração bem sucedida do XLSX.

Exemplo:

Bloco de código

language	cpp

nStatus := oPrtXlsx:GetStatusPrinter()

PDF417

Possui a fonte pdf417 disponível para uso.

Exemplo:

Bloco de código

language	cpp

// cFont := FwPrinterFont():getFromName('PDF417')
cFont := FwPrinterFont():PDF417()
nSize := 300
lItalic := .T.
lBold := .F.
lUnderlined := .F.
// Fonte PDF417 (para código de barras 2D)
lRet := oPrtXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

Exemplos

Uso simples

O exemplo a seguir mostra como gerar uma planilha simples.

Bloco de código

language	cpp
title	exemplo básico
linenumbers	true

#include 'protheus.ch'

function u_basicoxlsx()
    local oPrtXlsx as object
    local cFilename as character
    // local oFileW as object
    local lRet as logical

    cFilename := '/system/'+cValToChar(ThreadId())+'_teste.rel'
    ferase(cFilename)

    // oFileW := FwFileWriter():New(cFilename)
    oPrtXlsx := FwPrinterXlsx():New()

    // lRet := oPrtXlsx:Activate(cFilename, oFileW)
    lRet := oPrtXlsx:Activate(cFilename)

    lRet := oPrtXlsx:AddSheet("1 - Plan")

    lRet := oPrtXlsx:SetText(1, 1, "Valor na célula")
    lRet := oPrtXlsx:toXlsx()

    oPrtXlsx:DeActivate()
Return

Planilha com todos os recursos

O exemplo de planilha a seguir implementa todos os recursos disponíveis.

Bloco de código

language	cpp
firstline	1
title	exemplo completo
linenumbers	true
collapse	true

#include "protheus.ch"
#include "fileio.ch"

static oCellHorAlign := FwXlsxCellAlignment():Horizontal()
static oCellVertAlign := FwXlsxCellAlignment():Vertical()

function u_fwprtxlsx()
    classe()
    alert('terminou')
return


static function classe()
    // Antes de rodar este programa coloque uma imagem válida nos diretórios mencionados a seguir
    // ou indique um caminho válido para uma imagem
    local cRootPath := 'C:\Especif\Protheus12\sistemico\protheus_data_27'
    local cPath := "\spool\"  // /spool/ para uma geração no server
    local cArquivo := cPath + "exemplo.rel"
    local cImgRel := 'logo'
    local cImgDir := cRootPath + cPath + 'protheus_logo.png'

    local cBuffer:= ""

    local lRet := .F.
    local oFileW := FwFileWriter():New(cArquivo)
    local oPrtXlsx := FwPrinterXlsx():New()

    local nHndImagem := 0
    local nLenImagem := 0
    local jFontHeader
    local jFontNum
    local jFontText
    local jBorderHeader
    local jBorderLeft
    local jBorderCenter
    local jBorderRight
    local jFormat

    lRet := oPrtXlsx:Activate(cArquivo, oFileW)

    lRet := oPrtXlsx:AddSheet("Minha Plan1")

    // Atenção, antes de remover os comentários dos comandos a seguir
    // confira o endereço para a imagem
    // nHndImagem := fOpen(cImgDir, FO_READ)
    // if nHndImagem < 0
    //     return MsgStop("Não foi possível abrir " + cImgDir)
    // endif

    // nLenImagem := fSeek( nHndImagem, 0, FS_END)
    // fSeek( nHndImagem, 0, FS_SET)
    // fRead( nHndImagem, @cBuffer, nLenImagem)

    // lRet := oPrtXlsx:AddImageFromBuffer(5, 8, cImgRel, cBuffer, 0, 0)
    // lRet := oPrtXlsx:AddImageFromAbsolutePath(10, 8, cImgDir, 200, 100)
    // lRet := oPrtXlsx:UseImageFromBuffer(20, 8, cImgRel, 114, 33)

    // cFont := FwPrinterFont():getFromName("Calibri")
    cFont := FwPrinterFont():Calibri()
    nSize := 14
    lItalic := .T.
    lBold := .T.
    lUnderlined := .T.
    // Comando 'Fonte' com Calibri 14, itálico, negrito e sublinhado
    lRet := oPrtXlsx:SetFont(cFont, nSize, lItalic, lBold, lUnderlined)

    cHorAlignment := oCellHorAlign:Default()
    cVertAlignment := oCellVertAlign:Default()
    lWrapText := .F.
    nRotation := 0
    // Comando 'Formato de Célula' com cor de texto e fundo personalizadas
    lRet := oPrtXlsx:SetCellsFormat(cHorAlignment, cVertAlignment, lWrapText, nRotation, "FF0000", "C0C0C0", "" )

    nColFrom := 1
    nColTo := 5
    nWidth := 24
    lRet := oPrtXlsx:SetColumnsWidth(nColFrom, nColTo, nWidth)

    nRow := 1
    nCol := 1
    // Texto em A1
    lRet :=

...

Planilha com todos os recursos

O exemplo de planilha a seguir implementa todos os recursos disponíveis.

...

language	cpp
firstline	1
title	fwprtxlsx_completo.prw
collapse	true

...

Assuntos relacionados

Templatedocumentos

HTML

<style>
div.theme-default .ia-splitter #main {
    margin-left: 0px;
}
.ia-fixed-sidebar, .ia-splitter-left {
    display: none;
}
#main {
    padding-left: 10px;
    padding-right: 10px;
    overflow-x: hidden;
}

.aui-header-primary .aui-nav,  .aui-page-panel {
    margin-left: 0px !important;
}
.aui-header-primary .aui-nav {
    margin-left: 0px !important;
}

.aui-tabs.horizontal-tabs>.tabs-menu>.menu-item.active-tab a::after { 
	background: #FF9900; !important 
}

.menu-item.active-tab { 
	border-bottom: none !important; 
}

</style>

Assuntos relacionados

Índice

Índice

indent	1em
style	none

Páginas filhas

Histórico da Página

Versões comparadas

Versão antiga 9

Nova versão Atual

Chave

O que é?

Métodos

New()

Activate()

Métodos

New()

Activate()

toXlsx()

toXlsx()

EraseBaseFile()

DeActivate()

Destroy()

SetFontConfig()

SetFont()

ResetFont()

SetColumnsWidth()

SetRowsHeight()

MergeCells()

SetCellsFormatConfig()

SetCellsFormat()

ResetCellsFormat()

SetBorderConfig()

SetBorder()

ResetBorder()

ApplyFormat()

AddSheet()

SetValue()

SetText()

SetNumber()

SetFormula()

SetDate()

SetDateTime()

SetHyperlink()

SetBoolean()

AddImageFromBuffer()

UseImageFromBuffer()

AddImageFromAbsolutePath()

SetVerticalBarCodeContent()

ApplyAutoFilter()

Exemplos

Uso simples

EraseBaseFile()

DeActivate()

Destroy()

SetFont()

ResetFont()

SetFontConfig()

SetColumnsWidth()

SetRowsHeight()

SetCellsFormat()

ResetCellsFormat()

SetCellsFormatConfig()

MergeCells()

SetBorder()

ResetBorder()

SetBorderConfig()

AddSheet()

ApplyFormat()

SetValue()

SetText()

SetNumber()

SetFormula()

SetDate()

SetDateTime()

SetHyperlink()

SetBoolean()

AddImageFromBuffer()

UseImageFromBuffer()

AddImageFromAbsolutePath()

ApplyAutoFilter()

SetVerticalBarCodeContent()

Outros códigos de barras

Code128

QrCode