Excel.WorksheetChangedEventArgs interface
Provides information about the worksheet that raised the changed event.
Remarks
[Api set: ExcelApi 1.7]
Properties
| address | Gets the range address that represents the changed area of a specific worksheet. |
| change |
Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted. This includes the following two scenarios. 1. The direction (such as down or to the right) that existing cells will shift when a new cell or cells are inserted into a worksheet. 2. The direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted from a worksheet. |
| change |
Gets the change type that represents how the changed event is triggered. See |
| details | Represents the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved. |
| source | Gets the source of the event. See |
| trigger |
Represents the trigger source of the event. For example, identifies whether this local add-in triggers the event. |
| type | Gets the type of the event. See |
| worksheet |
Gets the ID of the worksheet in which the data changed. |
Methods
| get |
Gets the range that represents the changed area of a specific worksheet. [Api set: ExcelApi 1.8] |
| get |
Gets the range that represents the changed area of a specific worksheet. It might return null object. [Api set: ExcelApi 1.8] |
Property Details
address
Gets the range address that represents the changed area of a specific worksheet.
address: string;Property Value
string
Remarks
[Api set: ExcelApi 1.7]
changeDirectionState
Represents a change to the direction that the cells in a worksheet will shift when a cell or cells are deleted or inserted. This includes the following two scenarios. 1. The direction (such as down or to the right) that existing cells will shift when a new cell or cells are inserted into a worksheet. 2. The direction (such as up or to the left) that the remaining cells will shift when a cell or cells are deleted from a worksheet.
changeDirectionState: Excel.ChangeDirectionState;Property Value
Remarks
[Api set: ExcelApi 1.14]
changeType
Gets the change type that represents how the changed event is triggered. See Excel.DataChangeType for details.
changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";Property Value
Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"
Remarks
[Api set: ExcelApi 1.7]
details
Represents the information about the change detail. This property can be retrieved when the changed event is triggered on a single cell. If the changed event is triggered on multiple cells, this property cannot be retrieved.
details: Excel.ChangedEventDetail;Property Value
Remarks
[Api set: ExcelApi 1.9]
source
Gets the source of the event. See Excel.EventSource for details.
source: Excel.EventSource | "Local" | "Remote";Property Value
Excel.EventSource | "Local" | "Remote"
Remarks
[Api set: ExcelApi 1.7]
triggerSource
Represents the trigger source of the event. For example, identifies whether this local add-in triggers the event.
triggerSource: Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin";Property Value
Excel.EventTriggerSource | "Unknown" | "ThisLocalAddin"
Remarks
[Api set: ExcelApi 1.14]
type
Gets the type of the event. See Excel.EventType for details.
type: "WorksheetChanged";Property Value
"WorksheetChanged"
Remarks
[Api set: ExcelApi 1.7]
worksheetId
Gets the ID of the worksheet in which the data changed.
worksheetId: string;Property Value
string
Remarks
[Api set: ExcelApi 1.7]
Method Details
getRange(ctx)
Gets the range that represents the changed area of a specific worksheet.
[Api set: ExcelApi 1.8]
getRange(ctx: Excel.RequestContext): Excel.Range;Parameters
Returns
getRangeOrNullObject(ctx)
Gets the range that represents the changed area of a specific worksheet. It might return null object.
[Api set: ExcelApi 1.8]
getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;