-
Notifications
You must be signed in to change notification settings - Fork 66
/
excel.tableselectionchangedeventargs.yml
90 lines (82 loc) · 3.19 KB
/
excel.tableselectionchangedeventargs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
### YamlMime:TSType
name: Excel.TableSelectionChangedEventArgs
uid: 'excel!Excel.TableSelectionChangedEventArgs:interface'
package: excel!
fullName: Excel.TableSelectionChangedEventArgs
summary: Provides information about the table that raised the selection changed event.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: interface
properties:
- name: address
uid: 'excel!Excel.TableSelectionChangedEventArgs#address:member'
package: excel!
fullName: address
summary: Gets the range address that represents the selected area of the table on a specific worksheet.
remarks: >-
\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-table-changed.yaml
async function onSelectionChange(args) {
await Excel.run(async (context) => {
console.log("Handler for table onSelectionChanged event has been triggered. The new selection is: " + args.address);
});
}
```
isPreview: false
isDeprecated: false
syntax:
content: 'address: string;'
return:
type: string
- name: isInsideTable
uid: 'excel!Excel.TableSelectionChangedEventArgs#isInsideTable:member'
package: excel!
fullName: isInsideTable
summary: Specifies if the selection is inside a table. `IsInsideTable` must be set to `true` for the address to be useful.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'isInsideTable: boolean;'
return:
type: boolean
- name: tableId
uid: 'excel!Excel.TableSelectionChangedEventArgs#tableId:member'
package: excel!
fullName: tableId
summary: Gets the ID of the table in which the selection changed.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'tableId: string;'
return:
type: string
- name: type
uid: 'excel!Excel.TableSelectionChangedEventArgs#type:member'
package: excel!
fullName: type
summary: Gets the type of the event. See `Excel.EventType` for details.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'type: "TableSelectionChanged";'
return:
type: '"TableSelectionChanged"'
- name: worksheetId
uid: 'excel!Excel.TableSelectionChangedEventArgs#worksheetId:member'
package: excel!
fullName: worksheetId
summary: Gets the ID of the worksheet in which the selection changed.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'worksheetId: string;'
return:
type: string