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


---

# Documento - com escopo, global

# Documento - 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) 10 min. de leitura

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.

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 depende de um pacote de classes para criar vários elementos que compõem um PDF.

* [Célula](https://servicenow-prod.fluidtopics.net/KSht1b2wJB1J44IMkFRMSA#CellBothAPI "Cria um objeto de célula como uma célula em uma tabela. Você pode usar esta API para formatar a célula e incluir blocos adicionais, como parágrafos e imagens.") -- Cria um objeto de célula como uma célula em uma tabela. Você pode usar esta API para formatar a célula e incluir blocos adicionais, como parágrafos e imagens.
* [Cor](https://servicenow-prod.fluidtopics.net/3HDiHdJmpVjIjUYOrdT0Mg#ColorBothAPI "Cria um objeto Cor usado para definir atributos de cor que você pode aplicar a elementos em um PDF; como células, tabelas e linhas.") -- Cria um objeto Cor usado para definir atributos de cor que você pode aplicar a elementos em um PDF; como células, tabelas e linhas.
* [Imagem](https://servicenow-prod.fluidtopics.net/tBijnhDQ~V_~auzllEpR_A#ImageBothAPI "Cria um objeto de imagem que representa uma imagem e sua inserção de layout em um PDF. Habilita a definição de atributos como escala, alinhamento e cor da borda.") -- Cria um objeto de imagem que representa uma imagem e sua inserção de layout em um PDF. Habilita a definição de atributos como escala, alinhamento e cor da borda.
* [Linha](https://servicenow-prod.fluidtopics.net/M1L4AAqJD3799u7mlNs_~A#LineBothAPI "Cria um objeto de linha usando métodos para desenhar uma linha em um PDF.") -- Cria um objeto de linha usando métodos para desenhar uma linha em um PDF.
* [Parágrafo](https://servicenow-prod.fluidtopics.net/sx2rcQUBNKTJuwZLeuyJfw#ParagraphBothAPI "Cria um objeto de parágrafo que representa um bloco de texto em um PDF.") -- Cria um objeto de parágrafo que representa um bloco de texto em um PDF.
* [PdfPage](https://servicenow-prod.fluidtopics.net/2zL2NRTzyssdeLY8Z33Lbw#PdfPageBothAPI "Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor.") -- Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor.
* [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.") -- Cria um estilo para definir propriedades como tamanho da fonte, borda e alinhamento. Você pode aplicar o mesmo estilo a vários objetos simultaneamente.
* [Tabela](https://servicenow-prod.fluidtopics.net/TRzRswGVxJ_rNB0u20U9rg#TableBothAPI "Cria um objeto de tabela para adicionar a um documento PDF. Define os dados a serem usados em cada célula e define estilos, margens e alinhamento.") -- Cria um objeto de tabela para adicionar a um documento PDF. Define os dados a serem usados em cada célula e define estilos, margens e alinhamento.
{#DocumentBothAPI__ul_cc4_bt1_t4b}  
O exemplo a seguir mostra como criar um PDF básico usando a API Document e vários componentes, como tabela, célula e parágrafo. O resultado é uma lista de incidentes da tabela Incidente \[incident\] listada em um PDF. Você pode testar este exemplo em sua instância se substituir\<sys_id\> com o sys_id de um registro de incidente.

    var pageSize = new sn_pdfgeneratorutils.PdfPage("A4");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);
     
    var whiteColor =  sn_pdfgeneratorutils.Color([1,1,1]);
    var greyColor =  sn_pdfgeneratorutils.Color([0.8,0.8,0.8]);
    var headerBgColor = new sn_pdfgeneratorutils.Color([0.4,0.6,0.8]);
     
    // Query the Incident table
    var gr = new GlideRecord("incident");
    gr.query();
     
    // declare table by providing width array and Boolean for large table
    var table = new sn_pdfgeneratorutils.Table(true, [70,200], false);
     
    var headerStyle = new sn_pdfgeneratorutils.Style;
    headerStyle.setBackgroundColor(headerBgColor);
    headerStyle.setTextAlignment("text-center");
    headerStyle.setBold();
    headerStyle.setFontColor(whiteColor);
     
    table.setHeaderStyle(headerStyle);
     
    var nParagraph = new sn_pdfgeneratorutils.Paragraph("Number");
    var sParagraph = new sn_pdfgeneratorutils.Paragraph("Short Description");
     
    var hdrCell1 = new sn_pdfgeneratorutils.Cell;
    var hdrCell2 = new sn_pdfgeneratorutils.Cell;
     
    hdrCell1.addParagraph(nParagraph);
    hdrCell2.addParagraph(sParagraph);
     
    table.addHeaderCell(hdrCell1);
    table.addHeaderCell(hdrCell2);
     
    var row = 0;
     
    while(gr.next()) {
    var numCell = new sn_pdfgeneratorutils.Cell;
    var sdCell = new sn_pdfgeneratorutils.Cell;
     
    var numberParagraph = new sn_pdfgeneratorutils.Paragraph(gr.number);
    var sdParagraph = new sn_pdfgeneratorutils.Paragraph(gr.short_description);
     
    numCell.addParagraph(numberParagraph);
    sdCell.addParagraph(sdParagraph);
     
    if (row % 2 == 1) {
         table.setDefaultbackGroundColor(greyColor);
    } else {
         table.setDefaultbackGroundColor(whiteColor);
    }
     
    table.addCell(numCell);
    table.addCell(sdCell);
     
    row = row + 1;
    }
     
    document.addTable(table);
    document.saveAsAttachment("incident", "<sys_id>", "SampleGenerationTest.pdf");

O anexo em PDF é listado na tabela Anexos \[sys_attachment\].

## Document - Document(PdfPage pageSize) {#ariaid-title2}

Instancia um objeto Document e gera um documento PDF.
{#Document-Document_O__table_twm_hjk_34b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| pageSize | [PdfPage](https://servicenow-prod.fluidtopics.net/2zL2NRTzyssdeLY8Z33Lbw#PdfPageBothAPI "Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor.") | Tamanho da página do PDF. |
[Tabela 1. Parâmetros]

{#Document-Document_O__table_twm_hjk_34b} {#Document-Document_O__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Documento PDF. |
[Tabela 2. Retorna]

{#Document-Document_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como criar um objeto Document e retornar um PDF.

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

## Documento -- addAndStartNewPage() {#ariaid-title3}

adiciona uma página ao documento encerrando a página atual e criando uma nova.
Métodos adicionais para adicionar uma nova página em um documento:

* [addNewPage()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addNewPage "adiciona uma nova página em branco ao documento. Use para forçar uma quebra de página para iniciar um novo capítulo ou seção no documento.") -- adiciona uma nova página em branco ao documento. Use para forçar uma quebra de página para iniciar um novo capítulo ou seção no documento.{#Document-addAndStartNewPage__document-addNewPage-sdesc}
* [addNewPageAtIndex()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addNewPageAtIndex_N "Adiciona uma nova página no índice especificado do documento. Por exemplo, definir o índice como 6 insere uma página seis ou insere a página na posição da página seis existente em um documento. A página seis original se torna a página sete.") -- Adiciona uma nova página no índice especificado do documento. Por exemplo, definir o índice como 6 insere uma página seis ou insere a página na posição da página seis existente em um documento. A página seis original se torna a página sete.{#Document-addAndStartNewPage__document-addNewPageAtIndex-sdesc}
{#Document-addAndStartNewPage__ul_bxw_z4f_t4b}
{#Document-addAndStartNewPage__table_vv5_52h_44b__entry__3}

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

{#Document-addAndStartNewPage__table_vv5_52h_44b} {#Document-addAndStartNewPage__table_wv5_52h_44b__entry__2}

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

{#Document-addAndStartNewPage__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova página 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 para1 = new sn_pdfgeneratorutils.Paragraph("This text lands on the first page.");
    var para2 = new sn_pdfgeneratorutils.Paragraph("This text lands on the new page.");

    document.addParagraph(para1);

    document.addAndStartNewPage();

    document.addParagraph(para2);

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

## Documento -- addAuthor(cadeia de caracteres autor) {#ariaid-title4}

Adiciona um nome ao campo do autor nas propriedades do documento PDF.
{#Document-addAuthor_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| autor | Cadeia de caracteres | Nome do autor do documento. |
[Tabela 5. Parâmetros]

{#Document-addAuthor_S__table_vv5_52h_44b} {#Document-addAuthor_S__table_wv5_52h_44b__entry__2}

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

{#Document-addAuthor_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar um nome ao campo do autor nas propriedades do documento PDF. 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 author = "John Do";

    document.addAuthor(author);

## Document -- addImage (imagem imagem) {#ariaid-title5}

Adiciona uma imagem a um documento.
{#Document-addImage_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| imagem | [Imagem](https://servicenow-prod.fluidtopics.net/tBijnhDQ~V_~auzllEpR_A#ImageBothAPI "Cria um objeto de imagem que representa uma imagem e sua inserção de layout em um PDF. Habilita a definição de atributos como escala, alinhamento e cor da borda.") | Imagem a ser adicionada a um documento. |
[Tabela 7. Parâmetros]

{#Document-addImage_O__table_vv5_52h_44b} {#Document-addImage_O__table_wv5_52h_44b__entry__2}

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

{#Document-addImage_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma imagem 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);
     
    // declare image using sys attachment
    var image = new sn_pdfgeneratorutils.Image("<imgAttachment_sys_id>");

    // add the image to the doc
    document.addImage(image);

    document.saveAsAttachment("incident", "<record_sys_id>", "docWithImage.pdf");

## Documento -- addNewLine() {#ariaid-title6}

Adiciona uma nova linha vazia ao documento.
{#Document-addNewLine__table_vv5_52h_44b__entry__3}

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

{#Document-addNewLine__table_vv5_52h_44b} {#Document-addNewLine__table_wv5_52h_44b__entry__2}

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

{#Document-addNewLine__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova linha 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("A4");

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

    document.addNewLine();

## Documento -- addNewPage() {#ariaid-title7}

adiciona uma nova página em branco ao documento. Use para forçar uma quebra de página para iniciar um novo capítulo ou seção no documento.
Métodos adicionais para adicionar uma nova página em um documento:

* [addAndStartNewPage()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addAndStartNewPage "adiciona uma página ao documento encerrando a página atual e criando uma nova."): adiciona uma página ao documento encerrando a página atual e criando uma nova.{#Document-addNewPage__document-addAndStartNewPage-sdesc}
* [addNewPageAtIndex()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addNewPageAtIndex_N "Adiciona uma nova página no índice especificado do documento. Por exemplo, definir o índice como 6 insere uma página seis ou insere a página na posição da página seis existente em um documento. A página seis original se torna a página sete.") -- Adiciona uma nova página no índice especificado do documento. Por exemplo, definir o índice como 6 insere uma página seis ou insere a página na posição da página seis existente em um documento. A página seis original se torna a página sete.{#Document-addNewPage__document-addNewPageAtIndex-sdesc}
{#Document-addNewPage__ul_bxw_z4f_t4b}
{#Document-addNewPage__table_vv5_52h_44b__entry__3}

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

{#Document-addNewPage__table_vv5_52h_44b} {#Document-addNewPage__table_wv5_52h_44b__entry__2}

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

{#Document-addNewPage__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova página em branco 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.

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

    document.addNewPage();

## Documento -- addNewPageAtIndex(Number index) {#ariaid-title8}

Adiciona uma nova página no índice especificado do documento. Por exemplo, definir o índice como 6 insere uma página seis ou insere a página na posição da página seis existente em um documento. A página seis original se torna a página sete.
Métodos adicionais para adicionar uma nova página em um documento:

* [addAndStartNewPage()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addAndStartNewPage "adiciona uma página ao documento encerrando a página atual e criando uma nova."): adiciona uma página ao documento encerrando a página atual e criando uma nova.{#Document-addNewPageAtIndex_N__document-addAndStartNewPage-sdesc}
* [addNewPage()](https://servicenow-prod.fluidtopics.net/GfzkXxoz~DU2Zt1bfpGPXA#Document-addNewPage "adiciona uma nova página em branco ao documento. Use para forçar uma quebra de página para iniciar um novo capítulo ou seção no documento.") -- adiciona uma nova página em branco ao documento. Use para forçar uma quebra de página para iniciar um novo capítulo ou seção no documento.{#Document-addNewPageAtIndex_N__document-addNewPage-sdesc}
{#Document-addNewPageAtIndex_N__ul_bxw_z4f_t4b}
{#Document-addNewPageAtIndex_N__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| índice | Número | Posição na qual inserir uma nova página. |
[Tabela 13. Parâmetros]

{#Document-addNewPageAtIndex_N__table_vv5_52h_44b} {#Document-addNewPageAtIndex_N__table_wv5_52h_44b__entry__2}

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

{#Document-addNewPageAtIndex_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma nova página PDF à posição 6 de 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 index = 6;

    document.addNewPageAtIndex(index);

## Documento -- addParagraph(parágrafo) {#ariaid-title9}

Adiciona um parágrafo a um documento.
{#Document-addParagraph_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| parágrafo | [Parágrafo](https://servicenow-prod.fluidtopics.net/sx2rcQUBNKTJuwZLeuyJfw#ParagraphBothAPI "Cria um objeto de parágrafo que representa um bloco de texto em um PDF.") | Bloco de texto fornecido como um objeto de parágrafo. |
[Tabela 15. Parâmetros]

{#Document-addParagraph_O__table_vv5_52h_44b} {#Document-addParagraph_O__table_wv5_52h_44b__entry__2}

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

{#Document-addParagraph_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar um parágrafo 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("A4");
    var document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    var para = "Lorem ipsum dolor sit amet.";

    document.addParagraph(para);

## Documento -- addTable(Tabela tabela) {#ariaid-title10}

Adiciona uma tabela a um documento.
{#Document-addTable_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| tabela | [Tabela](https://servicenow-prod.fluidtopics.net/TRzRswGVxJ_rNB0u20U9rg#TableBothAPI "Cria um objeto de tabela para adicionar a um documento PDF. Define os dados a serem usados em cada célula e define estilos, margens e alinhamento.") | Tabela a ser inserida no documento. |
[Tabela 17. Parâmetros]

{#Document-addTable_O__table_vv5_52h_44b} {#Document-addTable_O__table_wv5_52h_44b__entry__2}

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

{#Document-addTable_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como adicionar uma tabela a um documento. Consulte a [API de tabela](https://servicenow-prod.fluidtopics.net/TRzRswGVxJ_rNB0u20U9rg#TableBothAPI "Cria um objeto de tabela para adicionar a um documento PDF. Define os dados a serem usados em cada célula e define estilos, margens e alinhamento.") para obter mais detalhes sobre como definir uma tabela. 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 table = new sn_pdfgeneratorutils.Table([70,200], false);

    document.addTable(table);

## Documento -- fechar () {#ariaid-title11}

Encerra um documento.
{#Document-close__table_vv5_52h_44b__entry__3}

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

{#Document-close__table_vv5_52h_44b} {#Document-close__table_wv5_52h_44b__entry__2}

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

{#Document-close__table_wv5_52h_44b}  
O exemplo a seguir mostra como fechar 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);

    document.close();

## Documento -- createDocument(PdfPage pageSize) {#ariaid-title12}

Cria um documento com o tamanho de página especificado.
{#Document-createDocument_O__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| pageSize | [PdfPage](https://servicenow-prod.fluidtopics.net/2zL2NRTzyssdeLY8Z33Lbw#PdfPageBothAPI "Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor.") | Tamanho da página do documento. |
[Tabela 21. Parâmetros]

{#Document-createDocument_O__table_vv5_52h_44b} {#Document-createDocument_O__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Objeto | Documento PDF. |
[Tabela 22. Retorna]

{#Document-createDocument_O__table_wv5_52h_44b}  
O exemplo a seguir mostra como criar 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);

## Documento -- getPageCount() {#ariaid-title13}

Obtém o número de páginas no documento.
{#Document-getPageCount__table_vv5_52h_44b__entry__3}

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

{#Document-getPageCount__table_vv5_52h_44b} {#Document-getPageCount__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Número | Número de páginas no documento. |
[Tabela 24. Retorna]

{#Document-getPageCount__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter a contagem de páginas de um documento de nove páginas. 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 count = document.getPageCount();

    gs.info("The number of pages is " + count);

Saída:

    The number of pages is 9

## Documento -- getPageSize() {#ariaid-title14}

Obtém o tamanho de página padrão do documento.
{#Document-getPageSize__table_vv5_52h_44b__entry__3}

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

{#Document-getPageSize__table_vv5_52h_44b} {#Document-getPageSize__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Valor do tamanho de página padrão definido usando a API [PdfPage](https://servicenow-prod.fluidtopics.net/2zL2NRTzyssdeLY8Z33Lbw#PdfPageBothAPI "Cria um objeto PdfPage que representa uma página PDF e seus atributos; como tamanho, largura e cor."). Valores possíveis: * A4 -- 595 x 842 pontos * EXECUTIVO -- 522 x 756 pontos * CARTA -- 612 x 792 pontos * Razão: 792 x 1224 pontos {#Document-getPageSize__ul_dml_q2p_k4b} |
[Tabela 26. Retorna]

{#Document-getPageSize__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter o tamanho da página de 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 pagesize = document.getPageSize();

## Documento -- isClosed() {#ariaid-title15}

Indica se um documento está fechado ou aberto.
{#Document-isClosed__table_vv5_52h_44b__entry__3}

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

{#Document-isClosed__table_vv5_52h_44b} {#Document-isClosed__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Nenhum(a) | Sinalizador que indica se um documento está aberto ou fechado. Valores válidos: * verdadeiro: o documento está fechado. * falso: o documento está aberto. {#Document-isClosed__ul_bqw_444_r4b} Padrão: verdadeiro |
[Tabela 28. Retorna]

{#Document-isClosed__table_wv5_52h_44b}  
O exemplo a seguir mostra como obter o tamanho da página de 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 closed = document.isClosed();

## Documento -- saveAsAttachment(cadeia de caracteres "tableName", cadeia de caracteres "tableSysId", cadeia de caracteres "fileName") {#ariaid-title16}

Anexa o arquivo de documento à tabela de destino especificada.
{#Document-saveAsAttachment_S_S_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| tableName | Cadeia de caracteres | Nome da tabela à qual o documento será anexado. |
| tableSysId | Cadeia de caracteres | Sys_id do registro ao qual o documento será anexado. |
| NomeDoArquivo | Cadeia de caracteres | Nome do documento a ser anexado. |
[Tabela 29. Parâmetros]

{#Document-saveAsAttachment_S_S_S__table_vv5_52h_44b} {#Document-saveAsAttachment_S_S_S__table_wv5_52h_44b__entry__2}

| Tipo | Descrição |
|-|-|
| Cadeia de caracteres | Sys_id do documento anexado na tabela Anexos \[sys_attachment\]. |
[Tabela 30. Retorna]

{#Document-saveAsAttachment_S_S_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como anexar um documento a um registro de incidente. 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 document = new sn_pdfgeneratorutils.Document.createDocument(pageSize);

    // Additional document properties

    document.saveAsAttachment("incident", "<record_sys_id>", "SampleDocGeneration.pdf");

## Documento -- setBaseDirection(cadeia de caracteres direção) {#ariaid-title17}

Define a direção do fluxo de texto base para reordenar com base no reconhecimento de caracteres
{#Document-setBaseDirection_S__table_vv5_52h_44b__entry__3}

| Nome | Tipo | Descrição |
|-|-|-|
| direção | Cadeia de caracteres | Direção do fluxo de texto. Valores válidos: * LEFT_TO_Right: fluxo de texto de ordem da esquerda para a direita. A direção do texto só será reordenada se caracteres de idioma da esquerda para a direita forem detectados. * DIREITA_TO_LEFT: fluxo de texto de ordem da direita para a esquerda. A direção do texto só será reordenada se caracteres de idioma da direita para a esquerda forem detectados. {#Document-setBaseDirection_S__ul_ifh_p5q_p4b} Padrão: LEFT_TO_Right |
[Tabela 31. Parâmetros]

{#Document-setBaseDirection_S__table_vv5_52h_44b} {#Document-setBaseDirection_S__table_wv5_52h_44b__entry__2}

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

{#Document-setBaseDirection_S__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir o fluxo de texto da esquerda para a direita. 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);

    document.setBaseDirection("RIGHT_TO_LEFT");

## Documento -- setMargins(Number topMargin, Number rightMargin, Number BottomMargin, Number leftMargin) {#ariaid-title18}

Define os tamanhos das margens da página no documento.
{#Document-setMargins_N_N_N_N__table_vv5_52h_44b__entry__3}{#Document-setMargins_N_N_N_N__docviewer-api-parm-topM-des}{#Document-setMargins_N_N_N_N__docviewer-api-parm-rightM-des}{#Document-setMargins_N_N_N_N__docviewer-api-parm-bottomM-des}{#Document-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 33. Parâmetros]

{#Document-setMargins_N_N_N_N__table_vv5_52h_44b} {#Document-setMargins_N_N_N_N__table_wv5_52h_44b__entry__2}

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

{#Document-setMargins_N_N_N_N__table_wv5_52h_44b}  
O exemplo a seguir mostra como definir as margens da página 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);

    document.setMargins(72,36,36,36);