Usina BRGuía AdvPL
Ingresar
← Todos los temas
CLASEPublicado

TMSPrinter

TMSPrinter():New( [cDocument], [uParam2], [uParam3], [uParam4], [uParam5], [uParam6], [uParam7], [uParam8] ) --> oObjeto

Clase histórica para previsualizar e imprimir informes gráficos en AdvPL.

InformesImpresiónClase heredadaTMSPrinterTOTVSTEC
01 · DESCRIPCIÓN GENERAL

Descripción general

TMSPrinter crea un objeto para previsualizar e imprimir informes gráficos. La documentación consultada marca la clase como descontinuada, por lo que en nuevos desarrollos conviene evaluar FWMsPrinter u opciones más recientes. Aun así, TMSPrinter aparece en muchos fuentes heredados y merece una referencia completa para mantenimiento, migración y comprensión de informes existentes.

02 · SINTAXIS

Sintaxis

TMSPrinter():New( [cDocument], [uParam2], [uParam3], [uParam4], [uParam5], [uParam6], [uParam7], [uParam8] ) --> oObjeto

Parámetros

cDocument
CaractereOpcional

Nome descritivo do relatório.

uParam2..uParam8
DiversosOpcional

Parâmetros de compatibilidade documentados historicamente pela classe.

Métodos

NewCria o objeto de impressão TMSPrinter. Use antes de iniciar páginas, configurar orientação, desenhar conteúdo e visualizar ou imprimir.TMSPrinter():New( [cDocument], [uParam2], [uParam3], [uParam4], [uParam5], [uParam6], [uParam7], [uParam8] ) --> oObjeto
Parámetros
NombreFormatoObligatorioDescripciónObservación
cDocumentCaractereOpcional

Nome descritivo do relatório.

uParam2LógicoOpcional

Compatibilidade.

uParam3LógicoOpcional

Compatibilidade.

uParam4CaractereOpcional

Compatibilidade.

uParam5CaractereOpcional

Compatibilidade.

uParam6CaractereOpcional

Compatibilidade.

uParam7LógicoOpcional

Compatibilidade.

uParam8CaractereOpcional

Compatibilidade.

Retorno

oObjeto: objeto TMSPrinter criado.

