Export (0) Print
Expand All

Document.url property (JavaScript API for Office)

apps for Office

Gets the URL of the document that the host application currently has open.

Last modified: March 02, 2015

Hosts:

Access, Excel, Project, Word

Last changed in

1.1

See all support details

var docUrl = Office.context.document.url;

The URL of the document. Returns null if the URL is unavailable.

Important: The url property returns information that may contain personally identifiable information (PII) in the name of the document and location where it is stored. If you must store or transmit this information, be sure to do so in an encrypted format.

function displayDocumentUrl() {
    write(Office.context.document.url);
}

// 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 property is supported in the corresponding Office host application. An empty cell indicates that the Office host application doesn't support this property.

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

Supported hosts, by platform

Office for Windows desktop

Office for Windows RT

Office Online
(in browser)

Access

Excel

Project

Word

Minimum permission level

Restricted

App types

Content, task pane

Library

Office.js

Namespace

Office

Version

Changes

1.1

Added support for content apps for Access.

1.0

Introduced

Show:
© 2015 Microsoft