Edit

Share via

What's new in Excel JavaScript API 1.11

  • Article

The ExcelApi 1.11 improved support for comments and workbook-level controls (such as saving and closing the workbook). It also added access to culture settings to help account for localization.

Feature area Description Relevant objects
Comment Mentions Tags and notifies other workbook users through comments. Comment, CommentRichContent
Comment Resolution Resolve comment threads and get the resolution status. Comment
Culture settings Gets cultural system settings for the workbook, such as number formatting. CultureInfo, NumberFormatInfo Application
Cut and paste (moveTo) Replicates the cut-and-paste functionality in Excel for a Range. Range
Workbook Save and Close Save and close workbooks. Workbook
Worksheet events Additional events and event information for worksheet calculations and hidden rows. WorksheetCalculatedEventArgs, WorksheetRowHiddenChangedEventArgs

API list

The following table lists the APIs in Excel JavaScript API requirement set 1.11. To view API reference documentation for all APIs supported by Excel JavaScript API requirement set 1.11 or earlier, see Excel APIs in requirement set 1.11 or earlier.

Class Fields Description
Application cultureInfo Provides information based on current system culture settings.
decimalSeparator Gets the string used as the decimal separator for numeric values.
thousandsSeparator Gets the string used to separate groups of digits to the left of the decimal for numeric values.
useSystemSeparators Specifies if the system separators of Excel are enabled.
Comment mentions Gets the entities (e.g., people) that are mentioned in comments.
resolved The comment thread status.
richContent Gets the rich comment content (e.g., mentions in comments).
updateMentions(contentWithMentions: Excel.CommentRichContent) Updates the comment content with a specially formatted string and a list of mentions.
CommentCollection add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType) Creates a new comment with the given content on the given cell.
CommentMention email The email address of the entity that is mentioned in a comment.
id The ID of the entity.
name The name of the entity that is mentioned in a comment.
CommentReply mentions The entities (e.g., people) that are mentioned in comments.
resolved The comment reply status.
richContent The rich comment content (e.g., mentions in comments).
updateMentions(contentWithMentions: Excel.CommentRichContent) Updates the comment content with a specially formatted string and a list of mentions.
CommentReplyCollection add(content: CommentRichContent | string, contentType?: Excel.ContentType) Creates a comment reply for a comment.
CommentRichContent mentions An array containing all the entities (e.g., people) mentioned within the comment.
richContent Specifies the rich content of the comment (e.g., comment content with mentions, the first mentioned entity has an ID attribute of 0, and the second mentioned entity has an ID attribute of 1).
CultureInfo name Gets the culture name in the format languagecode2-country/regioncode2 (e.g., "zh-cn" or "en-us").
numberFormat Defines the culturally appropriate format of displaying numbers.
NumberFormatInfo numberDecimalSeparator Gets the string used as the decimal separator for numeric values.
numberGroupSeparator Gets the string used to separate groups of digits to the left of the decimal for numeric values.
Range moveTo(destinationRange: Range | string) Moves cell values, formatting, and formulas from current range to the destination range, replacing the old information in those cells.
RangeFormat adjustIndent(amount: number) Adjusts the indentation of the range formatting.
Workbook close(closeBehavior?: Excel.CloseBehavior) Close current workbook.
save(saveBehavior?: Excel.SaveBehavior) Save current workbook.
Worksheet onRowHiddenChanged Occurs when the hidden state of one or more rows has changed on a specific worksheet.
WorksheetCalculatedEventArgs address The address of the range that completed calculation.
WorksheetCollection onRowHiddenChanged Occurs when the hidden state of one or more rows has changed on a specific worksheet.
WorksheetRowHiddenChangedEventArgs address Gets the range address that represents the changed area of a specific worksheet.
changeType Gets the type of change that represents how the event was triggered.
source Gets the source of the event.
type Gets the type of the event.
worksheetId Gets the ID of the worksheet in which the data changed.

See also