Escolar Documentos
Profissional Documentos
Cultura Documentos
FWMsExcelEx
Tempo aproximado para leitura: 8 minutos
Classe: FWMsExcelEx
FWMsExcelEx
Descrição
Fornece métodos para criação de arquivo XML compatível com as versões do MS Excel 2003, superiores e alternativos. Fornece métodos para a
criação de planilhas em formato de tabela e fornece também métodos para a configuração de cores e fonte.
Observação
A classe FWMsExcelEx utiliza escrita diretamente no arquivo em tempo de criação do XML, não armazenando os valores em memória para depois
escrever o arquivo. Nesse método de criação o consumo de memória é menor, porém existe dependência entre os métodos utilizados, já que a escrita
é feita a partir da execução dos métodos, sendo indicada essa classe na geração de maiores quantidades de dados.
Exemplo
User Function TESTE()
Local oExcel := FWMsExcelEx():New()
oExcel:AddworkSheet("Teste - 1")
oExcel:AddTable ("Teste - 1","Titulo de teste 1")
oExcel:AddColumn("Teste - 1","Titulo de teste 1","Col1",1,1)
oExcel:AddColumn("Teste - 1","Titulo de teste 1","Col2",2,2)
oExcel:AddColumn("Teste - 1","Titulo de teste 1","Col3",3,3)
oExcel:AddColumn("Teste - 1","Titulo de teste 1","Col4",1,1)
oExcel:SetCelBold(.T.)
oExcel:SetCelFont('Arial')
oExcel:SetCelItalic(.T.)
oExcel:SetCelUnderLine(.T.)
oExcel:SetCelSizeFont(10)
oExcel:SetCelBold(.T.)
oExcel:SetCelFont('Arial')
oExcel:SetCelItalic(.T.)
oExcel:SetCelUnderLine(.T.)
oExcel:SetCelSizeFont(15)
oExcel:SetCelFrColor("#FFFFFF")
oExcel:SetCelBgColor("#000666")
oExcel:SetCelFont('Courier New')
oExcel:SetCelItalic(.F.)
oExcel:SetCelUnderLine(.T.)
oExcel:SetCelSizeFont(10)
oExcel:SetCelFrColor("#FFFFFF")
oExcel:SetCelBgColor("#000333")
oExcel:AddRow("Teste - 1","Titulo de teste 1",{31,32,33,34},{2,4})
oExcel:SetCelBold(.T.)
oExcel:SetCelFont('Line Draw')
oExcel:SetCelItalic(.F.)
oExcel:SetCelUnderLine(.F.)
oExcel:SetCelSizeFont(12)
oExcel:SetCelFrColor("#FFFFFF")
oExcel:SetCelBgColor("#D7BCFB")
https://tdn.totvs.com/display/framework/FWMsExcelEx 1/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
oExcel:Activate()
oExcel:GetXMLFile("TESTE.xml")
Return
New
Sintaxe
FWMsExcelEx():New()-> NIL
Descrição
Método construtor da classe
ClassName
Sintaxe
FWMsExcelEx():ClassName()-> NIL
Descrição
Fornece o nome da classe
Activate
Sintaxe
FWMsExcelEx():Activate()-> NIL
Descrição
Habilita o uso da classe, indicando que esta configurada e pronto para uso
DeActivate
Sintaxe
FWMsExcelEx():DeActivate()-> NIL
Descrição
Desabilita o uso da classe
AddWorkSheet
Sintaxe
FWMsExcelEx():AddWorkSheet(< cWorkSheet >)-> NIL
Descrição
Adiciona uma Worksheet ( Planilha )
Parâmetros
AddTable
Sintaxe
FWMsExcelEx():AddTable(< cWorkSheet >, < cTable >)-> NIL
Descrição
Adiciona uma tabela na Worksheet. Uma WorkSheet pode ter apenas uma tabela
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 2/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
AddColumn
Sintaxe
FWMsExcelEx():AddColumn(< cWorkSheet >, < cTable >, < cColumn >, < nAlign >, < nFormat >, < lTotal >)-> NIL
Descrição
Adiciona uma coluna a tabela de uma Worksheet.
Parâmetros
AddRow
Sintaxe
FWMsExcelEx():AddRow(< cWorkSheet >, < cTable >, < aRow >,< aCelStyle >)-> NIL
Descrição
Adiciona uma linha a tabela de uma Worksheet.
Parâmetros
aCelStyle Array of Array com as posições das colunas que receberão o estilo
Records específicos
GetXMLFile
Sintaxe
FWMsExcelEx():GetXMLFile(< cFile >)-> NIL
Descrição
Cria um arquivo no formato XML do MSExcel 2003 em diante
Parâmetros
IsWorkSheet
https://tdn.totvs.com/display/framework/FWMsExcelEx 3/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Sintaxe
FWMsExcelEx():IsWorkSheet(< cWorkSheet >)-> NIL
Descrição
Verifica se um nome já foi utilizado para definir uma WorkSheet
Parâmetros
SetFontSize
Sintaxe
FWMsExcelEx():SetFontSize(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte para todos os estilos da planilha
Parâmetros
SetFont
Sintaxe
FWMsExcelEx():SetFont(< cFont >)-> NIL
Descrição
Define a fonte que será utilizada para todos os estilos da planilha
Parâmetros
SetItalic
Sintaxe
FWMsExcelEx():SetItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" para todos os estilos da planilha
Parâmetros
SetBold
Sintaxe
https://tdn.totvs.com/display/framework/FWMsExcelEx 4/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
FWMsExcelEx():SetBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" para todos os estilos da planilha
Parâmetros
SetUnderLine
Sintaxe
FWMsExcelEx():SetUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" para todos os estilos da planilha
Parâmetros
SetFrGeneralColor
Sintaxe
FWMsExcelEx():SetFrGeneralColor(< cColor >)-> NIL
Descrição
Define a cor de preenchimento geral para todos os estilos da planilha
Parâmetros
SetBgGeneralColor
Sintaxe
FWMsExcelEx():SetBgGeneralColor(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo do Titulo para todos os estilos da planilha
Parâmetros
SetTitleFont
Sintaxe
FWMsExcelEx():SetTitleFont(< cFont >)-> NIL
https://tdn.totvs.com/display/framework/FWMsExcelEx 5/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Descrição
Define a fonte que será utilizada no estilo do Título
Parâmetros
SetTitleSizeFont
Sintaxe
FWMsExcelEx():SetTitleSizeFont(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte do estilo do Título
Parâmetros
SetTitleItalic
Sintaxe
FWMsExcelEx():SetTitleItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" no estilo do Titulo
Parâmetros
SetTitleBold
Sintaxe
FWMsExcelEx():SetTitleBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" no estilo do Título
Parâmetros
SetTitleUnderLine
Sintaxe
FWMsExcelEx():SetTitleUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" no estilo do Titulo
https://tdn.totvs.com/display/framework/FWMsExcelEx 6/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Parâmetros
SetTitleFrColor
Sintaxe
FWMsExcelEx():SetTitleFrColor(< cColor >)-> NIL
Descrição
Define a cor de preenchimento do estilo do Titulo
Parâmetros
SetTitleBgColor
Sintaxe
FWMsExcelEx():SetTitleBgColor(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo do Titulo
Parâmetros
SetHeaderFont
Sintaxe
FWMsExcelEx():SetHeaderFont(< cFont >)-> NIL
Descrição
Define a fonte que será utilizada no estilo do Cabeçalho
Parâmetros
SetHeaderSizeFont
Sintaxe
FWMsExcelEx():SetHeaderSizeFont(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte do estilo do Cabeçalho
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 7/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
SetHeaderItalic
Sintaxe
FWMsExcelEx():SetHeaderItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" no estilo do Cabeçalho
Parâmetros
SetHeaderBold
Sintaxe
FWMsExcelEx():SetHeaderBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" no estilo do Cabeçalho
Parâmetros
SetHeaderUnderLine
Sintaxe
FWMsExcelEx():SetHeaderUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" no estilo do Cabeçalho
Parâmetros
SetFrColorHeader
Sintaxe
FWMsExcelEx():SetFrColorHeader(< cColor >)-> NIL
Descrição
Define a cor de preenchimento do estilo do Cabeçalho
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 8/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Nome Tipo Descrição Default Obrigatório Referência
SetBgColorHeader
Sintaxe
FWMsExcelEx():SetBgColorHeader(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo do Cabeçalho
Parâmetros
SetLineFont
Sintaxe
FWMsExcelEx():SetLineFont(< cFont >)-> NIL
Descrição
Define a fonte que será utilizada no estilo da Linha
Parâmetros
SetLineSizeFont
Sintaxe
FWMsExcelEx():SetLineSizeFont(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte do estilo da Linha
Parâmetros
SetLineItalic
Sintaxe
FWMsExcelEx():SetLineItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" no estilo da Linha
Parâmetros
SetLineBold
Sintaxe
FWMsExcelEx():SetLineBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" no estilo da Linha
Parâmetros
SetLineUnderLine
Sintaxe
FWMsExcelEx():SetLineUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" no estilo da Linha
Parâmetros
SetLineFrColor
Sintaxe
FWMsExcelEx():SetLineFrColor(< cColor >)-> NIL
Descrição
Define a cor de preenchimento do estilo da Linha
Parâmetros
SetLineBgColor
Sintaxe
FWMsExcelEx():SetLineBgColor(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo da Linha
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 10/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Set2LineFont
Sintaxe
FWMsExcelEx():Set2LineFont(< cFont >)-> NIL
Descrição
Define a fonte que será utilizada no estilo da Linha 2
Parâmetros
Set2LineSizeFont
Sintaxe
FWMsExcelEx():Set2LineSizeFont(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte do estilo da Linha 2
Parâmetros
Set2LineItalic
Sintaxe
FWMsExcelEx():Set2LineItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" no estilo da Linha 2
Parâmetros
Set2LineBold
Sintaxe
FWMsExcelEx():Set2LineBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" no estilo da Linha 2
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 11/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Set2LineUnderLine
Sintaxe
FWMsExcelEx():Set2LineUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" no estilo da Linha 2
Parâmetros
Set2LineFrColor
Sintaxe
FWMsExcelEx():Set2LineFrColor(< cColor >)-> NIL
Descrição
Define a cor de preenchimento do estilo da Linha 2
Parâmetros
Set2LineBgColor
Sintaxe
FWMsExcelEx():Set2LineBgColor(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo da Linha 2
Parâmetros
SetCelFont
Sintaxe
FWMsExcelEx():SetCelFont(< cFont >)-> NIL
Descrição
Define a fonte que será utilizada no estilo da Célula indicada no método :AddRow()
Parâmetros
SetCelSizeFont
Sintaxe
FWMsExcelEx():SetCelSizeFont(< nFontSize >)-> NIL
Descrição
Define o tamanho para a fonte do estilo da Célula indicada no método :AddRow()
Parâmetros
https://tdn.totvs.com/display/framework/FWMsExcelEx 12/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
SetCelItalic
Sintaxe
FWMsExcelEx():SetCelItalic(< lItalic >)-> NIL
Descrição
Define se a fonte terá a configuração "Italico" no estilo da Célula indicada no método :AddRow()
Parâmetros
SetCelBold
Sintaxe
FWMsExcelEx():SetCelBold(< lBold >)-> NIL
Descrição
Define se a fonte terá a configuração "Negrito" no estilo da Célula indicada no método :AddRow()
Parâmetros
SetCelUnderLine
Sintaxe
FWMsExcelEx():SetCelUnderLine(< lUnderline >)-> NIL
Descrição
Define se a fonte terá a configuração "Sublinhado" no estilo da Célula indicada no método :AddRow()
Parâmetros
SetCelFrColor
Sintaxe
FWMsExcelEx():SetCelFrColor(< cColor >)-> NIL
Descrição
Define a cor de preenchimento do estilo da Célula indicada no método :AddRow()
Parâmetros
SetCelBgColor
Sintaxe
FWMsExcelEx():SetCelBgColor(< cColor >)-> NIL
Descrição
Define a cor da fonte do estilo da Célula indicada no método :AddRow()
https://tdn.totvs.com/display/framework/FWMsExcelEx 13/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Parâmetros
SetUTF8Encode
Sintaxe
Descrição
Parâmetros
lUtf8 Lógico Indica se será utilizado ou não o encode UTF8 para os conteúdos enviados X
para criação da planilha. Por padrão as string enviadas será encodadas para
UTF8
SetTitleHAlign
Sintaxe
Descrição
Parâmetros
SetHeadHAlign
Sintaxe
Descrição
Parâmetros
SetTitleVAlign
Sintaxe
https://tdn.totvs.com/display/framework/FWMsExcelEx 14/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Descrição
Parâmetros
SetHeadVAlign
Sintaxe
Descrição
Parâmetros
SetLineVAlign
Sintaxe
Descrição
Parâmetros
SetTitleHeight
Sintaxe
Descrição
Parâmetros
SetHeadHeight
Sintaxe
https://tdn.totvs.com/display/framework/FWMsExcelEx 15/16
21/02/2022 14:44 FWMsExcelEx - Frameworksp - TDN
Descrição
Parâmetros
SetLineHeight
Sintaxe
Descrição
Parâmetros
3 Comentários
Jose Augusto Ribeiro
No metodo addColumn na documentação esta repetido o nome da planilha, deveria ser nome da WorkSheet e depois nome da planilha
Política de Termos
privacidade de uso
https://tdn.totvs.com/display/framework/FWMsExcelEx 16/16