Style - Inclus, global

Crée un style pour définir des propriétés telles que la taille de police, la bordure et l’alignement. Vous pouvez appliquer le même style à plusieurs objets simultanément.

Cette API fait partie du module d’extension ServiceNow PDF Generation Utilities (com.snc.apppdfgenerator) et est fournie dans l’espace de noms sn_pdfgeneratorutils . Le module d’extension est activé par défaut.

Cette API est un composant utilisé avec l’API Document pour générer un PDF.

Vous pouvez appliquer des styles personnalisés aux éléments d’API suivants :

• Cellule
• Paragraphe
• Table

style : style()

Instancie un nouvel objet Style .

Tableau 1. Paramètres

Nom	Type	Description
Aucun

Les exemples suivants montrent comment créer un objet Style que vous pouvez ajouter à un élément Cellule, Paragraphe ou Tableau .

var style = new sn_pdfgeneratorutils.Style();

Style – setBackgroundColor(Couleur de couleur)

Spécifie la couleur d’arrière-plan d’un élément.

Tableau 2. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur d’arrière-plan.

Tableau 3. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir la couleur d’arrière-plan d’un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var color = new sn_pdfgeneratorutils.Color([1, 0.9, 0.9]); // provided as array of RGB float values

style.setBackGroundColor(color);

Style – setBold()

Définit un style sur police en gras.

Tableau 4. Paramètres

Nom	Type	Description
Aucun

Tableau 5. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir un style en gras.

var style = new sn_pdfgeneratorutils.Style();
style.setBold();

Style – setBorder(Number width)

Définit la bordure du style sur les quatre côtés d’un élément.

Tableau 6. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.

Tableau 7. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorder(width);

Style – setBorderBottom(largeur du nombre)

Définit la bordure du style au bas d’un élément.

Tableau 8. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.

Tableau 9. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style au bas d’un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderBottom(width);

Style – setBorderLeft(largeur du nombre)

Définit la bordure du style sur le côté gauche d’un élément.

Tableau 10. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.

Tableau 11. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style sur le côté gauche d’un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderLeft(width);

Style – setBorderRight(largeur du nombre)

Définit la bordure du style sur le côté droit d’un élément.

Tableau 12. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.

Tableau 13. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style sur le côté droit d’un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderRight(width);

Style – setBorderTop(largeur du nombre)

Définit la bordure du style en haut d’un élément.

Tableau 14. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.

Tableau 15. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style en haut d’un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderTop(width);

Style – setColoredBorder (largeur du nombre, couleur de couleur)

Définit la bordure de style avec une couleur sur les quatre côtés d’un élément.

Tableau 16. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.
couleur	Couleur	Couleur de la bordure du style.

Tableau 17. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style avec de la couleur. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorder(width, borderColor);

Style – setColoredBorderBottom(largeur du nombre, couleur de couleur)

Définit la bordure de style avec une couleur sur le côté inférieur d’un élément.

Tableau 18. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.
couleur	Couleur	Couleur de la bordure du style.

Tableau 19. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style au bas d’un élément.Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderBottom(width, borderColor);

Style – setColoredBorderLeft(largeur du nombre, couleur de couleur)

Définit la bordure de style avec une couleur sur le côté gauche d’un élément.

Tableau 20. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.
couleur	Couleur	Couleur de la bordure du style.

Tableau 21. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderLeft(width, borderColor);

Style – setColoredBorderRight(largeur du nombre, couleur de couleur)

Définit la bordure de style avec une couleur sur le côté droit d’un élément.

Tableau 22. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.
couleur	Couleur	Couleur de la bordure du style.

Tableau 23. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style avec de la couleur. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderRight(width, borderColor);

Style – setColoredBorderTop(largeur du nombre, couleur de couleur)

Définit la bordure de style avec une couleur sur la partie supérieure d’un élément.

Tableau 24. Paramètres

Nom	Type	Description
largeur	Numéro	Largeur de bordure du style en points.
couleur	Couleur	Couleur de la bordure du style.

Tableau 25. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une bordure de style. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var width = 1.0;
var borderColor = new sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);

style.setColoredBorderTop(width, borderColor);

Style – setFontColor(Couleur de couleur)

Définit une couleur de police.

