Context.displayLanguage property

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

var myDisplayLanguage = Office.context.displayLanguage;

Return Value

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

Remarks

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

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

Example

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; 
}

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.

Support history