FontSize Object Members in SuiteScript Reference

The FontSize object provides developers with properties to manage font sizes in workbook scripts effectively. This object enables precise specification of font dimensions, which is essential for creating well-formatted documents and reports.

What is the FontSize Object?

The FontSize object is utilized within the workbook.createStyle(options) method. It allows developers to define font specifications for workbook styles dynamically.

Available Members of the FontSize Object

The members of the FontSize object include:

How to Use the FontSize Object

Developers can create a FontSize object using the following syntax:

var myFontSize = workbook.createFontSize({  // myFontSize is a workbook.FontSize
    size: 12,
    unit: workbook.UNIT.PX
});

This example initializes the font size as 12 pixels, allowing for flexibility in document design. Ensure that the size is a number to avoid the WRONG_PARAMETER_TYPE error.

Additional Code Example

Here’s how to use the FontSize object in conjunction with other style properties:

var mySecondStyle = workbook.createStyle({
    fontSize: workbook.FontSize.LARGE,
    fontStyle: workbook.FontStyle.ITALIC,
    fontWeight: workbook.FontWeight.BOLD
});

Best Practices

Important: Always ensure the numeric values are valid to prevent runtime errors. Also, review the expected units when defining font sizes as dealing with different units can impact document rendering.

Conclusion

By utilizing the FontSize object, users can enhance their workbook styling capabilities effectively, allowing for greater control over how information is presented visually.

Key Takeaways

• The FontSize object allows for customizable font properties in SuiteScript.
• Key members include size and unit, both of which are essential for precise styling.
• Use the workbook.createFontSize() function to create FontSize objects efficiently.