Manual Provisrio Editado por Simone Frigerio e Lorenzo Abbati Traduzido por Alexandre Silva

http://forum.imasters.com.br/topic/186410-manual-do-fpdf-traduzido-para-portugues-br/

AddLink
Descrio Cria um novo link interno e devolve seu identificador. Um link interno uma rea clicvel que redireciona para outra posio dentro do documento. O identificador pode ser passado a Cell(), Write(), Image() ou Link(). O destino definido com SetLink().

AddPage
AddPage([string orientation]) Descrio Adiciona uma pgina ao documento. Se uma pgina j est presente antes dela chamado o mtodo Footer() para inserir o p da pagina. Ento a pgina somada, a posio atual colocada no ngulo superior esquerdo, enquanto se lembrando da margem superior e esquerda, depois vem chamando Header() para visualizar o ttulo. A fonte colocada antes da chamada restabelecida automaticamente. No h nenhuma necessidade de chamar SetFont() novamente se quiser continuar com a mesma fonte. O mesmo acontece para cores e largura de linha. A origem do sistema de coordenadas est no ngulo superior esquerdo e o aumento do ordenadas que faz mover para baixo. Parmetros orientation Orientao da pgina. Possveis valores so (case insensitive): P: Retrato L: Paisagem O valor padro repassado pelo construtor.

AliasNbPages
AliasNbPages([string alias]) Descrio Define um alias para o nmero total de pginas. Ser substitudo no fim do documento. Parmetros alias Alis. Valor padro: {nb}. Exemplo function Footer() //Vai para 1,5 cm do fundo da pgina this.SetY(-15); //Seleciona Arial cursiva 8

this.SetFont('Arial','I',8); //Imprime o nmero da pgina atual e total this.Cell(0,10,'Page 'pdf.PageNo().'/{nb}',0,0,'C'); end function

pdf=new PDF() pdf.AliasNbPages()

Cell
Cell(float w [, float h [, string txt [, mixed border [, int ln [, string align [, int fill [, mixed link]]]]]]]) Descrio Imprime uma clula (rea retangular) com bordas, cor de fundo e string de caractere opcional. O ngulo superior esquerdo da clula corresponde posio atual. O texto pode ser alinhado ou centralizado. Depois da chamada, a posio atual o move direita ou na linha seguinte. possvel inserir um link no texto. Se a interrupo de pgina automtica estiver habilitada e a clula for alm dos limites, a interrupo de pgina feita antes da sada. Parmetros w Largura da clula. Se 0, a clula o estende at a margem direita. h Altura da clula. Valor padro: 0. txt String para imprimir. Valor padro: string vazia. border Indica se precisa localizar as bordas ao redor da clula. O valor pode ser ambos um nmero: 0: qualquer borda 1: moldura ou uma string contm alguns ou todos os caracteres seguintes (em qualquer ordem): L: esquerdo T: superior R: direito B: inferior Valor padro: 0. ln Indica a posio atual depois da chamada. Possveis valores so: 0: direita 1: no incio da linha seguinte 2: em baixo Inserir 1 equivale a inserir 0 e chamar Ln() imediatamente depois. Valor padro: 0. align Permite centralizar ou se alinhar o texto. Possveis valores so: L o string vazia: alinhamento esquerda (valor padro) C: centralizado R: alinhamento direita fill Indica se o fundo da clula dever ser desenhado(1) ou dever ser transparente(0).

Valor padro: 0. link O url ou o identificador devolvidos por AddLink (). Exemplo //Configura a fonte pdf.SetFont('Arial','B',16); //Move a 8 cm da direita pdf.Cell(80); //Texto centralizado em uma clula de 20*10 mm e interrupo da linha pdf.Cell(20,10,'Title',1,1,'C');

Close
Close() Descrio Fecha o documento PDF. No necessrio chamar este mtodo explicitamente, porque Output() o faz automaticamente. Se no existir pginas no documento, o mtodo AddPage() chamado para evitar que se obtenha documento invlido.

