API PDF Javascript PDF24

Geral

PDF24.org fornece uma GRÁTIS serviço de geração PDF para criar ficheiros PDF. Esta API Javascript é um interface para este serviço.
A API foi desenvolvido para blogs, fóruns, sistemas wiki e outros softwares de internet baseados em artigos para criar ficheiros PDF de forma fácil. Criadores de blogs, fóruns e sistemas wiki podem usar este API para fornecer um botão PDF.

Localização da API

A API está localizado em http://doc2pdf.pdf24.org/js/api.js. Você pode baixar o ficheiro ou pode ligar directamente a ele.

Referências de Classe

Existem duas classes principais Javascript que devem ser usadas para criar um ficheiros PDF. A classe PDF24Doc fornece a funcionalidade para gerir o conteúdo geral do documento, tais como título e o URL do documento e fornece métodos para adicionar elementos no documento.
A classe PDF24Element representa um elemento de conteúdo dentro de uma PDF24Doc documento. Um elemento de conteúdo é um contentor que contém alguns dados, tais como um título e um conteúdo html.

A tabela a seguir mostra que:
PDF24Doc
PDF24Elemento 1
PDF24Elemento 2
PDF24Element 3

Classe PDF24Doc

Parâmetros

charset
O grupo de caracteres do documento. Por defeito é ISO-8859-1. Os valores presentemente suportados são ISO-8859-1 e UTF-8.
headline
O cabeçalho do documento.
headlineUrl
O URL do cabeçalho do título.
baseUrl
O baseUrl do documento. Este URL é importante se você usar links relativos no conteúdo do corpo dos elementos. Este URL é usado para os links relativos encontrarem imagens e outros conteúdos.
filename
O nome do ficheiro PDF criado, por exemplo meuNomeDeFicheir.
pageSize
O tamanho de cada página do documento. O tamanho é codificado como LARGURAxALTURA onde LARGURA é a largura de cada página em mm e a ALTURA é a altura de cada página em mm. A largura por defeito é de 210 milímetros e a altura por defeito é de 297 milímetros, o que representa uma página A4 ISO.
emailTo
Um ou mais endereços de e-mail separados por ponto e vírgula. Este endereço de e-mail irá receber os ficheiros PDF criados.
emailFrom
O endereço de e-mail do utilizador API, que será exibido como o „De“ num endereço e-mail em e-mails com ficheiros PDF em anexo.
emailSubject
O assunto do e-mail com o ficheiro PDF em anexo.
emailBody
O conteúdo do e-mail com o ficheiro PDF em anexo.
emailBodyType
O tipo do conteúdo do e-mail com o ficheiro PDF em anexo. Os valores válidos são text e html.
emailCharset
Este parâmetro contém o grupo de caracteres do assunto e do conteúdo do e-mail. Os valores suportados presentemente são ISO-8859-1 e UTF-8.

Constructores

PDF24Doc()
Cria um objecto de documento sem parâmetros. Use os métodos setXX para definir parâmetros mais tarde.
PDF24Doc(params)
Cria um objecto do documento e inicializa os parâmetros do documento com os parâmetros indicados em params

Métodos

addElement(element)
Adiciona o elemento element para o documento PDF.
setParam(paramKey, paramValue)
Define um parâmetro de documento com a chave paramKey e o valor paramValue.
getParam(paramKey)
Devolve o parâmetro do documento com a chave paramKey.
setCharset(charset)
Define o charset parâmetro do documento para charset. O conjunto de caracteres por defeito é ISO-8859-1.
setHeadline(headline)
Define o headline parâmetro do documento para headline.
setHeadlineUrl(headlineUrl)
Define o headlineUrl parâmetro do documento para headlineUrl.
setBaseUrl(baseUrl)
Define o baseUrl parâmetro do documento para baseUrl.
setFilename(filename)
Define o filename parâmetro do documento para filename.
setPageSize(width, height)
Define o pageSize parâmetro do documento para width, height.
setEmailTo(emailAddr)
Define o emailTo parâmetro do documento para emailAddr.
addEmailTo(emailAddr)
Adiciona o endereço de e-mail emailAddr para a lista de receptores do ficheiro PDF.
setEmailFrom(emailAddr)
Define o emailFrom parâmetro do documento para emailAddr.
setEmailSubject(subject)
Define o emailSubject parâmetro do documento para subject.
setEmailBodyType(bodyType)
Define o emailBodyType parâmetro do documento para bodyType. bodyType pode ser text ou html.
setEmailBody(body)
Define o emailBody parâmetro do documento para body.
setEmailCharset(charset)
Define a codificação do corpo e do objecto do e-mail com o ficheiro PDF em anexo.
create()
Este método engloba todos os parâmetros indicados num formulário e submete-o numa janela pop-up para o serviço de criação PDF do PDF24.org. O serviço verifica os parâmetros e cria o ficheiro PDF. Os métodos de estado são impressos na janela popup para que o utilizador possa ver o estado da criação do PDF.

