Parágrafo - Com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 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 Utilitários de geração de PDF (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 documentos para gerar um PDF.

    Parágrafo - parágrafo (cadeia de caracteres texto)

    Instancia um novo objeto de parágrafo que contém uma cadeia de caracteres.

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

    O exemplo a seguir mostra como criar um objeto de parágrafo. Para obter um exemplo de uso de documento, consulte Document API.

    var para = new Paragraph("hello");

    Parágrafo – addNewLine()

    Adiciona uma linha vazia após um parágrafo em um documento.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 3. Retorna
    Tipo Descrição
    Nenhum

    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 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 do parágrafo)

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

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    parágrafo Parágrafo Objeto de parágrafo.
    Tabela 5. Retorna
    Tipo Descrição
    Nenhum

    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 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(cadeia de caracteres "content")

    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.

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

    O exemplo a seguir mostra como adicionar uma nova frase a um parágrafo. Para obter um exemplo de uso de documento, consulte Document 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)

    Aplica um estilo predefinido ao texto do parágrafo.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    estilo Estilo Estilo a ser aplicado a este elemento.
    Tabela 9. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como aplicar um estilo a um parágrafo. Para obter um exemplo de uso de documento, consulte Document 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, Parte inferior do número, Largura do número)

    Define um elemento de parágrafo para uma posição fixa na página.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    esquerda Número Recuo do lado esquerdo da página do PDF em pontos.
    parte inferior Número Posição 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 quebra.
    Tabela 11. Retorna
    Tipo Descrição
    Nenhum

    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 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(Número de margem)

    Define cada margem de parágrafo.

    Para definir todas as quatro margens com um ou mais valores exclusivos, use setMargins().

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    margem Número Valor das margens superior, direita, inferior e esquerda em pontos.
    Tabela 13. Retorna
    Tipo Descrição
    Nenhum

    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(Número de margem)

    Define a margem inferior de um parágrafo.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    margem Número Altura da margem inferior em pontos.
    Tabela 15. Retorna
    Tipo Descrição
    Nenhum

    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(Número de margem)

    Define a margem esquerda de um parágrafo.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    leftMargin Número Largura da margem esquerda em pontos.
    Tabela 17. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir a margem esquerda de um parágrafo para 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(Número de margem)

    Define a margem direita de um parágrafo.

    Tabela 18. Parâmetros
    Nome Tipo Descrição
    margem Número Largura da margem direita em pontos.
    Tabela 19. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir a margem direita de um parágrafo para 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(Number MargemTop, Número MargemDireita, Número MargemInferior, Número MargemEsquerda)

    Define um tamanho para cada margem de parágrafo.

    Para definir cada margem com o mesmo valor, use setMargin().

    Tabela 20. Parâmetros
    Nome Tipo Descrição
    topMargin Número Altura da margem superior em pontos.
    direitaMargem Número Largura da margem direita em pontos.
    BottomMargin Número Altura da margem inferior em pontos.
    leftMargin Número Largura da margem esquerda em pontos.
    Tabela 21. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir margens de parágrafo.Para obter um exemplo de uso de documento, consulte Document 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(Número de margem)

    Define a margem superior de um parágrafo.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    margem Número Altura da margem superior em pontos.
    Tabela 23. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir a margem superior de um parágrafo para 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")

    Define o alinhamento do texto deste parágrafo.

    Tabela 24. Parâmetros
    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-direita: alinha o texto à direita.
    Tabela 25. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o texto do parágrafo para alinhamento à esquerda.

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