CreatePDF
CreatePDF([string orientation [, string unit [, mixed format]]]) Descrio Trata-se do construtor da classe. Permite colocar o formato da pgina, a orientao e a unidade de medida usada em todos os mtodos (exceto para a dimenso das fontes). Parmetros orientation Orientao da pagina padro. Possveis valores so (case insensitive): P : Retrato L : Paisagem O valor padro P. unit Unidade de medida. Possveis valores so: pt: pontos mm: milmetros cm: centmetros in: polegadas Um ponto equivalente a 1/72 da polegada, ou seja, cerca de 0,35 mm (uma polegada corresponde a 2.54 cm). Trata-se de uma da medida muito comum na tipografia; a dimenso da fonte expressa nesta unidade. O valor padro mm. format O formato utilizado pela pgina. Pode ser um dos seguinte valores (case insensitive): A3 A4 A5 Letter Legal

Ou um formato personalizado na forma de array bidimensional contendo a largura e a altura (expressa na unidade de medida dada na unidade).

Error
Error(string msg) Descrio Este mtodo chamado automaticamente no caso de erro fatal; retorna simplesmente a mensagem e pra a execuo. Uma classe derivada pode sobrescrever para customizar a administrao dos erros, mas deve sempre parar o script, ou o documento resultante provavelmente poder ser invlido. Parmetros msg A mensagem de erro.

ExtendsCode Footer GetMargin

GetStringWidth
float GetStringWidth(string s) Descrio Devolve o comprimento de uma string na unidade de medida utilizada. Deve ser selecionada uma fonte. Parmetros s A string de qual tem que calcular o comprimento.

GetX
float GetX() Descrio Devolve a abscissa da posio atual.

GetY
float GetY() Descrio Devolve a ordenada da posio atual.

Header
Header() Descrio Este mtodo usado para designar o ttulo da pgina. chamado automaticamente de AddPage() e no

deveria ser chamado diretamente da aplicao. A implementao em FPDF deixado vazio, ento necessita de uma subclasse e sobrescrever o mtodo se uma tentativa particular desejada. Exemplo class PDF extends FPDF function Header() //Seleciona Arial negrito 15 this.SetFont('Arial','B',15); //Move-se para a direita this.Cell(80); //Ttulo sem painel this.Cell(30,10,'Title',1,0,'C'); //Interrupo de linha this.Ln(20); end function

Image
Image(string file, float x, float y, float w [, float h [, string type [, mixed link]]]) Descrio Imprime uma imagem na pgina. Necessita especificar o ngulo esquerda superior e pelo menos uma das dimenses. A altura ou a largura podem ser calculadas automaticamente para manter as propores da imagem. Os formatos suportados so JPEG e PNG. Para JPEG so suportados todos os tipos: Escala de cinza True colors (24 bits) CMYK (32 bits) Se uma cor transparente for definida, ser se lembrado de l (mas s ser interpretado do Acrobat 4 em diante). O formato pode ser especificado explicitamente ou pode ser chamado pela extenso do arquivo. possvel inserir um link na imagem. Nota: se uma mesma imagem vem sendo usada diversas vezes, no arquivo s ser memorizado uma cpia. Parmetros file Nome do arquivo contendo a imagem. x Abscissa do ngulo no alto esquerda. y Ordenada do ngulo no alto esquerda. w Largura da imagem na pgina. Se igual zero, ser calculado automaticamente para manter as propores originais. h Altura da imagem na pgina. Se no especificar ou igual zero, ser calculado automaticamente para manter as propores originais. type Formato da imagem. Possveis valores so (case insensitive): JPG, JPEG, PNG. Se no especificou, o tipo ser puxado pela extenso do arquivo. link

O url ou o identificador devolvidos de AddLink().

Line
Line(float x1, float y1, float x2, float y2) Descrio Localiza uma linha entre dois pontos. Parmetros x1 Abscissa do primeiro ponto. y1 Ordenada do primeiro ponto. x2 Abscissa do segundo ponto. y2 Ordenada do segundo ponto.

Link
Link(float x, float y, float w, float h, mixed link) Descrio Insere um link em uma rea retangular da pgina. Os links em imagens ou texto geralmente vem inserido por Cell(), Write() o Image(), mas este mtodo pode ser til no caso de precisar que seja definida uma rea clicvel dentro de uma imagem. Parmetros x Abscissa do ngulo no alto esquerda do retngulo. y Ordenada do ngulo no alto esquerda do retngulo. w Largura do retngulo. h Altura do retngulo. link O url ou o identificador devolvidos por AddLink().

