-
Notifications
You must be signed in to change notification settings - Fork 65
/
office.activeview.yml
33 lines (30 loc) · 1.1 KB
/
office.activeview.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
### YamlMime:TSEnum
name: Office.ActiveView
uid: 'office!Office.ActiveView:enum'
package: office!
fullName: Office.ActiveView
summary: 'Specifies the state of the active view of the document, for example, whether the user can edit the document.'
remarks: |-
#### Examples
```TypeScript
// Get whether the current view is edit or read.
Office.context.document.getActiveViewAsync(function (asyncResult) {
if (asyncResult.status == "failed") {
showMessage("Action failed with error: " + asyncResult.error.message);
} else {
const activeView : Office.ActiveView = asyncResult.value;
showMessage("The current view is " + activeView);
}
});
```
isPreview: false
isDeprecated: false
fields:
- name: Edit
uid: 'office!Office.ActiveView.Edit:member'
package: office!
summary: The active view of the Office application lets the user edit the content in the document.
- name: Read
uid: 'office!Office.ActiveView.Read:member'
package: office!
summary: The active view of the Office application only lets the user read the content in the document.