Style - Scoped, Global

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 8 minutes de lecture

    • Creates a style for defining properties such font size, border, and alignment. You can apply the same style to multiple objects simultaneously.

    This API is part of the ServiceNow PDF Generation Utilities plugin (com.snc.apppdfgenerator) and is provided within the sn_pdfgeneratorutils namespace. The plugin is activated by default.

    This API is a component used with the Document API to generate a PDF.

    You can apply custom styles to the following API elements:

    Style - Style()

    Instantiates a new Style object.

    Tableau 1. Parameters
    Name Type Description
    None

    The following examples shows how to create a Style object that you can add to a Cell, Paragraph or Table element.

    var style = new sn_pdfgeneratorutils.Style();

    Style – setBackgroundColor(Color color)

    Specifies a background color of an element.

    Tableau 2. Parameters
    Name Type Description
    color Color Background color.
    Tableau 3. Returns
    Type Description
    None

    The following example shows how to set element background color. For a document usage example, see 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);

    Style – setBold()

    Sets a style to bold font.

    Tableau 4. Parameters
    Name Type Description
    None
    Tableau 5. Returns
    Type Description
    None

    The following example shows how to set a style to bold font.

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

    Style – setBorder(Number width)

    Sets the style border on all four sides of an element.

    Tableau 6. Parameters
    Name Type Description
    width Number Style border width in points.
    Tableau 7. Returns
    Type Description
    None

    The following example shows how to set a style border. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorder(width);

    Style – setBorderBottom(Number width)

    Sets the style border to the bottom of an element.

    Tableau 8. Parameters
    Name Type Description
    width Number Style border width in points.
    Tableau 9. Returns
    Type Description
    None

    The following example shows how to set a style border to the bottom of an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderBottom(width);

    Style – setBorderLeft(Number width)

    Sets the style border on the left side of an element.

    Tableau 10. Parameters
    Name Type Description
    width Number Style border width in points.
    Tableau 11. Returns
    Type Description
    None

    The following example shows how to set a style border on the left side of an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderLeft(width);

    Style – setBorderRight(Number width)

    Sets the style border on the right side of an element.

    Tableau 12. Parameters
    Name Type Description
    width Number Style border width in points.
    Tableau 13. Returns
    Type Description
    None

    The following example shows how to set a style border on the right side of an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderRight(width);

    Style – setBorderTop(Number width)

    Sets the style border to the top of an element.

    Tableau 14. Parameters
    Name Type Description
    width Number Style border width in points.
    Tableau 15. Returns
    Type Description
    None

    The following example shows how to set a style border to the top of an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var width = 2;

style.setBorderTop(width);

    Style – setColoredBorder(Number width, Color color)

    Sets style border with color on all four sides of an element.

    Tableau 16. Parameters
    Name Type Description
    width Number Style border width in points.
    color Color Style border color.
    Tableau 17. Returns
    Type Description
    None

    The following example shows how to set a style border with color. For a document usage example, see 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);

    Style – setColoredBorderBottom(Number width, Color color)

    Sets style border with color to the bottom side of an element.

    Tableau 18. Parameters
    Name Type Description
    width Number Style border width in points.
    color Color Style border color.
    Tableau 19. Returns
    Type Description
    None

    The following example shows how to set a style border to the bottom of an element.For a document usage example, see 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);

    Style – setColoredBorderLeft(Number width, Color color)

    Sets style border with color on the left side of an element.

    Tableau 20. Parameters
    Name Type Description
    width Number Style border width in points.
    color Color Style border color.
    Tableau 21. Returns
    Type Description
    None

    The following example shows how to set a style border. For a document usage example, see 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);

    Style – setColoredBorderRight(Number width, Color color)

    Sets style border with color on the right side of an element.

    Tableau 22. Parameters
    Name Type Description
    width Number Style border width in points.
    color Color Style border color.
    Tableau 23. Returns
    Type Description
    None

    The following example shows how to set a style border with color. For a document usage example, see 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);

    Style – setColoredBorderTop(Number width, Color color)

    Sets style border with color to the top side of an element.

    Tableau 24. Parameters
    Name Type Description
    width Number Style border width in points.
    color Color Style border color.
    Tableau 25. Returns
    Type Description
    None

    The following example shows how to set a style border. For a document usage example, see 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);

    Style – setFontColor(Color color)

    Sets a font color.

    Tableau 26. Parameters
    Name Type Description
    color Color Font color.
    Tableau 27. Returns
    Type Description
    None

    The following example shows how to set a font color. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

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