Ln
Ln([float h]) Descrio Efetua uma quebra de linha. A abscissa atual retorna margem esquerda e a ordenada aumenta de valor passado por parmetro. Parmetros h A altura da quebra. Por valor padro equivale altura da ltima clula impressa.

LoadExtension

LoadModels

MultiCell
MultiCell(float w, float h, string txt [, mixed border [, string align [, int fill]]]) Descrio Este mtodo permite imprimir texto com quebra de linha. Pode ser automtico (assim que o texto alcanar a borda direita da clula) ou explcito (atravs do caracteres \n). So inseridas tantas clulas quanto forem necessrio, uma sob a outra. O texto pode ser alinhado, centralizado ou justificado. possvel inserir bordas e fundo ao bloco de clulas. Parmetros w Largura das clulas. Se 0, o estende at a borda direita da pgina. h Altura das clulas. txt String da impreso. border Indica se precisa desenhar as bordas ao redor do bloco das clulas. O valor pode ser ambos um nmero 0: qualquer borda 1: moldura Ou uma string contendo alguns ou todos os caracteres seguintes (em qualquer ordem): L: esquerda T: superior R: direita B: inferior Valor padro: 0. align Impe o alinhamento do texto. Possveis valores so: L: alinha esquerda C: centraliza R: alinha direita J: justificado (valore padro) fill Indica se o fundo da clula deve ser exibido (1) ou deve ser transparente (0). Valor padro: 0.

Open
Open() Descrio Este mtodo comea a gerao do documento PDF; deve ser chamado antes de qualquer comando de sada. Este mtodo no cria nenhuma pgina, conseqentemente necessrio chamar AddPage().

Output
Output([string file [, boolean download]]) Descrio Salva o documento PDF em um arquivo local ou o envia ao browser. No segundo caso, possvel usar o plug-in (se existir) ou forar um download (caixa de dilogo Salvar como). O mtodo chama Close() se necessrio fechar o documento. Parmetros file O nome do arquivo. Se nulo ou no colocado, o documento ser enviado ao browser que ento usar o plug-in (se presente). download Se o arquivo for especificado, indica se deve ser salvo no local (falso) ou abrir uma caixa de dilogo "Salvar como" no browser. Valor padro: false.

PageNo
int PageNo() Descrio Devolve o nmero da pgina atual.

Rect
Rect(float x, float y, float w, float h [, string style]) Descrio Desenha um retngulo. Pode ser desenhado (s bordas), cheio (sem bordas) ou ambos. Parmetros x Abcissa do ngulo no alto esquerda. y Ordenada do ngulo no alto esquerda. w Largura. h Altura. style Estilo de esboo. Possveis valores so: D o uma string vazia: desenha. o valor padro. F: preenche DF o FD: desenha e preenche

SetAuthor
SetAuthor(string author) Descrio

Define o autor do documento Parmetros author Nome do autor.

SetAutoPageBreak
SetAutoPageBreak(boolean auto [, float margin]) Descrio Habilita ou desabilita a forma de interrupo de pgina automtica. Se habilitado, o segundo parmetro representa a distncia do fundo da pgina que define o limite de ativao. Por padro, a modalidade on e a borda 2 cm. Parmetros auto Booleano indica se a modalidade deve ser on ou off. margin Distancia do fundo da pgina.

SetCreator
SetCreator(string creator) Descrio Define o criador do documento. Tipicamente o nome da aplicao que gerou o PDF. Parmetros creator O nome do criador.

SetDisplayMode
SetDisplayMode(mixed zoom [, string layout]) Descrio Define a forma na qual o documento ser mostrado no visualizador. possvel ajustar o nvel do zoom: as pginas podem ser mostradas completamente na tela, para toda a pgina, usar as reais dimenses, representado em escala com um fator do zoom especfico ou usar os valores padres do visualizador (como configurado no menu Preferncias do Acrobat). possvel tambm especificar o layout de pgina: uma por vez, visualizao contnua, duas colunas ou padro do visualizador. Por padro, o documento utiliza a modalidade em todas as pginas e visualizao contnua. Parmetros zoom O zoom a ser usado. Pode ser um dos seguintes valores de string: fullpage: mostra a tela inteira na pagina fullwidth: para toda a pagina real: usa as reais dimenses (equivalente a zoom=100%) default: utiliza a modalidade padro do visualizador ou um nmero indica o nvel do zoom ser usado. layout O layout da pgina. Possveis valores so:

 single: mostra uma pgina por vez continuous: mostra a pgina em modo contnuo two: mostre duas pginas em duas colunas default: utiliza a modalidade padro do visualizador O valor padro continuous.

