Document.mode property

Gets the mode the document is in.

Hosts: Access, PowerPoint, Excel, Word
Last changed in 1.1
var docMode = Office.context.document.mode;

Return Value

A DocumentMode.

Example

function displayDocumentMode() {
    write(Office.context.document.mode);
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

Support details

A capital Y in the following matrix indicates that this method is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this method.

For more information about Office host application and server requirements, see Requirements for running Office Add-ins.

Supported hosts, by platform

Office for Windows desktop Office Online (in browser) Office for iPad
Access Y
Excel Y Y Y
PowerPoint Y Y Y
Word Y Y Y
Minimum permission level Restricted
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history


Version Changes
1.1 Added support for Word Online.
1.1 Added support for Excel, PowerPoint, and Word in Office for iPad.
1.1 Added support for content add-ins for Access.
1.0 Introduced