Estilo: com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 9 min. de leitura

    • Cria um estilo para definir propriedades como tamanho da fonte, borda e alinhamento. Você pode aplicar o mesmo estilo a vários objetos simultaneamente.

    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.

    Você pode aplicar estilos personalizados aos seguintes elementos de API:

    Estilo - Estilo ()

    Instancia um novo objeto de estilo.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum

    Os exemplos a seguir mostram como criar um objeto de estilo que você pode adicionar a um elemento de célula, parágrafo ou tabela.

    var style = new sn_pdfgeneratorutils.Style();

    Estilo – setBackgroundColor(Color color)

    Especifica a cor de fundo de um elemento.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    cor Cor Cor de fundo.
    Tabela 3. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir a cor de fundo do elemento. Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setBold()

    Define um estilo como fonte em negrito.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 5. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir um estilo como fonte em negrito.

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

    Estilo – setBorder(largura do número)

    Define a borda do estilo nos quatro lados de um elemento.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    Tabela 7. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorder(width);

    Estilo – setBorderBottom (largura do número)

    Define a borda do estilo como a parte inferior de um elemento.

    Tabela 8. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    Tabela 9. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo na parte inferior de um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderBottom(width);

    Estilo – setBorderLeft(Largura do número)

    Define a borda de estilo no lado esquerdo de um elemento.

    Tabela 10. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    Tabela 11. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo no lado esquerdo de um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderLeft(width);

    Estilo – setBorderRight(largura do número)

    Define a borda de estilo no lado direito de um elemento.

    Tabela 12. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    Tabela 13. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo no lado direito de um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderRight(width);

    Estilo – setBorderTop(largura do número)

    Define a borda do estilo como a parte superior de um elemento.

    Tabela 14. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    Tabela 15. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo na parte superior de um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderTop(width);

    Estilo – setColoredBorder(largura do número, cor da cor)

    Define a borda de estilo com cor nos quatro lados de um elemento.

    Tabela 16. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    cor Cor Cor da borda do estilo.
    Tabela 17. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo com cor. Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setColoredBorderBottom(largura do número, cor da cor)

    Define a borda de estilo com cor na parte inferior de um elemento.

    Tabela 18. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    cor Cor Cor da borda do estilo.
    Tabela 19. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo na parte inferior de um elemento.Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setColoredBorderLeft(largura do número, cor da cor)

    Define a borda de estilo com cor no lado esquerdo de um elemento.

    Tabela 20. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    cor Cor Cor da borda do estilo.
    Tabela 21. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo. Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setColoredBorderRight(largura do número, cor da cor)

    Define a borda de estilo com cor no lado direito de um elemento.

    Tabela 22. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    cor Cor Cor da borda do estilo.
    Tabela 23. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo com cor. Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setColoredBorderTop(largura do número, cor da cor)

    Define a borda de estilo com cor para o lado superior de um elemento.

    Tabela 24. Parâmetros
    Nome Tipo Descrição
    largura Número Largura da borda do estilo em pontos.
    cor Cor Cor da borda do estilo.
    Tabela 25. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma borda de estilo. Para obter um exemplo de uso de documento, consulte Document API.

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

    Estilo – setFontColor(Color color)

    Define uma cor de fonte.

    Tabela 26. Parâmetros
    Nome Tipo Descrição
    cor Cor Cor da fonte.
    Tabela 27. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir uma cor de fonte. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

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

style.setFontColor(fontColor);

    Estilo – setFontSize(Number fontSize)

    Define um tamanho de fonte de estilo.

    Tabela 28. Parâmetros
    Nome Tipo Descrição
    tamanho da fonte Número Tamanho da fonte em pontos.
    Tabela 29. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir um tamanho de fonte.

    var style = new sn_pdfgeneratorutils.Style();

style.setFontSize(12);

    Estilo – setHorizontalAlignment(cadeia de caracteres "alinhamento")

    Define o alinhamento horizontal de um estilo.

    Tabela 30. Parâmetros
    Nome Tipo Descrição
    alinhamento Cadeia de caracteres Configuração de alinhamento horizontal.
    Valores válidos:
    • center: alinha o conteúdo ao centro.
    • à esquerda: alinha o conteúdo à esquerda.
    • direita: alinha o conteúdo à direita.
    Tabela 31. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o alinhamento horizontal em um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var alignment = "Center";

style.setHorizontalAlignment(alignment);

    Estilo – setItalic()

    Define um estilo como fonte em itálico.

    Tabela 32. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 33. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir um estilo de elemento como uma fonte em itálico.

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

    Estilo – setPadding(Number padding)

    Define o preenchimento dos quatro lados de um elemento para a mesma largura.

    Consulte também:
    Tabela 34. Parâmetros
    Nome Tipo Descrição
    preenchimento Número Largura do preenchimento em pontos como um valor decimal.
    Tabela 35. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o estilo inferior como 2,5 pontos. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPadding(padding);

    Estilo – setPaddingBottom(Number padding)

    Define o valor da largura do preenchimento inferior de um elemento.

    Consulte também:
    Tabela 36. Parâmetros
    Nome Tipo Descrição
    preenchimento Número Largura do preenchimento em pontos como um valor decimal.
    Tabela 37. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o preenchimento do elemento inferior como 2,5 pontos. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingBottom(padding);

    Estilo – setPaddingLeft(Number padding)

    Define o valor da largura do preenchimento esquerdo de um elemento.

    Consulte também:
    Tabela 38. Parâmetros
    Nome Tipo Descrição
    preenchimento Número Largura do preenchimento em pontos como um valor decimal.
    Tabela 39. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o preenchimento do elemento esquerdo como 2,5 pontos. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingLeft(padding);

    Estilo – setPaddingRight(Number padding)

    Define o valor da largura do preenchimento direito de um estilo.

    Consulte também:
    Tabela 40. Parâmetros
    Nome Tipo Descrição
    preenchimento Número Largura do preenchimento em pontos como um valor decimal.
    Tabela 41. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o preenchimento do elemento direito como 2,5 pontos. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingRight(padding);

    Estilo – setPaddingTop(Number padding)

    Define o valor da largura do preenchimento superior de um elemento.

    Consulte também:
    Tabela 42. Parâmetros
    Nome Tipo Descrição
    preenchimento Número Largura do preenchimento em pontos como um valor decimal.
    Tabela 43. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o preenchimento do elemento superior como 2,5 pontos. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingTop(padding);

    Estilo – setTextAlignment(cadeia de caracteres "alinhamento")

    Define o alinhamento do texto para um estilo.

    Tabela 44. 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 45. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o texto do elemento para o alinhamento central.

    var style = new sn_pdfgeneratorutils.Style();

String alignment = "text-center";

style.setTextAlignment(alignment);

    Estilo – setVerticalAlignment(cadeia de caracteres "alignment")

    Define o alinhamento vertical deste elemento.

    Tabela 46. Parâmetros
    Nome Tipo Descrição
    alinhamento Cadeia de caracteres Configuração de alinhamento vertical.
    Valores válidos:
    • inferior: alinha o conteúdo na parte inferior.
    • mid: alinha o conteúdo ao centro.
    • top: alinha o conteúdo na parte superior.
    Tabela 47. Retorna
    Tipo Descrição
    Nenhum

    O exemplo a seguir mostra como definir o alinhamento vertical em um elemento. Para obter um exemplo de uso de documento, consulte Document API.

    var style = new sn_pdfgeneratorutils.Style();

var alignment = "Mid";

style.setVerticalAlignment(alignment);