SetDrawColor
SetDrawColor(int r [, int g, int b]) Descrio Define a cor usada para todas as operaes de esboo (linhas, retngulos e bordas da clula). Pode ser expresso em componente RGB ou escala de cinza. O mtodo pode ser chamado antes da primeira pgina ser criada para manter o valor de pgina em pgina. Parmetros r Se g e b so dados, indica o componente vermelho; caso contrrio indica o nvel de cinza. Valores entre 0 e 255. g Componente verde (entre 0 e 255). b Componente azul (entre 0 e 255).

SetFillColor
SetFillColor(int r [, int g, int b]) Descrio Define a cor usada para todos os operaes de preenchimento (retngulos cheios e fundo das clulas). Pode ser expresso em componente RGB ou escala de cinza. O mtodo pode ser chamado antes da primeira pgina ser criada para manter o valor de pgina em pgina. Parmetros r Se g e b so dados, indica o componente vermelho; caso contrrio indica o nvel de cinza. Valores entre 0 e 255. g Componente verde (entre 0 e 255). b Componente azul (entre 0 e 255).

SetFont
SetFont(string family [, string style [, float size]]) Descrio Indica a fonte usada para imprimir string de caracteres. E' obrigatrio chamar este mtodo ao menos uma vez antes de imprimir algum texto ou o documento resultante podendo no ser vlido. A fonte pode ser ambos um padro ou um assistente mdio do mtodo AddFont (). As fontes Standard usam a codificao Windows cp1252 (Western Europe). O mtodo deve ser chamado antes da criao da primeira pgina para manter a fonte de pgina em pgina. Se for desejado que mude a dimenso da fonte, mais simples chamar SetFontSize ().

Nota: para o fontes standard, o arquivo com o mtrica das fontes deve ser acessvel. Para este propsito h trs possibilidades: So encontrados no diretrio atual (no qual reside o script em execuo) So encontrados em um dos diretrios definido pelo parmetro include_path So encontrados no diretrio definido pela constante FPDF_FONTPATH. Exemplo para o ltimo caso (notar a barra de fechamento): define('FPDF_FONTPATH','/home/www/font/'); require('fpdf.asp'); Se no for encontrado o arquivo correspondente ao que foi requisitado, ser gerado um erro Could not include font metric file. Parmetros family Famlia da fonte. Pode ser um nome definido por AddFont() ou um das famlias standards (case insensitive): Courier (fixed-width) Helvetica o Arial (sinnimo; sans serif) Times (serif) Symbol (symbolic) ZapfDingbats (symbolic) E' tambm possvel passar uma string vazia. Neste caso, preservada a famlia atual. style Estilo da fonte. Valores possveis so (case insensitive): String vazia: normal B: negrito I: itlico U: sublinhado Ou qualquer combinao. O valor padro normal. No possvel aplicar os estilos negrito e itlico a Symbol e ZapfDingbats. size Tamanho da fonte em pontos. O valor padro do tamanho atual. Se nenhuma dimenso no for especificada no incio do documento, o valor ser 12. Exemplo //Times normal 12 pdf.SetFont('Times') //Arial negrito 14 pdf.SetFont('Arial','B',14) //Remove o negrito pdf.SetFont('') //Times negrito, itlico e sublinhado 14 pdf.SetFont('Times','BIU')

SetFontSize
SetFontSize(float size) Descrio Define o tamanho da fonte atual. Parmetros size O tamanho (em pontos).

SetKeywords
SetKeywords(string keywords) Descrio Associa palavras chaves ao documento, geralmente na forma 'keyword2 de keyword1...'. Parmetros keywords A lista do keywords.

