Range Object Members

The Range Object in SuiteScript allows developers to handle date or date-time ranges effectively. The object comprises two primary members vital for understanding date boundaries in workflows.

What is the Range Object?

The workbook.Range object represents a date or date-time range. The dates are formatted according to user preferences in their account and can be returned after executing a pivot.

What are the Members of the Range Object?

Below are the members available for the workbook.Range object:

Member Descriptions

• Range.end: This property retrieves the end date or time of the specified range. It is returned as a string and adheres to the user's date formatting preferences. Modifying this property after object creation will result in a READ_ONLY_PROPERTY error.

• Range.start: Similar to Range.end, this property provides the start date or time of the range. It is also formatted as a string, reflecting the user's account settings.

Supported Script Types

Both members of the Range object are compatible exclusively with server scripts, making them useful within the context of backend operations.

By understanding these properties, developers can effectively manage and utilize date ranges in their SuiteScript applications, ensuring accurate data manipulations that align with user requirements.

Additional Resources

For further information, explore the N/workbook Module and SuiteScript 2.x Modules.

Key Takeaways

• The Range object is essential for handling date-time ranges in SuiteScript.
• Key members include Range.start and Range.end, both of which return date-time strings.
• Understanding these properties enhances data manipulation in SuiteScript workflows.