Style - Scoped, Global

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:

• Cell
• Paragraph
• Table

Parent Topic:Server API reference

Style - Style()

Instantiates a new Style object.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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:

• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

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:

• setPadding()
• setPaddingLeft()
• setPaddingRight()
• setPaddingTop()

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:

• setPadding()
• setPaddingBottom()
• setPaddingRight()
• setPaddingTop()

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:

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingTop()

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:

• setPadding()
• setPaddingBottom()
• setPaddingLeft()
• setPaddingRight()

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.

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.

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