Document.getSelectedDataAsync method

Reads the data contained in the current selection in the document.

Hosts: Access, Excel, PowerPoint, Project, Word
Available in requirement sets Selection
Last changed in Selection 1.1
Office.context.document.getSelectedDataAsync(coercionType [, options], callback); 


Name Type Description
coercionType CoercionType
The type of data structure to return. Required. See coercionType value.
options object Specifies any of the following optional parameters. See options value.
callback object A function that is invoked when the callback returns, whose only parameter is of type AsyncResult.

coercionType value

Host Supported coercionType
Excel, Excel Online, PowerPoint, PowerPoint Online, Word, and Word Online only Office.CoercionType.Text (string)
Excel, Word, and Word Online only Office.CoercionType.Matrix (array of arrays)
Access, Excel, Word, and Word Online only Office.CoercionType.Table (TableData object)
Word only Office.CoercionType.Html
Word and Word Online only Office.CoercionType.Ooxml (Office Open XML)
PowerPoint and PowerPoint Online only Office.CoercionType.SlideRange

options value

Name Type Description
valueFormat valueFormat Specifies whether to return the result with its number or date values formatted or unformatted.
filterType filterType Specifies whether to apply filtering when the data is retrieved. Optional.

This parameter is ignored in Word documents.
asyncContext array, boolean, null, number, object, string, or undefined A user-defined item of any type that is returned in the AsyncResult object without being altered.

Callback value

When the function you passed to the callback parameter executes, it receives an AsyncResult object that you can access from the callback function's only parameter.

In the callback function that is passed to the getSelectedDataAsync method, you can use the properties of the AsyncResult object to return the following information.

Property Use to...
AsyncResult.value Access the values in the current selection, which are returned in the data structure or format you specified with the coercionType parameter. (See Remarks for more information about data coercion.)
AsyncResult.status Determine the success or failure of the operation.
AsyncResult.error Access an Error object that provides error information if the operation failed.
AsyncResult.asyncContext Access your user-defined object or value, if you passed one as the asyncContext parameter.


In your task pane or content add-in, use the getSelectedDataAsync method to write script that reads the data from the user's selection in a document, spreadsheet, presentation, or project. For example, after a user selects content in a Word document, you can use the getSelectedDataAsync method to read that selection, and then submit it to a web service as a query or some other operation.

After reading the selection, you can also use the setSelectedDataAsync and addHandlerAsync methods of the Document object to write back to the selection or add an event handler to detect if the user changes the selection.

The getSelectedDataAsync method can read from the selection only as long as it's active. In add-ins for Word and Excel, if you need to make a persistent association to read and write to the user's selection, instead use the Bindings.addFromSelectionAsync method to bind to that selection.

Use the coercionType parameter of the getSelectedDataAsync method to specify the data structure or format of the selected data being read.

Specified coercionType Data returned Office host application support
Office.CoercionType.Text or "text" A string. Word, Excel, PowerPoint, and Project.

Note: In Excel, even when a subset of a cell is selected, the entire cell contents are returned.
Office.CoercionType.Matrix or "matrix" An array of arrays. For example, [['a','b'], ['c','d']] for a selection of two rows in two columns. Word and Excel.
Office.CoercionType.Table or "table" A TableData object for reading a table with headers. Word and Excel.
Office.CoercionType.Html or "html" In HTML format. Word only.
Office.CoercionType.Ooxml or "ooxml" In Open Office XML (OpenXML) format. Word only.

Tip: When developing your add-in's code, you can use the "ooxml" coercionType of the getSelectedDataAsync method to see how the content you select in a Word document is defined as OpenXML tags. Then, use those tags in the data parameter of the Document.setSelectedDataAsync method to write content with that formatting or structure to a document. For example, you can insert an image into a document as OpenXML.
Office.CoercionType.SlideRange or "slideRange" A JSON object that contains an array named "slides" that contains the ids, titles, and indexes of the selected slides. Note: To select more than one slide, the user must be editing the presentation in Normal, Outline View, or Slide Sorter view. Also, this method isn't supported in Master Views.For example, {"slides":[{"id":257,"title":"Slide 2","index":2},{"id":256,"title":"Slide 1","index":1}]} for a selection of two slides. PowerPoint only.

If the data structure of the selection doesn't match the specified coercionType, the getSelectedDataAsync method will attempt to coerce the data into that type or structure. If the selection can't be coerced into the Office.CoercionType you specified, the AsyncResult.status property returns "failed".


To read the value of the current selection, you need to write a callback function that reads the selection. The following example shows how to:

  • Pass an anonymous callback function that reads the value of the current selection to the callback parameter of the getSelectedDataAsync method.

  • Read the selection as text, unformatted, and not filtered.

  • Display the value on the add-in's page.

function getText() {
        { valueFormat: "unformatted", filterType: "all" },
        function (asyncResult) {
            var error = asyncResult.error;
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                write( + ": " + error.message);
            else {
                // Get selected data.
                var dataValue = asyncResult.value; 
                write('Selected data is ' + dataValue);

// 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
Project Y
Word Y Y Y
Available in requirement sets Selection
Minimum permission level ReadDocument (ReadAllDocument required to get Office Open XML)
Add-in types Content, task pane
Library Office.js
Namespace Office

Support history

Version Changes
1.1 Added support for PowerPoint Online.
1.1 In Word Online, added support for Office.CoercionType.Matrix and Office.CoercionType.Table as the coercionType parameter.
1.1 In Excel, PowerPoint, and Word in Office for iPad, added the same level of support as Excel, PowerPoint and Word on Windows desktop.
1.1 In Word Online, added support for Office.CoercionType.Text as the coercionType parameter.
1.1 In content add-ins for PowerPoint, you can get the ids, titles, and indexes of the selected range of slides by passing Office.CoercionType.SlideRange as the coercionType parameter of the getSelectedDataAsync method. See the Document.goToByIdAsync method topic for an example of how to use this value to navigate to the currently selected slide.
1.0 Introduced