BoxCria um retângulo no relatório. Use para molduras e divisões visuais.TMSPrinter():Box( [nRow], [nCol], [nBottom], [nRight], [uParam5] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nRowNuméricoOpcional

Coordenada vertical inicial.

nColNuméricoOpcional

Coordenada horizontal inicial.

nBottomNuméricoOpcional

Posição inferior do retângulo.

nRightNuméricoOpcional

Posição direita do retângulo.

uParam5QualquerOpcional

Compatibilidade.

CancelCancela a execução do relatório.TMSPrinter():Cancel() -->
CanceledRetorna se o relatório foi cancelado pelo método Cancel().TMSPrinter():Canceled() -->
Cmtr2PixConverte linha e coluna para pixels por referência.TMSPrinter():Cmtr2Pix( [nLinha], [nColuna], [uParam3] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nLinhaNuméricoOpcional

Linha a converter.

nColunaNuméricoOpcional

Coluna a converter.

uParam3ArrayOpcional

Compatibilidade.

EndIndica o término do relatório. Normalmente é usado após finalizar as páginas.TMSPrinter():End() -->
EndPageIndica o fim da página atual.TMSPrinter():EndPage() -->
FillRectCria um retângulo preenchido com uma determinada cor.TMSPrinter():FillRect( [aCoords], [oBrush] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
aCoordsArrayOpcional

Coordenadas do retângulo.

oBrushObjetoOpcional

Objeto TBrush usado para preenchimento.

GetOrientationRetorna a orientação do objeto.TMSPrinter():GetOrientation() --> nOrint
Retorno

nOrint: 1 para retrato e 2 para paisagem.

GetTextHeightRetorna a altura de um texto conforme a fonte definida.TMSPrinter():GetTextHeight( <cTexto>, <oFont> ) --> nHeight
Parámetros
NombreFormatoObligatorioDescripciónObservación
cTextoCaractereObligatorio

Texto a medir.

oFontObjetoObligatorio

Objeto TFont usado no cálculo.

Retorno

nHeight: altura do texto.

GetTextWidthRetorna a largura de um texto conforme a fonte definida.TMSPrinter():GetTextWidth( <cTexto>, <oFonte> ) --> nWidth
Parámetros
NombreFormatoObligatorioDescripciónObservación
cTextoCaractereObligatorio

Texto a medir.

oFonteObjetoObligatorio

Objeto TFont usado no cálculo.

Retorno

nWidth: largura do texto.

IsPrinterActiveRetorna se a impressora está ativa.TMSPrinter():IsPrinterActive() -->
LineCria uma linha no relatório.TMSPrinter():Line( [nTop], [nLeft], [nBottom], [nRight], [uParam5] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nTopNuméricoOpcional

Coordenada superior/inicial.

nLeftNuméricoOpcional

Coordenada esquerda/inicial.

nBottomNuméricoOpcional

Coordenada inferior/final.

nRightNuméricoOpcional

Coordenada direita/final.

uParam5QualquerOpcional

Compatibilidade.

nHorzResRetorna a resolução horizontal da impressora configurada.TMSPrinter():nHorzRes() --> nResolucao
Retorno

nResolucao: resolução horizontal.

nLogPixelXRetorna a resolução em pixels lógicos no eixo X.TMSPrinter():nLogPixelX() --> nResolucao
Retorno

nResolucao: resolução horizontal em pixels.

nLogPixelYRetorna a resolução em pixels lógicos no eixo Y.TMSPrinter():nLogPixelY() --> nResolucao
Retorno

nResolucao: resolução vertical em pixels.

nVertResRetorna a resolução vertical da impressora configurada.TMSPrinter():nVertRes() --> nResolucao
Retorno

nResolucao: resolução vertical.

PreviewAbre a janela de visualização do relatório.TMSPrinter():Preview() -->
PrintEnvia o relatório para a impressora.TMSPrinter():Print( [aPags], [nCopias] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
aPagsArrayOpcional

Páginas a imprimir.

nCopiasNuméricoOpcional

Quantidade de cópias.

PrinterNameRetorna o nome da impressora.TMSPrinter():PrinterName() --> cImpressora
Retorno

cImpressora: nome da impressora.

RefreshAtualiza a visualização do relatório.TMSPrinter():Refresh() -->
ResetPrinterExclui o objeto e reinicia suas propriedades.TMSPrinter():ResetPrinter() -->
SaveAllAsJpegSalva o relatório em JPG, gerando um arquivo separado para cada página.TMSPrinter():SaveAllAsJpeg( [cFilePath], [nWidthPage], [nHeightPage], [nZoom], [nQuality] ) --> lOk
Parámetros
NombreFormatoObligatorioDescripciónObservación
cFilePathCaractereOpcional

Caminho para salvar os arquivos.

nWidthPageNuméricoOpcional

Largura da página/imagem.

nHeightPageNuméricoOpcional

Altura da página/imagem.

nZoomNuméricoOpcional

Percentual de zoom.

nQualityNuméricoOpcional

Qualidade da imagem.

Retorno

lOk: .T. quando as imagens são salvas com sucesso.

SaveAsHTMLSalva o relatório em HTML.TMSPrinter():SaveAsHTML( <cFile>, [aRange] ) --> lOk
Parámetros
NombreFormatoObligatorioDescripciónObservación
cFileCaractereObligatorio

Arquivo de destino.

aRangeArrayOpcional

Intervalo de páginas.

Retorno

lOk: .T. quando o relatório é salvo com sucesso.

SaveAsODFSalva o relatório em ODF.TMSPrinter():SaveAsODF( <cFile>, [aRange] ) --> lOk
Parámetros
NombreFormatoObligatorioDescripciónObservación
cFileCaractereObligatorio

Arquivo de destino.

aRangeArrayOpcional

Intervalo de páginas.

Retorno

lOk: .T. quando o relatório é salvo com sucesso.

SayCria um texto no relatório.TMSPrinter():Say( [nRow], [nCol], [cText], [oFont], [nWidth], [nClrText], [uParam7], [nAlign] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nRowNuméricoOpcional

Posição vertical.

nColNuméricoOpcional

Posição horizontal.

cTextCaractereOpcional

Texto a imprimir.

oFontObjetoOpcional

Fonte usada.

nWidthNuméricoOpcional

Largura disponível.

nClrTextNuméricoOpcional

Cor do texto.

uParam7QualquerOpcional

Compatibilidade.

nAlignNuméricoOpcional

Alinhamento.

SayBitmapInsere uma imagem no relatório. A documentação histórica destaca uso de BMP.TMSPrinter():SayBitmap( [nRow], [nCol], [cBitmap], [nWidth], [nHeight], [uParam6], [uParam7] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nRowNuméricoOpcional

Posição vertical.

nColNuméricoOpcional

Posição horizontal.

cBitmapCaractereOpcional

Caminho e nome da imagem.

nWidthNuméricoOpcional

Largura da imagem.

nHeightNuméricoOpcional

Altura da imagem.

uParam6QualquerOpcional

Compatibilidade.

uParam7QualquerOpcional

Compatibilidade.

SetCurrentPrinterInUseMétodo de compatibilidade relacionado à impressora corrente.TMSPrinter():SetCurrentPrinterInUse() -->
SetFontDefine a fonte padrão do relatório.TMSPrinter():SetFont( <oFont> ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
oFontObjetoObligatorio

Objeto TFont.

SetLandscapeDefine a orientação do relatório como paisagem.TMSPrinter():SetLandscape() -->
SetPageDefine a página que será apresentada.TMSPrinter():SetPage( <nPage> ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nPageNuméricoObligatorio

Número da página.

SetPaperSizeDefine o tamanho de papel adotado pela página.TMSPrinter():SetPaperSize( [nTamanho] ) -->
Parámetros
NombreFormatoObligatorioDescripciónObservación
nTamanhoNuméricoOpcional

Código do tamanho de papel.

SetPortraitDefine a orientação do relatório como retrato.TMSPrinter():SetPortrait() -->
SetupApresenta a janela de configuração de impressoras.TMSPrinter():Setup() -->
StartPageIndica o início de uma página. Deve ser chamado antes de desenhar o conteúdo.TMSPrinter():StartPage() -->
03 · EJEMPLO PRÁCTICO

Ciclo básico de informe heredado

#Include "TOTVS.ch"

User Function ExTMSPrinter()
    Local oPrint := TMSPrinter():New("Exemplo TMSPrinter")

    If !oPrint:IsPrinterActive()
        oPrint:Setup()
    EndIf

    oPrint:StartPage()
    oPrint:SetPortrait()
    oPrint:Say(100, 100, "Relatório legado com TMSPrinter")
    oPrint:EndPage()
    oPrint:Preview()
    oPrint:End()
Return
Resultado esperado

Crea un informe simple, inicia una página, escribe texto, finaliza la página, abre la vista previa y finaliza el objeto.

BUENAS PRÁCTICAS
  • Usa esta página principalmente para mantenimiento y migración de informes heredados.
  • Para nuevos desarrollos, evalúa FWMsPrinter, SmartView o componentes más actuales.
  • La documentación histórica menciona un límite de 128KB por página; los informes grandes deben revisarse con atención.
ERRORES COMUNES
  • TMSPrinter aparece como descontinuada en la referencia consultada.
  • Algunos parámetros se documentan solo como compatibilidad.
  • Las rutas de imágenes y archivos deben existir en el entorno donde se ejecuta la impresión.

Contenido relacionado

ClaseFWMsPrinter →FundamentoComponentes visuales en AdvPL →FundamentoIncludes de Protheus →
REFERENCIAS
  1. TOTVS. TMSPrinter (descontinuado). TOTVSTEC / TDN. Página histórica de referencia.
Estado
Publicado
Página creada el
Última revisión el
Idioma original
Portugués
Revisión
Usina.BR
0 comentario(s) aprobado(s)

Comentarios

Todavía no hay comentarios aprobados.

Inicia sesión con Google o Microsoft para comentar.

Desarrollado con Usina Docs · Alpha

© 2026 Usina.BR. Todos los derechos reservados. TOTVS, Protheus, Microsiga y sus respectivos logotipos son marcas de sus titulares. Guía AdvPL es independiente y utiliza citas limitadas, atribuidas y justificadas por fines educativos. Consulta los Términos de Uso. Términos de Uso