SetLeftMargin SetLeftMargin(float margin) Descrio Imposta il margine sinistro. Il metodo pu essere chiamato prima della creazione della prima pagina. Se l'ascissa corrente va fuori del margine, viene riportata nel margine. Impe a borda esquerda. O mtodo deve ser chamado antes da criao da primeira pgina. Se a abscissa atual sai da margem, trazida de bolta nesta margem. Parmetros margin A margem.

SetLineStyle

SetLineWidth
SetLineWidth(float width) Descrio Define a espessura da linha. Por padro, o valor de 0.2 mm. O mtodo pode ser chamado antes da criao da primeira pgina do documento para manter o valor em todas as pginas. Parmetros width A espessura.

[b]SetLink[/b] SetLink(int link [, float y [, int page]]) Descrio Define a pgina e a posio a qual um link aponta. Parmetros link O identificador do link retornado de AddLink(). y

Ordenada da posio do alvo; -1 indica a posio atual. O valor padro 0 (inicio da pagina). page Numero da pgina do alvo; -1 indica a pagina atual. o valor padro.

SetMargins
SetMargins(float left, float top [, float right]) Descrio Define as margens esquerda, superior e direito. Por padro so 1 cm. Chamar este mtodo para mudar. Parmetros left Margem esquerda. top Margem superior. right Margem direita. O valor padro igual ao valor da esquerda.

SetPath
SetPath([text path]) Descrio Define o caminho do diretrio FPDF, o subdiretrio, extenses, includes, fontes e modelos. Parmetros path Caminho relativo ou virtual do diretrio FPDF. Exemplo: pdf.SetPath("../fpdf/").

SetRightMargin
SetRightMargin(float margin) Descrio Define a margem direita. O mtodo pode ser chamado antes da criao da primeira pgina. Parmetros margin A margem.

SetSubject
SetSubject(string subject) Descrio Define o assunto do documento. Parmetros subject O assunto.

SetTextColor
SetTextColor(int r [, int g, int b]) Descrio Define a cor usado para o texto. Pode ser expresso em componente RGB ou em escala de cinza. O mtodo pode ser chamado antes da criao da primeira pgina para manter o valor de pgina em pgina. Parmetros r Se g e b so dados, indica o componente vermelho; caso contrrio indica o nvel de cinza. Valores entre 0 e 255. g Componente verde (entre 0 e 255). b Componente azul (entre 0 e 255).

SetTitle
SetTitle(string title) Descrio Define o ttulo do documento. Parmetros title o ttulo.

SetTopMargin
SetTopMargin(float margin) Descrio Define a margem superior. O mtodo pode ser chamado antes da criao da primeira pgina. Parmetros margin Il margine.

SetX
SetX(float x) Descrio Define a abscissa da posio atual. Se o valor passado for negativo, est direita em relao a esta pgina. Parmetros x O valor da abscissa.

SetXY

SetXY(float x, float y) Descrio Define a abscissa e a ordenada da posio atual. Se os valores passados forem negativos, eles so relativos respectivamente direita e ao fundo da pgina. Parmetros x O valor da abcissa. y O valor da ordenada.

SetY
SetY(float y) Descrio Move a abscissa atual de volta para a margem esquerda e impe a ordenada. Se o valor passado for negativo, relativo ao fundo da pgina. Parmetros y O valor da ordenada.

Text
Text(float x, float y, string txt) Descrio Imprime um caracteres da string. O incio da esquerda do primeiro caracteres. O verso est na esquerda do primeiro caractere, na linha base. Este mtodo permite posicionar de modo preciso uma string na pgina, mas mais comum usar Cell(), MultiCell() or Write() que so os mtodos padres para imprimir algum texto. Parmetros x Abcissa do documento. y Ordenada do documento. txt string da impresso

Write
Write(float h, string txt [, mixed link]) Descrio Este mtodo imprime o texto na posio atual. Quando a borda direita alcanada (ou o caractere \n for chamado) automaticamente que vai encabear e o texto continua da borda esquerda. Na sada de mtodo, a posio atual deixada extremidade do texto. possvel pr uma conexo no texto. Parmetros h altura da linha txt

string para imprimir. link URL ou identificador retornado por AddLink(). Exemplo pdf.write(5,'www.aspxnet.it', 'http://www.aspxnet.it');