Classe PDF24Element

Parâmetros

title
O título do elemento.
url
O URL do elemento. O título e o URL são usados para formar uma ligação.
author
O autor do conteúdo dos elementos.
dateTime
Um timestamp (Qualquer sequência de caracteres que representa uma hora, por exemplo, a data e hora ou apenas data ou hora)
body
O conteúdo do elemento. Pode ser texto simples ou formatado em html.

Constructores

PDF24Element()
Cria um elemento sem parâmetros. Use os métodos setXX para definir parâmetros mais tarde.

Métodos

setTitle(title)
Define o title parâmetro do elemento para title.
setUrl(url)
Define o url parâmetro do elemento para url. O título e o url juntos formam um link.
setAuthor(author)
Define o author parâmetro do elemento para author.
setDateTime(dateTime)
Define o dateTime parâmetro do elemento para dateTime.
setBody(body)
Define o body parâmetro do elemento para body. body pode ser texto simples ou formatado em html.

Amostras de Código

Incluir o Javscript PDF API no seu documento, adicionando a seguinte linha à sua página web:

<script type="text/javascript" src="http://doc2pdf.pdf24.org/js/api.js"></script>

Amostra 1


/*
* Create a PDF24 document and set parameters
*/
var doc = new PDF24Doc();
doc.setCharset("UTF-8");
doc.setHeadline("The is the document headline");
doc.setHeadlineUrl("http://www.pdf24.org");
doc.setBaseUrl("http://www.pdf24.org");
doc.setFilename("test");
doc.setPageSize(210, 297);

doc.setEmailTo("stefanz@pdf24.org");
doc.setEmailFrom("stefanz@pdf24.org");
doc.setEmailSubject("Here is your created PDF file");
doc.setEmailBody("The created PDF file is attached to this email. Regards www.pdf24.org!");
doc.setEmailBodyType("text");

/*
* Create one or more elements
*/
var element = new PDF24Element();
element.setTitle("This is a title");
element.setUrl("http://www.pdf24.org");
element.setAuthor("Stefan Ziegler");
element.setDateTime("2010-04-15 8:00");
element.setBody("This is the content of the element");

/*
* Add the element
*/
doc.addElement(element);

/*
* Create the PDF file
*/
doc.create();

Amostra 2


/*
* Create a document with parameters
*/
var doc = new PDF24Doc({
	charset : "UTF-8",
	headline : "This ist the headline",
	headlineUrl : "http://www.pdf24.org",
	baseUrl : "http://www.pdf24.org",
	filename : "test",
	pageSize : "210x297"
	emailTo : "stefanz@pdf24.org",
	emailFrom : "stefanz@pdf24.org",
	emailSubject: "Here is your created PDF files",
	emailBody: "The created PDF file is attached to this email. Regards www.pdf24.org!"
	emailBodyType: "text"
});

/*
* Add an element without using PDF24Element
*/
doc.addElement({
	title : "This is a title",
	url : "http://www.pdf24.org",
	author : "Stefan Ziegler",
	dateTime : "2010-04-15 8:00",
	body : "THis is the content of the element"
});

/*
* Create the PDF file
*/
doc.create();

Teste de Geração PDF

Aqui tem um formulário simples para testar o API PDF Javascript. Preencha os campos do formulário abaixo e clique no botão enviar para criar um ficheiro PDF. O ficheiro PDF será enviado para o endereço de e-mail facultado.
Parâmetro do Documento
Codificação de Caracteres
Cabeçalho
Cabeçalho Url
BaseUrl
Nome do ficheiro
TamanhoPágina
E-mail Parâmetro
E-mailPara
E-mailDe
E-mailsubject
Tipo E-mailConteúdo
ConteúdoE-mail
Elemento
Título
Url
Autor
DiaHora
Conteúdo
» Início » FAQ » Fórum » Notícias » Documentos » PDF Creator
» Fax Online » DOC 2 PDF