---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Paragraphe - Champ d'application, Global

# Paragraphe - Champ d'application, Global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 6 minutes de lecture

Crée un objet Paragraphe représentant un bloc de texte dans un PDF.

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](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") pour générer un PDF.

## Paragraphe - Paragraphe(Texte de chaîne) {#ariaid-title2}

Instancie un nouvel objet Paragraph contenant une chaîne.
{#Paragraph-Paragraph_S__table_twm_hjk_34b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Texte | Chaîne | Bloc de texte de paragraphe. |
[Tableau 1. Paramètres]

{#Paragraph-Paragraph_S__table_twm_hjk_34b}  
L'exemple suivant montre comment créer un objet Paragraphe . Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var para = new Paragraph("hello");

## Paragraphe -- addNewLine() {#ariaid-title3}

Ajoute une ligne vide après un paragraphe d'un document.
{#Paragraph-addNewLine__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 2. Paramètres]

{#Paragraph-addNewLine__table_vv5_52h_44b} {#Paragraph-addNewLine__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 3. Renvoie]

{#Paragraph-addNewLine__table_wv5_52h_44b}  
L'exemple suivant montre comment ajouter une nouvelle ligne après un paragraphe dans un document. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
            
    var myPara = new sn_pdfgeneratorutils.Paragraph("This is a paragraph.");
    myPara.addNewLine();

    document.addParagraph(myPara);       
    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "addText.pdf");

## Paragraphe -- addParagraph(Paragraphe paragraphe) {#ariaid-title4}

Ajoute un paragraphe. Vous pouvez utiliser cette méthode pour créer un bloc de paragraphes avec des sauts de ligne automatiques.
{#Paragraph-addParagraph_O__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| paragraphe | [Paragraphe](https://servicenow-prod.fluidtopics.net/iphn387l2mJO3QrqPi7U_A#Paragraph-Paragraph_S "Instancie un nouvel objet Paragraph contenant une chaîne.") | Objet du paragraphe. |
[Tableau 4. Paramètres]

{#Paragraph-addParagraph_O__table_vv5_52h_44b} {#Paragraph-addParagraph_O__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 5. Renvoie]

{#Paragraph-addParagraph_O__table_wv5_52h_44b}  
L'exemple suivant montre comment ajouter une section de paragraphes à un document. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var sectionPara = new sn_pdfgeneratorutils.Paragraph("This is the first paragraph.");
    var subPara1 = new sn_pdfgeneratorutils.Paragraph("Pellentesque nec neque interdum turpis ultricies tristique at ut lacus. Nam eget sollicitudin.");
    var subPara2 = new sn_pdfgeneratorutils.Paragraph("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vel ultrices erat.");
    var subPara3 = new sn_pdfgeneratorutils.Paragraph("Aenean fermentum lorem congue metus faucibus, vitae viverra quam eleifend. Donec sed risus quis eros suscipit efficitur.");

    sectionPara.addParagraph(subPara1);
    sectionPara.addParagraph(subPara2);
    sectionPara.addParagraph(subPara3);

    document.addParagraph(sectionPara);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

## Paragraphe -- addString(contenu de la chaîne) {#ariaid-title5}

Ajoute une chaîne de texte à un paragraphe. Cette méthode n'insère pas automatiquement un espace précédant le contenu.
{#Paragraph-addString_S__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| contenu | Chaîne | Informations à inclure dans un paragraphe. |
[Tableau 6. Paramètres]

{#Paragraph-addString_S__table_vv5_52h_44b} {#Paragraph-addString_S__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 7. Renvoie]

{#Paragraph-addString_S__table_wv5_52h_44b}  
L'exemple suivant montre comment ajouter une nouvelle phrase à un paragraphe. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var myPara = new sn_pdfgeneratorutils.Paragraph("This is the first sentence.");

    myPara.addString(" This is the second sentence in the same paragraph. Spaces are not inserted automatically.")

    document.addParagraph(myPara);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "filename.pdf");

## Paragraphe -- addStyle(Style style) {#ariaid-title6}

Applique un style prédéfini au texte du paragraphe.
{#Paragraph-addStyle_O__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| style | [Style](https://servicenow-prod.fluidtopics.net/9xHkdcyTt9dqekn9Y8Usiw#StyleBothAPI "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.") | Style à appliquer à cet élément. |
[Tableau 8. Paramètres]

{#Paragraph-addStyle_O__table_vv5_52h_44b} {#Paragraph-addStyle_O__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 9. Renvoie]

{#Paragraph-addStyle_O__table_wv5_52h_44b}  
L'exemple suivant montre comment appliquer un style à un paragraphe. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    // Create a font color (result is purple)
    var fontColor = new sn_pdfgeneratorutils.Color([0.5,0.0,0.5]);

    // Create a style for your paragraph
    var paraStyle = new sn_pdfgeneratorutils.Style();
    paraStyle.setFontColor(fontColor);
    paraStyle.setFontSize(10);

    var myPara = new sn_pdfgeneratorutils.Paragraph("This paragraph has style.");

    myPara.addStyle(paraStyle);


    document.addParagraph(myPara);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "addStyle.pdf");

## Paragraphe -- setFixedPosition(Numéro à gauche, Nombre en bas, Nombre de largeur) {#ariaid-title7}

Définit un élément de paragraphe à une position fixe sur la page.
{#Paragraph-setFixedPosition_N_N_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| Gauche | Numéro | Indentation à partir du côté gauche de la page PDF en points. |
| bas | Numéro | Position à partir du bas de la page PDF en points. |
| largeur | Numéro | Largeur de l'élément de paragraphe en points. Cette valeur détermine la longueur à laquelle la ligne s'interrompt. |
[Tableau 10. Paramètres]

{#Paragraph-setFixedPosition_N_N_N__table_vv5_52h_44b} {#Paragraph-setFixedPosition_N_N_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 11. Renvoie]

{#Paragraph-setFixedPosition_N_N_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir une position fixe sur une page. Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    // Create a style
    var paraStyle = new sn_pdfgeneratorutils.Style();
    paraStyle.setFontSize(48);
    paraStyle.setBold();

    // my paragraph
    var para = new sn_pdfgeneratorutils.Paragraph("Document Title");

    para.setFixedPosition(204,400,240);

    para.setTextAlignment("text-center");
    para.addStyle(paraStyle);


    document.addParagraph(para);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "fileName.pdf");

## Paragraphe -- setMargin(Marge du nombre) {#ariaid-title8}

Définit la marge de chaque paragraphe.
Pour définir les quatre marges avec une ou plusieurs valeurs uniques, utilisez [setMargins().](https://servicenow-prod.fluidtopics.net/iphn387l2mJO3QrqPi7U_A#Paragraph-setMargins_N_N_N_N "Définit une taille pour chaque marge de paragraphe.")
{#Paragraph-setMargin_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| marge | Numéro | Valeur des marges supérieure, droite, inférieure et gauche en points. |
[Tableau 12. Paramètres]

{#Paragraph-setMargin_N__table_vv5_52h_44b} {#Paragraph-setMargin_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 13. Renvoie]

{#Paragraph-setMargin_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir toutes les marges du paragraphe sur 48 points.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var margins = 48.0;

    var myPara = new sn_pdfgeneratorutils.Paragraph("Paragraph text with all margins set to the same value.");
    myPara.setMargin(margins);

    document.addParagraph(myPara);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");

## Paragraphe -- setMarginBottom(Marge du nombre) {#ariaid-title9}

Définit la marge inférieure d'un paragraphe.
{#Paragraph-setMarginBottom_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| marge | Numéro | Hauteur de la marge inférieure en points. |
[Tableau 14. Paramètres]

{#Paragraph-setMarginBottom_N__table_vv5_52h_44b} {#Paragraph-setMarginBottom_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 15. Renvoie]

{#Paragraph-setMarginBottom_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir la marge inférieure d'un paragraphe sur un point.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var marginVal = 1.0;

    var paraMarginBottom = new sn_pdfgeneratorutils.Paragraph("Paragraph text with bottom margin set.");
    paraMarginBottom.setMarginBottom(marginVal);

    document.addParagraph(paraMarginBottom);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");

## Paragraphe -- setMarginLeft(Marge numérique) {#ariaid-title10}

Définit la marge gauche d'un paragraphe.
{#Paragraph-setMarginLeft_N__table_vv5_52h_44b__entry__3}{#Paragraph-setMarginLeft_N__docviewer-api-parm-leftM-des}

| Nom | Type | Description |
|-|-|-|
| Marge gauche | Numéro | Largeur de la marge de gauche en points. |
[Tableau 16. Paramètres]

{#Paragraph-setMarginLeft_N__table_vv5_52h_44b} {#Paragraph-setMarginLeft_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 17. Renvoie]

{#Paragraph-setMarginLeft_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir la marge gauche d'un paragraphe sur un point.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var marginVal = 1.0;

    var paraMarginLeft = new sn_pdfgeneratorutils.Paragraph("Paragraph text with left margin set.");
    paraMarginLeft.setMarginLeft(marginVal);

    document.addParagraph(paraMarginLeft);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");

## Paragraphe -- setMarginRight(Marge du nombre) {#ariaid-title11}

Définit la marge droite d'un paragraphe.
{#Paragraph-setMarginRight_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| marge | Numéro | Largeur de la marge de droite en points. |
[Tableau 18. Paramètres]

{#Paragraph-setMarginRight_N__table_vv5_52h_44b} {#Paragraph-setMarginRight_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 19. Renvoie]

{#Paragraph-setMarginRight_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir la marge droite d'un paragraphe sur un point.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var marginVal = 1.0;

    var paraMarginRight = new sn_pdfgeneratorutils.Paragraph("Paragraph text with right margin set.");
    paraMarginRight.setMarginRight(marginVal);

    document.addParagraph(paraMarginRight);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");

## Paragraphe -- setMargins(Nombre marginTop, Number marginRight, Number marginBottom, Number marginLeft) {#ariaid-title12}

Définit une taille pour chaque marge de paragraphe.
Pour définir chaque marge sur la même valeur, utilisez [setMargin().](https://servicenow-prod.fluidtopics.net/iphn387l2mJO3QrqPi7U_A#Paragraph-setMargin_N "Définit la marge de chaque paragraphe.")
{#Paragraph-setMargins_N_N_N_N__table_vv5_52h_44b__entry__3}{#Paragraph-setMargins_N_N_N_N__docviewer-api-parm-topM-des}{#Paragraph-setMargins_N_N_N_N__docviewer-api-parm-rightM-des}{#Paragraph-setMargins_N_N_N_N__docviewer-api-parm-bottomM-des}{#Paragraph-setMargins_N_N_N_N__docviewer-api-parm-leftM-des}

| Nom | Type | Description |
|-|-|-|
| Marge supérieure | Numéro | Hauteur de la marge supérieure en points. |
| Marge droite | Numéro | Largeur de la marge de droite en points. |
| Marge inférieure | Numéro | Hauteur de la marge inférieure en points. |
| Marge gauche | Numéro | Largeur de la marge de gauche en points. |
[Tableau 20. Paramètres]

{#Paragraph-setMargins_N_N_N_N__table_vv5_52h_44b} {#Paragraph-setMargins_N_N_N_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 21. Renvoie]

{#Paragraph-setMargins_N_N_N_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir les marges des paragraphes.Pour obtenir un exemple d'utilisation de document, consultez [API de document](https://servicenow-prod.fluidtopics.net/d3lN_FuuV~kguOiXJFlaSg#DocumentBothAPI "L’API Document fournit des méthodes pour initialiser un PDF, ajouter du contenu et fermer le PDF. Après avoir ajouté du contenu, le document peut être joint à un enregistrement cible.") .

    var para = new sn_pdfgeneratorutils.Paragraph("Paragraph text.");

    var topMargin = 1.0;
    var rightMargin = 1.0;
    var bottomMargin = 1.0;
    var leftMargin = 1.5;

    para.setMargins(marginTop, marginRight, marginBottom, marginLeft);

## Paragraphe -- setMarginTop(Marge numérique) {#ariaid-title13}

Définit la marge supérieure d'un paragraphe.
{#Paragraph-setMarginTop_N__table_vv5_52h_44b__entry__3}

| Nom | Type | Description |
|-|-|-|
| marge | Numéro | Hauteur de la marge supérieure en points. |
[Tableau 22. Paramètres]

{#Paragraph-setMarginTop_N__table_vv5_52h_44b} {#Paragraph-setMarginTop_N__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 23. Renvoie]

{#Paragraph-setMarginTop_N__table_wv5_52h_44b}  
L'exemple suivant montre comment définir la marge supérieure d'un paragraphe sur un point.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("LETTER");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var marginVal = 1.0;

    var paraMarginTop = new sn_pdfgeneratorutils.Paragraph("Paragraph text with top margin set.");
    paraMarginTop.setMarginTop(marginVal);

    document.addParagraph(paraMarginTop);

    // save pdf as attachment to target record in the Incident table
    document.saveAsAttachment("incident", "<record_sys_id>", "docName.pdf");

## Paragraphe -- setTextAlignment(Alignement des chaînes) {#ariaid-title14}

Définit l'alignement du texte de ce paragraphe.
{#Paragraph-setTextAlignment_S__table_vv5_52h_44b__entry__3}

| 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. {#Paragraph-setTextAlignment_S__ul_sgj_44p_p4b} |
[Tableau 24. Paramètres]

{#Paragraph-setTextAlignment_S__table_vv5_52h_44b} {#Paragraph-setTextAlignment_S__table_wv5_52h_44b__entry__2}

| Type | Description |
|-|-|
| Aucun |   |
[Tableau 25. Renvoie]

{#Paragraph-setTextAlignment_S__table_wv5_52h_44b}  
L'exemple suivant montre comment définir le texte du paragraphe sur l'alignement à gauche.

    var paragraph = new sn_pdfgeneratorutils.Paragraph("This paragraph text is centered.");
            
    var alignment = "text-center";
           
    paragraph.setTextAlignment(alignment);