Javascript PDF24 PDF API

Général

PDF24.org fournit un GRATUIT Service de génération de PDF pour créer des fichiers PDF. Ce Javascript API est une interface pour ce service.
L’API a été développé pour les blogs, forums, wiki et autres systèmes de logiciels internet basé sur des articles pour créer des fichiers PDF de manière simple. Développeur de blogs, forums et les systèmes de wiki peuvent utiliser cette API pour fournir un bouton PDF.

Location API

L‘API est situé à http://doc2pdf.pdf24.org/js/api.js. Vous pouvez télécharger ce fichier ou vous pouvez vous relier directement.

Références de la classe

Il existe deux principales classes Javascript qui doivent être utilisées pour créer un fichier PDF. La classe PDF24Doc fournit les fonctionnalités pour gérer le contenu général des documents telles que le titre du document ou l’URL du document et fournit des méthodes pour ajouter des éléments au document.
La classe PDF24Element représente un élément contenu dans un PDF24Doc document. Un élément de contenu est un récipient contenant des données telles que un titre et un corps HTML.

Le tableau suivant illustre le fait que:
PDF24Doc
PDF24Element 1
PDF24Element 2
PDF24Element 3

Classe PDF24Doc

Paramètres

charset
Le jeu de caractères du document. Par défaut c‘est ISO-8859-1. Présentement les valeurs prises en charge sont ISO-8859-1 et UTF-8.
headline
Le titre du document.
headlineUrl
L‘url titre de l’en-tête
baseUrl
L’URL de base de ce document. Cette URL est importante si vous utilisez des liens relatifs au contenu du corps des éléments. Cette URL est utilisée pour résoudre les liens relatifs à trouver des images et autres contenus.
filename
Le nom du fichier PDF créé, par exemple myFileName.
pageSize
La taille de chaque page du document. La taille est encodée comme LARGEURxHAUTEUR en considérant que la largeur est la largeur de chaque page en mm et la hauteur est la hauteur de chaque page en mm. La largeur par défaut est 210 mm et la hauteur par défaut est 297 mm =m ce qui représente une page A4 ISO.
emailTo
Une ou plusieurs adresses courriels séparées par une virgule. Cette adresse courriel recevront les fichiers PDF créés.
emailFrom
L’adresse courriel de l’utilisateur API qui apparaîtra comme l’adresse courriel ‘De’ dans les courriels avec les fichiers PDF joints.
emailSubject
Le sujet de l’email avec le PDF créé en fichier joint.
emailBody
Le contenu de l’email avec le PDF créé en fichier joint.
emailBodyType
Le type du corps du courriel avec le fichier PDF créé en pièce jointe. Les valeurs valides sont text et html.
emailCharset
Ce paramètre contient le jeu de caractères de l’objet et le corps des courriels. Présentement, les valeurs prises en charge sont ISO-8859-1 et UTF-8.

Constructeurs

PDF24Doc()
Crée un object de document sans paramètres. Utilisez les méthodes setXX afin de nommer les paramètres plus tard.
PDF24Doc(params)
Crée un objet de document et initialisé les paramètres de document avec les paramètres donnés dans params

Méthodes

addElement(element)
Ajoute l‘élément element au document PDF.
setParam(paramKey, paramValue)
Définit un paramètre de document avec la touche paramKey et la valeur paramValue.
getParam(paramKey)
Retourne le paramètre du document avec la touche paramKey.
setCharset(charset)
Définit le charset paramètre du document à charset. Le jeu de caractères par défaut est ISO-8859-1.
setHeadline(headline)
Définit le headline paramètre du document à headline.
setHeadlineUrl(headlineUrl)
Définit le headlineUrl paramètre du document à headlineUrl.
setBaseUrl(baseUrl)
Définit le baseUrl paramètre du document à baseUrl.
setFilename(filename)
Définit le filename paramètre du document à filename.
setPageSize(width, height)
Définit le pageSize paramètre du document à width, height.
setEmailTo(emailAddr)
Définit le emailTo paramètre du document à emailAddr.
addEmailTo(emailAddr)
Ajoute l‘adresse courriel emailAddr à la liste des récepteurs pour le fichier PDF.
setEmailFrom(emailAddr)
Définit le emailFrom paramètre du document à emailAddr.
setEmailSubject(subject)
Définit le emailSubject paramètre du document à subject.
setEmailBodyType(bodyType)
Définit le emailBodyType paramètre du document à bodyType. bodyType peut être text ou html.
setEmailBody(body)
Définit le emailBody paramètre du document à body.
setEmailCharset(charset)
Définit le charset du corps et l’objet du courriel avec le fichier pdf joint.
create()
Cette méthode regroupe tous les paramètres donnés dans un formulaire et le soumet dans une fenêtre popup au service de création de PDF PDF24. Le service vérifie les paramètres et crée le fichier PDF. Les méthodes d’états sont imprimées à la fenêtre popup pour que l’utilisateur puisse voir l’état de création de PDF.

Classe PDF24Element

Paramètres

title
Le titre de l’élément.
url
L‘URL de l‘élément. Le titre et l‘URL sont utilisés pour former un lien.
author
L‘auteur de la teneur en éléments.
dateTime
Un horodatage (Toute chaîne qui représente un horodatage, par exemple, la date et l’heure ou la date ou l’heure seulement)
body
Le contenu de l’élément. Peut être uni ou texte html.

Constructeurs

PDF24Element()
Crée un élément sans paramètres. Utilisez les méthodes setXX afin de définir des paramètres plus tard.

Méthodes

setTitle(title)
Définit le title paramètre de l’élément à title.
setUrl(url)
Définit le url paramètre de l’élément à url. Le titre et l’URL, ensemble, forment un lien.
setAuthor(author)
Définit le author paramètre de l’élément à author.
setDateTime(dateTime)
Définit le dateTime paramètre de l’élément à dateTime.
setBody(body)
Définit le body paramètre de l’élément à body. body peut être simple ou en texte HTML

Exemples de Code

Inclure le javascript PDF API dans votre document en ajoutant la ligne suivante à votre page Web:

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

Exemple 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();

Exemple 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();

Test de Generation PDF

Ici vous avez un formulaire simple pour tester le Javascript PDF API. Remplissez les champs du formulaire ci-dessous et cliquez sur le bouton Envoyer pour créer un fichier PDF. Le fichier PDF sera envoyé à l‘adresse courriel indiquée.
Document Paramètre
Charset
Titre
En-têteUrl
BaseUrl
Nom du fichier
FormatPage
Paramètre courriel
CourrielÀ
CourrielDe
SujetCourriel
TypeCorpsCourriel
CorpsCourriel
Élément
Titre
Url
Auteur
JourHeure
Corps
» Accueil » FAQ » Forum » Nouvelles » Documents » PDF Creator
» Fax Online » DOC 2 PDF