Tableau 26. Paramètres

Nom	Type	Description
couleur	Couleur	Couleur de police.

Tableau 27. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une couleur de police. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var fontColor = new sn_pdfgeneratorutils.Color([1,0.5,0.5]);

style.setFontColor(fontColor);

Style – setFontSize(Number fontSize)

Définit une taille de police de style.

Tableau 28. Paramètres

Nom	Type	Description
fontSize (en anglais seulement)	Numéro	Taille de police en points.

Tableau 29. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir une taille de police.

var style = new sn_pdfgeneratorutils.Style();

style.setFontSize(12);

Style – setHorizontalAlignment(Alignement des chaînes)

Définit l’alignement horizontal d’un style.

Tableau 30. Paramètres

Nom	Type	Description
alignement	Chaîne	Réglage de l’alignement horizontal. Valeurs valides : center : permet d’aligner le contenu sur le centre. left : Alignez le contenu vers la gauche. droite : alignez le contenu vers la droite.

Tableau 31. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir l’alignement horizontal sur un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var alignment = "Center";

style.setHorizontalAlignment(alignment);

Style – setItalic()

Définit un style sur la police italique.

Tableau 32. Paramètres

Nom	Type	Description
Aucun

Tableau 33. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir un style d’élément sur une police italique.

var style = new sn_pdfgeneratorutils.Style();
style.setItalic();

Style : setPadding(remplissage des numéros)

Définit le remplissage des quatre côtés d’un élément à la même largeur.

Voir aussi :

• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

Tableau 34. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 35. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le style de fond sur 2,5 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPadding(padding);

Style : setPaddingBottom(remplissage des numéros)

Définit la valeur de la largeur du remplissage inférieur d’un élément.

Voir aussi :

• setPadding()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

Tableau 36. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 37. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de l’élément inférieur sur 2,5 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingBottom(padding);

Style : setPaddingLeft(remplissage des numéros)

Définit la valeur de la largeur de remplissage gauche d’un élément.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingRight()
• setPaddingTop()

Tableau 38. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 39. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de l’élément gauche sur 2,5 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingLeft(padding);

Style – setPaddingRight(remplissage des numéros)

Définit la valeur de la largeur de marge intérieure droite d’un style.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingTop()

Tableau 40. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 41. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de l’élément droit sur 2,5 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingRight(padding);

Style : setPaddingTop(remplissage des numéros)

Définit la valeur de la largeur du remplissage supérieur d’un élément.

Voir aussi :

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()

Tableau 42. Paramètres

Nom	Type	Description
Marge intérieure	Numéro	Largeur de remplissage en points sous forme de valeur décimale.

Tableau 43. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le remplissage de l’élément supérieur sur 2,5 points. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingTop(padding);

Style – setTextAlignment(Alignement des chaînes)

Définit l’alignement du texte pour un style.

Tableau 44. Paramètres

Nom	Type	Description
alignement	Chaîne	Position d’alignement du texte. Valeurs valides : text-center : aligne le texte au centre. text-justified : modifie l’espace entre les caractères pour remplir complètement le texte entre les côtés gauche et droit. La dernière ligne est alignée à gauche. text-justified-all : justifie l’alignement du texte, y compris la dernière ligne. text-left : Aligner le texte vers la gauche. text-right : Aligner le texte à droite.

Tableau 45. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir le texte de l’élément sur l’alignement central.

var style = new sn_pdfgeneratorutils.Style();

String alignment = "text-center";

style.setTextAlignment(alignment);

Style – setVerticalAlignment(Alignement des chaînes)

Définit l’alignement vertical de cet élément.

Tableau 46. Paramètres

Nom	Type	Description
alignement	Chaîne	Réglage de l’alignement vertical. Valeurs valides : bottom : aligne le contenu vers le bas. mid : aligne le contenu sur le centre. top : aligne le contenu sur le haut.

Tableau 47. Renvoie

Type	Description
Aucun

L’exemple suivant montre comment définir l’alignement vertical sur un élément. Pour obtenir un exemple d’utilisation de document, consultez API de document .

var style = new sn_pdfgeneratorutils.Style();

var alignment = "Mid";

style.setVerticalAlignment(alignment);