Conditional Format Rule Members in SuiteScript

The ConditionalFormatRule object in SuiteScript offers a way to manage conditional formatting within a workbook. This enables developers to define specific formatting rules for spreadsheet data, ensuring better data representation and visibility.

What Are ConditionalFormatRule Object Members?

The ConditionalFormatRule object contains essential properties that define how data is formatted based on specific conditions. Here are its primary members:

Creating a Conditional Format Rule

Developers can utilize the workbook.createConditionalFormatRule(options) method to create an instance of this object. It is often used as a parameter in the workbook.createConditionalFormat(options) method.

Supported Script Types

This object is compatible with server scripts, allowing for broader application in SuiteScript functionalities.

Error Handling

When dealing with the ConditionalFormatRule members, you may encounter the following error code:

• WRONG_PARAMETER_TYPE: This error is thrown if the value specified for the filter property is not a valid workbook.TableColumnFilter object.

Additional Resources

For further information, refer to the N/workbook Module documentation and familiarize yourself with the SuiteScript 2.x Script Types.

Key Takeaways

• The ConditionalFormatRule object is crucial for implementing dynamic formatting in workbooks.
• It includes properties like filter and style that define formatting conditions.
• The object is intended for use in server scripts, enhancing automation and data presentations.
• Understanding error codes like WRONG_PARAMETER_TYPE helps in troubleshooting.