style.setFontColor(fontColor);

    Style – setFontSize(Number fontSize)

    Sets a style font size.

    Tableau 28. Parameters
    Name Type Description
    fontSize Number Font size in points.
    Tableau 29. Returns
    Type Description
    None

    The following example shows how to set a font size.

    var style = new sn_pdfgeneratorutils.Style();

style.setFontSize(12);

    Style – setHorizontalAlignment(String alignment)

    Sets the horizontal alignment for a style.

    Tableau 30. Parameters
    Name Type Description
    alignment String Horizontal alignment setting.
    Valid values:
    • center: Align contents to the center.
    • left: Align contents to the left.
    • right: Align contents to the right.
    Tableau 31. Returns
    Type Description
    None

    The following example shows how to set horizontal alignment on an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var alignment = "Center";

style.setHorizontalAlignment(alignment);

    Style – setItalic()

    Sets a style to italic font.

    Tableau 32. Parameters
    Name Type Description
    None
    Tableau 33. Returns
    Type Description
    None

    The following example shows how to set an element style to an italic font.

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

    Style – setPadding(Number padding)

    Sets the padding of all four sides of an element to the same width.

    See also:
    Tableau 34. Parameters
    Name Type Description
    padding Number Padding width in points as a decimal value.
    Tableau 35. Returns
    Type Description
    None

    The following example shows how to set bottom style to 2.5 points. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPadding(padding);

    Style – setPaddingBottom(Number padding)

    Sets the value of the bottom padding width of an element.

    See also:
    Tableau 36. Parameters
    Name Type Description
    padding Number Padding width in points as a decimal value.
    Tableau 37. Returns
    Type Description
    None

    The following example shows how to set bottom element padding to 2.5 points. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingBottom(padding);

    Style – setPaddingLeft(Number padding)

    Sets the value of the left padding width of an element.

    See also:
    Tableau 38. Parameters
    Name Type Description
    padding Number Padding width in points as a decimal value.
    Tableau 39. Returns
    Type Description
    None

    The following example shows how to set left element padding to 2.5 points. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingLeft(padding);

    Style – setPaddingRight(Number padding)

    Sets the value of the right padding width of a style.

    See also:
    Tableau 40. Parameters
    Name Type Description
    padding Number Padding width in points as a decimal value.
    Tableau 41. Returns
    Type Description
    None

    The following example shows how to set right element padding to 2.5 points. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingRight(padding);

    Style – setPaddingTop(Number padding)

    Sets the value of the top padding width of an element.

    See also:
    Tableau 42. Parameters
    Name Type Description
    padding Number Padding width in points as a decimal value.
    Tableau 43. Returns
    Type Description
    None

    The following example shows how to set top element padding to 2.5 points. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var padding = 2.5;

style.setPaddingTop(padding);

    Style – setTextAlignment(String alignment)

    Sets the text alignment for a style.

    Tableau 44. Parameters
    Name Type Description
    alignment String Text alignment position.
    Valid values:
    • text-center: Aligns text to the center.
    • text-justified: Modifies the space between characters to completely fill text between the left and right sides. The final line is left-aligned.
    • text-justified-all: Justifies text alignment including the final line.
    • text-left: Align text to the left.
    • text-right: Align text to the right.
    Tableau 45. Returns
    Type Description
    None

    The following example shows how to set the element text to center alignment.

    var style = new sn_pdfgeneratorutils.Style();

String alignment = "text-center";

style.setTextAlignment(alignment);

    Style – setVerticalAlignment(String alignment)

    Sets the vertical alignment for this element.

    Tableau 46. Parameters
    Name Type Description
    alignment String Vertical alignment setting.
    Valid values:
    • bottom: Aligns contents to the bottom.
    • mid: Aligns contents to the center.
    • top: Aligns contents to the top.
    Tableau 47. Returns
    Type Description
    None

    The following example shows how to set vertical alignment on an element. For a document usage example, see Document API.

    var style = new sn_pdfgeneratorutils.Style();

var alignment = "Mid";

style.setVerticalAlignment(alignment);