---
sourceDocument: Referência de API do Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - pt-BR

ft:publication_title :

    - Referência de API do Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# Parágrafo - Com escopo, global

# Parágrafo - Com escopo, global {#ariaid-title1}

* Versão de lançamento: Xanadu
* 
* Atualizado 1 de ago. de 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 7 min. de leitura

Cria um objeto de parágrafo que representa um bloco de texto em um PDF.

Esta API faz parte do plug-in ServiceNow PDF Generator Utilities (com.snc.apppdfgenerator) e é fornecida no namespace `sn_pdfgeneratorutils`. O plug-in é ativado por padrão.

Esta API é um componente usado com a [API de documento](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") para gerar um PDF.

## Parágrafo - Parágrafo (cadeia de caracteres de texto) {#ariaid-title2}

Instancia um novo objeto de parágrafo que contém uma cadeia de caracteres.
{#Paragraph-Paragraph_S__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| texto | Cadeia de caracteres | Bloco de parágrafo de texto. |
[Tabela 1. Parâmetros]

{#Paragraph-Paragraph_S__table_twm_hjk_34b}  
O exemplo a seguir mostra como criar um objeto Paragraph. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    var para = new Paragraph("hello");

## Parágrafo -- addNewLine() {#ariaid-title3}

Adiciona uma linha vazia após um parágrafo em um documento.
{#Paragraph-addNewLine__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| Nenhum |   |   |
[Tabela 2. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 3. Retorna]

{#Paragraph-addNewLine__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova linha após um parágrafo em um documento. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    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");

## Parágrafo -- addParagraph(parágrafo) {#ariaid-title4}

Adiciona um parágrafo. Você pode usar este método para criar um bloco de parágrafos com quebras de linha automáticas.
{#Paragraph-addParagraph_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| parágrafo | [Parágrafo](https://servicenow-prod.fluidtopics.net/sx2rcQUBNKTJuwZLeuyJfw#Paragraph-Paragraph_S "Instancia um novo objeto de parágrafo que contém uma cadeia de caracteres.") | Objeto de parágrafo. |
[Tabela 4. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 5. Retorna]

{#Paragraph-addParagraph_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma seção de parágrafos a um documento. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    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");

## Parágrafo -- addString(conteúdo de cadeia de caracteres) {#ariaid-title5}

Adiciona uma cadeia de caracteres de texto a um parágrafo. Este método não insere automaticamente um espaço antes do conteúdo.
{#Paragraph-addString_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| conteúdo | Cadeia de caracteres | Informações a serem incluídas em um parágrafo. |
[Tabela 6. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 7. Retorna]

{#Paragraph-addString_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova frase a um parágrafo. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    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");

## Parágrafo -- addStyle(Estilo de estilo) {#ariaid-title6}

Aplica um estilo predefinido ao texto do parágrafo.
{#Paragraph-addStyle_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| estilo | [Estilo](https://servicenow-prod.fluidtopics.net/fYoYjhIb3GMGTMA1SDmBMA#StyleBothAPI "Cria um estilo para definir propriedades como tamanho da fonte, borda e alinhamento. Você pode aplicar o mesmo estilo a vários objetos simultaneamente.") | Estilo a ser aplicado a este elemento. |
[Tabela 8. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 9. Retorna]

{#Paragraph-addStyle_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como aplicar um estilo a um parágrafo. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    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");

## Parágrafo -- setFixedPosition(Número à esquerda, Número na parte inferior, Número na largura) {#ariaid-title7}

Define um elemento de parágrafo em uma posição fixa na página.
{#Paragraph-setFixedPosition_N_N_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| esquerda | Número | Recuo do lado esquerdo da página do PDF em pontos. |
| parte inferior | Número | Posição a partir da parte inferior da página do PDF em pontos. |
| largura | Número | Largura do elemento de parágrafo em pontos. Este valor determina o comprimento em que a linha é quebrada. |
[Tabela 10. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 11. Retorna]

{#Paragraph-setFixedPosition_N_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir uma posição fixa em uma página. Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

    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");

## Parágrafo -- setMargin(Margem numérica) {#ariaid-title8}

Define cada margem de parágrafo.
Para definir todas as quatro margens com um ou mais valores exclusivos, use [setMargins()](https://servicenow-prod.fluidtopics.net/sx2rcQUBNKTJuwZLeuyJfw#Paragraph-setMargins_N_N_N_N "Define um tamanho para cada margem de parágrafo.").
{#Paragraph-setMargin_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| margem | Número | Valor das margens superior, direita, inferior e esquerda em pontos. |
[Tabela 12. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 13. Retorna]

{#Paragraph-setMargin_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir todas as margens do parágrafo como 48 pontos.

    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");

## Parágrafo -- setMarginBottom(Margem numérica) {#ariaid-title9}

Define a margem inferior de um parágrafo.
{#Paragraph-setMarginBottom_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| margem | Número | Altura da margem inferior em pontos. |
[Tabela 14. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 15. Retorna]

{#Paragraph-setMarginBottom_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir a margem inferior de um parágrafo como um ponto.

    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");

## Parágrafo -- setMarginLeft(Margem numérica) {#ariaid-title10}

Define a margem esquerda de um parágrafo.
{#Paragraph-setMarginLeft_N__table_vv5_52h_44b__entry__3}{#Paragraph-setMarginLeft_N__docviewer-api-parm-leftM-des}

| Nome | Tipo | Descrição |
|-|-|-|
| leftMargin | Número | Largura da margem esquerda em pontos. |
[Tabela 16. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 17. Retorna]

{#Paragraph-setMarginLeft_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir a margem esquerda de um parágrafo como um ponto.

    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");

## Parágrafo -- setMarginRight(Margem numérica) {#ariaid-title11}

Define a margem direita de um parágrafo.
{#Paragraph-setMarginRight_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| margem | Número | Largura da margem direita em pontos. |
[Tabela 18. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 19. Retorna]

{#Paragraph-setMarginRight_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir a margem direita de um parágrafo como um ponto.

    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");

## Parágrafo -- setMargins(Número de margemTop, Número de margemDireita, Número de margemInferior, Número de margemEsquerda) {#ariaid-title12}

Define um tamanho para cada margem de parágrafo.
Para definir cada margem com o mesmo valor, use [setMargin()](https://servicenow-prod.fluidtopics.net/sx2rcQUBNKTJuwZLeuyJfw#Paragraph-setMargin_N "Define cada margem de parágrafo.").
{#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}

| Nome | Tipo | Descrição |
|-|-|-|
| topMargin | Número | Altura da margem superior em pontos. |
| MargemDireita | Número | Largura da margem direita em pontos. |
| Margeminferior | Número | Altura da margem inferior em pontos. |
| leftMargin | Número | Largura da margem esquerda em pontos. |
[Tabela 20. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 21. Retorna]

{#Paragraph-setMargins_N_N_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir margens de parágrafo.Para obter um exemplo de uso de documento, consulte [Document](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#DocumentBothAPI "A API Document fornece métodos para inicializar um PDF, adicionar conteúdo e fechar o PDF. Depois de adicionar conteúdo, o documento pode ser anexado a um registro de destino.") API.

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

## Parágrafo -- setMarginTop(Margem numérica) {#ariaid-title13}

Define a margem superior de um parágrafo.
{#Paragraph-setMarginTop_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| margem | Número | Altura da margem superior em pontos. |
[Tabela 22. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 23. Retorna]

{#Paragraph-setMarginTop_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir a margem superior de um parágrafo como um ponto.

    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");

## Parágrafo -- setTextAlignment(cadeia de caracteres Alinhamento) {#ariaid-title14}

Define o alinhamento do texto deste parágrafo.
{#Paragraph-setTextAlignment_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| alinhamento | Cadeia de caracteres | Posição de alinhamento do texto. Valores válidos: * text-center: alinha o texto ao centro. * text-justified: modifica o espaço entre os caracteres para preencher completamente o texto entre os lados esquerdo e direito. A linha final é alinhada à esquerda. * text-justified-all: justifica o alinhamento do texto, incluindo a linha final. * text-left: alinha o texto à esquerda. * text-right: alinha o texto à direita. {#Paragraph-setTextAlignment_S__ul_sgj_44p_p4b} |
[Tabela 24. Parâmetros]

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

| Tipo | Descrição |
|-|-|
| Nenhum(a) |   |
[Tabela 25. Retorna]

{#Paragraph-setTextAlignment_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir o texto do parágrafo para o alinhamento à esquerda.

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