Context.displayLanguage property (JavaScript API for Office)

apps for Office

Gets the locale (language) specified by the user for the UI of the Office host application.

Last modified: February 27, 2015

Hosts:

Access, Excel, Outlook, PowerPoint, Project, Word

Last changed in

1.1

See all support details

var myDisplayLanguage = Office.context.displayLanguage;

A string in the RFC 1766 Language tag format, such as en-US.

The displayLanguage value reflects the current Display Language setting specified with File > Options > Language in the Office host application.

In content apps for Access web apps, the displayLanguage property gets the app language (e.g., "en-US").

In this article, "Outlook" refers to Outlook for Windows, Outlook for Mac, Outlook RT, OWA for Devices (OWA for Android phones, OWA for iPad, OWA for iPhone), and Outlook Web App. "Outlook rich clients" refers to Outlook for Windows, Outlook for Mac and Outlook RT. At this point, Outlook for Mac supports JavaScript API for Office in only Outlook read mode, and can activate mail apps that reference office.js version 1.0 or 1.1 and use apps for Office schema version 1.0.

function sayHelloWithDisplayLanguage() {
    var myDisplayLanguage = Office.context.displayLanguage;
    switch (myDisplayLanguage) {
        case 'en-US':
            write('Hello!');
            break;
        case 'en-NZ':
            write('G\'day mate!');
            break;
    }
}
// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}

A checkmark (√) 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 apps for Office.

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Outlook for Mac

Access

Excel

Outlook

PowerPoint

Project

Word

Minimum permission level

Restricted

App types

Content, mail, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added access to this API in content apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft