Office.Document interface

Абстрактный класс, представляющий документ, с которым взаимодействует надстройка.

Комментарии

Хосты: Excel, PowerPoint, Project, Word

Свойства

bindings

Получает объект, предоставляющий доступ к привязкам, определенным в документе.

customXmlParts

Получает объект, представляющий настраиваемые XML-части в документе.

mode

Получает режим, в котором находится документ.

settings

Получает объект, который представляет сохраненные настраиваемые параметры надстройки области задач или контентной надстройки для текущего документа.

url

Получает URL-адрес документа, открытого ведущим приложением. Возвращает null, если URL-адрес недоступен.

Методы

addHandlerAsync(eventType, handler, options, callback)

Добавляет обработник событий для события объекта Document.

addHandlerAsync(eventType, handler, callback)

Добавляет обработник событий для события объекта Document.

getActiveViewAsync(options, callback)

Возвращает состояние текущего представления презентации (редактирование или чтение).

getActiveViewAsync(callback)

Возвращает состояние текущего представления презентации (редактирование или чтение).

getFileAsync(fileType, options, callback)

Возвращает полный файл документа по фрагментам размером до 4194304 байт (4 МБ). Для надстройок на iPad срез файла поддерживается до 65536 (64 КБ). Обратите внимание, что если указать размер фрагмента выше допустимого, возникнет сбой "Внутренняя ошибка".

getFileAsync(fileType, callback)

Возвращает полный файл документа по фрагментам размером до 4194304 байт (4 МБ). Для надстройок на iPad срез файла поддерживается до 65536 (64 КБ). Обратите внимание, что если указать размер фрагмента выше допустимого, возникнет сбой "Внутренняя ошибка".

getFilePropertiesAsync(options, callback)

Получает свойства текущего документа.

getFilePropertiesAsync(callback)

Получает свойства текущего документа.

getMaxResourceIndexAsync(options, callback)

Только документы проекта. Получите максимальный индекс коллекции ресурсов в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxResourceIndexAsync(callback)

Только документы проекта. Получите максимальный индекс коллекции ресурсов в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxTaskIndexAsync(options, callback)

Только документы проекта. Получите максимальный индекс коллекции задач в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxTaskIndexAsync(callback)

Только документы проекта. Получите максимальный индекс коллекции задач в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getProjectFieldAsync(fieldId, options, callback)

Только документы проекта. Получить поле Project (Ex. ProjectWebAccessURL).

getProjectFieldAsync(fieldId, callback)

Только документы проекта. Получить поле Project (Ex. ProjectWebAccessURL).

getResourceByIndexAsync(resourceIndex, options, callback)

Только документы проекта. Получите GUID ресурса с указанным индексом в коллекции ресурсов.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getResourceByIndexAsync(resourceIndex, callback)

Только документы проекта. Получите GUID ресурса с указанным индексом в коллекции ресурсов.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getResourceFieldAsync(resourceId, fieldId, options, callback)

Только документы проекта. Получите поле ресурсов для предоставленного имени ресурса. (Ex.ResourceName)

getResourceFieldAsync(resourceId, fieldId, callback)

Только документы проекта. Получите поле ресурсов для предоставленного имени ресурса. (Ex.ResourceName)

getSelectedDataAsync(coercionType, options, callback)

Считывает данные в текущем выделенном фрагменте документа.

getSelectedDataAsync(coercionType, callback)

Считывает данные в текущем выделенном фрагменте документа.

getSelectedResourceAsync(options, callback)

Только документы проекта. Получите текущий выбранный ИД ресурса.

getSelectedResourceAsync(callback)

Только документы проекта. Получите текущий выбранный ИД ресурса.

getSelectedTaskAsync(options, callback)

Только документы проекта. Получите текущий выбранный Id задачи.

getSelectedTaskAsync(callback)

Только документы проекта. Получите текущий выбранный Id задачи.

getSelectedViewAsync(options, callback)

Только документы проекта. Получите текущий выбранный тип представления (Ex. Gantt) и Имя представления.

getSelectedViewAsync(callback)

Только документы проекта. Получите текущий выбранный тип представления (Ex. Gantt) и Имя представления.

getTaskAsync(taskId, options, callback)

Только документы проекта. Получите имя задачи, Windows SharePoint Services задач и имена ресурсов для данного taskId.

getTaskAsync(taskId, callback)

Только документы проекта. Получите имя задачи, Windows SharePoint Services задач и имена ресурсов для данного taskId.

getTaskByIndexAsync(taskIndex, options, callback)

Только документы проекта. Получите GUID задачи с указанным индексом в коллекции задач.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getTaskByIndexAsync(taskIndex, callback)

Только документы проекта. Получите GUID задачи с указанным индексом в коллекции задач.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getTaskFieldAsync(taskId, fieldId, options, callback)

Только документы проекта. Получите поле задач для предоставленного ID задачи. (Ex. StartDate).

getTaskFieldAsync(taskId, fieldId, callback)

Только документы проекта. Получите поле задач для предоставленного ID задачи. (Ex. StartDate).

getWSSUrlAsync(options, callback)

Только документы проекта. Получите Windows SharePoint Services url и имя списка для списка задач, MPP также синхронизирован.

getWSSUrlAsync(callback)

Только документы проекта. Получите Windows SharePoint Services url и имя списка для списка задач, MPP также синхронизирован.

goToByIdAsync(id, goToType, options, callback)

Переходит к указанному объекту или месту в документе.

goToByIdAsync(id, goToType, callback)

Переходит к указанному объекту или месту в документе.

removeHandlerAsync(eventType, options, callback)

Удаляет обработник событий для указанного типа событий.

removeHandlerAsync(eventType, callback)

Удаляет обработник событий для указанного типа событий.

setResourceFieldAsync(resourceId, fieldId, fieldValue, options, callback)

Только документы проекта. Установите поле ресурсов для указанного ИД ресурса.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setResourceFieldAsync(resourceId, fieldId, fieldValue, callback)

Только документы проекта. Установите поле ресурсов для указанного ИД ресурса.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setSelectedDataAsync(data, options, callback)

Записывает указанные данные в текущий выбор.

setSelectedDataAsync(data, callback)

Записывает указанные данные в текущий выбор.

setTaskFieldAsync(taskId, fieldId, fieldValue, options, callback)

Только документы проекта. Задай поле задач для указанного id задачи.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setTaskFieldAsync(taskId, fieldId, fieldValue, callback)

Только документы проекта. Задай поле задач для указанного id задачи.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

Сведения о свойстве

bindings

Получает объект, предоставляющий доступ к привязкам, определенным в документе.

bindings: Bindings;

Значение свойства

Комментарии

Объект Document не мгновенно в скрипте. Чтобы вызвать элементы объекта Document для взаимодействия с текущим документом или листом, используйте объект Office.context.document.

Примеры

function displayAllBindings() {
    Office.context.document.bindings.getAllAsync(function (asyncResult) {
        var bindingString = '';
        for (var i in asyncResult.value) {
            bindingString += asyncResult.value[i].id + '\n';
        }
        write('Existing bindings: ' + bindingString);
    });
}

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

customXmlParts

Получает объект, представляющий настраиваемые XML-части в документе.

customXmlParts: CustomXmlParts;

Значение свойства

Примеры

function getCustomXmlParts(){
    Office.context.document.customXmlParts.getByNamespaceAsync('http://tempuri.org', function (asyncResult) {
        write('Retrieved ' + asyncResult.value.length + ' custom XML parts');
    });
}

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

mode

Получает режим, в котором находится документ.

mode: DocumentMode;

Значение свойства

Примеры

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; 
}
// The following example initializes the add-in and then gets properties of the
// Document object that are available in the context of a Project document.
// A Project document is the opened, active project. To access members of the
// ProjectDocument object, use the Office.context.document object as shown in
// the code examples for ProjectDocument methods and events.
// The example assumes your add-in has a reference to the jQuery library and
// that the following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // Get information about the document.
            showDocumentProperties();
        });
    };

    // Get the document mode and the URL of the active project.
    function showDocumentProperties() {
        var output = String.format(
            'The document mode is {0}.<br/>The URL of the active project is {1}.',
            Office.context.document.mode,
            Office.context.document.url);
        $('#message').html(output);
    }
})();

settings

Получает объект, который представляет сохраненные настраиваемые параметры надстройки области задач или контентной надстройки для текущего документа.

settings: Settings;

Значение свойства

url

Получает URL-адрес документа, открытого ведущим приложением. Возвращает null, если URL-адрес недоступен.

url: string;

Значение свойства

string

Примеры

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

Сведения о методе

addHandlerAsync(eventType, handler, options, callback)

Добавляет обработник событий для события объекта Document.

addHandlerAsync(eventType: Office.EventType, handler: any, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Параметры

eventType
Office.EventType

Для события объекта Document параметр eventType можно ука- Office.EventType.Document.SelectionChanged``Office.EventType.Document.ActiveViewChangedили соответствующее текстовое значение этого переумерия.

handler

any

Добавлена функция обработчивеля событий, единственный параметр которой — тип Office.DocumentSelectionChangedEventArgs. Обязательное.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Комментарии

Набор требований: DocumentEvents

Вы можете добавить несколько обработчиков событий для указанного eventType до тех пор, пока имя каждой функции обработщика событий является уникальным.

addHandlerAsync(eventType, handler, callback)

Добавляет обработник событий для события объекта Document.

addHandlerAsync(eventType: Office.EventType, handler: any, callback?: (result: AsyncResult<void>) => void): void;

Параметры

eventType
Office.EventType

Для события объекта Document параметр eventType можно ука- Office.EventType.Document.SelectionChanged``Office.EventType.Document.ActiveViewChangedили соответствующее текстовое значение этого переумерия.

handler

any

Добавлена функция обработчивеля событий, единственный параметр которой — тип Office.DocumentSelectionChangedEventArgs. Обязательное.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Комментарии

Набор требований: DocumentEvents

Вы можете добавить несколько обработчиков событий для указанного eventType до тех пор, пока имя каждой функции обработщика событий является уникальным.

Примеры

// The following example adds an event handler for the SelectionChanged event of a document
function addSelectionChangedEventHandler() {
    Office.context.document.addHandlerAsync(Office.EventType.DocumentSelectionChanged, MyHandler);
}

function MyHandler(eventArgs) {
    write('Event raised: ' + eventArgs.type);
    doSomethingWithDocument(eventArgs.document);
}

// Function that writes to a div with id='message' on the page.
function write(message){
    document.getElementById('message').innerText += message; 
}
// The following code example adds a handler for the ResourceSelectionChanged event.
// When the resource selection changes in the document, it gets the GUID of the selected resource.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.ResourceSelectionChanged,
                getResourceGuid);
        });
    };

    // Get the GUID of the selected resource and display it in the add-in.
    function getResourceGuid() {
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    $('#message').html(result.value);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

// For a complete code sample that shows how to use a ResourceSelectionChanged
// event handler in a Project add-in, see "Create your first task pane add-in
// for Project 2013 by using a text editor."
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
// The following code example adds a handler for the TaskSelectionChanged event.
// When the task selection changes in the document, it gets the GUID of the
// selected task.
// The example assumes your add-in has a reference to the jQuery library and that
// the following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.TaskSelectionChanged,
                getTaskGuid);
            getTaskGuid();
        });
    };

    // Get the GUID of the selected task and display it in the add-in.
    function getTaskGuid() {
        Office.context.document.getSelectedTaskAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    $('#message').html(result.value);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();
// The following code example adds a handler for the ViewSelectionChanged
// event. When the active view changes, it gets the name and type of the active view.
// The example assumes your add-in has a reference to the jQuery library and that
// the following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.ViewSelectionChanged,
                getActiveView);
            getActiveView();
        });
    };

    // Get the name and type of the active view and display it in the add-in.
    function getActiveView() {
        Office.context.document.getSelectedViewAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var output = String.format(
                        'View name: {0}<br/>View type: {1}',
                        result.value.viewName, result.value.viewType);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

// For an example that shows how to use a ViewSelectionChanged event handler in a
// Project add-in, see "Create your first task pane add-in for Project 2013 by
// using a text editor."
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
// The following code example uses addHandlerAsync to add an event handler for the ViewSelectionChanged event.
// When the active view changes, the handler checks the view type. It enables a button if the view is a resource
// view and disables the button if it isn't a resource view. Choosing the button gets the GUID of the selected
// resource and displays it in the add-in.
// The example assumes that your add-in has a reference to the jQuery library and that the following page controls
// are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" disabled="disabled" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            // Add a ViewSelectionChanged event handler.
            Office.context.document.addHandlerAsync(
                Office.EventType.ViewSelectionChanged,
                getActiveView);
            $('#get-info').click(getResourceGuid);

            // This example calls the handler on page load to get the active view
            // of the default page.
            getActiveView();
        });
    };

    // Activate the button based on the active view type of the document.
    // This is the ViewSelectionChanged event handler.
    function getActiveView() {
        Office.context.document.getSelectedViewAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var viewType = result.value.viewType;
                    if (viewType == 6 ||   // ResourceForm
                        viewType == 7 ||   // ResourceSheet
                        viewType == 8 ||   // ResourceGraph
                        viewType == 15) {  // ResourceUsage
                        $('#get-info').removeAttr('disabled');
                    }
                    else {
                        $('#get-info').attr('disabled', 'disabled');
                    }
                    var output = String.format(
                        'View name: {0}<br/>View type: {1}',
                        result.value.viewName, viewType);
                    $('#message').html(output);
                }
            }
        );
    }

    // Get the GUID of the currently selected resource and display it in the add-in.
    function getResourceGuid() {
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    $('#message').html('Resource GUID: ' + result.value);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

// For a complete code sample that shows how to use a ViewSelectionChanged event handler in a Project add-in,
// see "Create your first task pane add-in for Project by using a text editor."
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor

getActiveViewAsync(options, callback)

Возвращает состояние текущего представления презентации (редактирование или чтение).

getActiveViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<"edit" | "read">) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<"edit" | "read">) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является состояние текущего представления презентации. Возвращаемая величина может быть "изменить" или "прочитать". "Изменение" соответствует любому из представлений, в которых можно редактировать слайды, например Normal или Outline View. "Чтение" соответствует слайд-шоу или представлению чтения.

Возвращаемое значение

void

Комментарии

Набор требований: ActiveView

Может активировать событие при изменении представления.

getActiveViewAsync(callback)

Возвращает состояние текущего представления презентации (редактирование или чтение).

getActiveViewAsync(callback?: (result: AsyncResult<"edit" | "read">) => void): void;

Параметры

callback

(result: Office.AsyncResult<"edit" | "read">) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является состояние текущего представления презентации. Возвращаемая величина может быть "изменить" или "прочитать". "Изменение" соответствует любому из представлений, в которых можно редактировать слайды, например Normal или Outline View. "Чтение" соответствует слайд-шоу или представлению чтения.

Возвращаемое значение

void

Комментарии

Набор требований: ActiveView

Может активировать событие при изменении представления.

Примеры

function getFileView() {
    // Get whether the current view is edit or read.
    Office.context.document.getActiveViewAsync(function (asyncResult) {
        if (asyncResult.status == "failed") {
            showMessage("Action failed with error: " + asyncResult.error.message);
        }
        else {
            showMessage(asyncResult.value);
        }
    });
}

getFileAsync(fileType, options, callback)

Возвращает полный файл документа по фрагментам размером до 4194304 байт (4 МБ). Для надстройок на iPad срез файла поддерживается до 65536 (64 КБ). Обратите внимание, что если указать размер фрагмента выше допустимого, возникнет сбой "Внутренняя ошибка".

getFileAsync(fileType: FileType, options?: GetFileOptions, callback?: (result: AsyncResult<Office.File>) => void): void;

Параметры

fileType
Office.FileType

Формат, в котором будет возвращен файл

options
Office.GetFileOptions

Предоставляет параметры для настройки размера срезов, на которые будет разделен документ.

callback

(result: Office.AsyncResult<Office.File>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является объект File.

Возвращаемое значение

void

Комментарии

Наборы требований:

  • CompressedFile (при использовании Office.FileType.Compressed)

  • File

  • TextFile (при использовании Office.FileType.Text)

Для надстройок, работающих в хост-приложениях Office, помимо Office на iPad, метод поддерживает получение файлов в срезах до getFileAsync 4194304 bytes (4 МБ). Для надстройок, работающих в приложениях Office на iPad, метод поддерживает получение файлов в срезах до getFileAsync 65536 (64 КБ).

Параметр fileType можно укаменеть с помощью переумерия Office.FileType или текстовых значений. Но возможные значения зависят от хоста:

Поддерживаемые FileTypes с помощью платформы

Office для Windows Office в Интернете Office для iPad Office для Mac
Excel Compressed, Pdf, Text Compressed, Pdf Compressed, Pdf, Text
PowerPoint Compressed, Pdf Compressed, Pdf Compressed, Pdf Compressed, Pdf
Word Compressed, Pdf, Text Compressed, Pdf, Text Compressed Compressed, Pdf, Text

Примеры

// The following example gets the document in Office Open XML ("compressed") format in 65536 bytes (64 KB) slices.
// Note: The implementation of app.showNotification in this example is from the Visual Studio template for Office Add-ins.
function getDocumentAsCompressed() {
    Office.context.document.getFileAsync(Office.FileType.Compressed, { sliceSize: 65536 /*64 KB*/ }, 
        function (result) {
            if (result.status == "succeeded") {
                // If the getFileAsync call succeeded, then
                // result.value will return a valid File Object.
                var myFile = result.value;
                var sliceCount = myFile.sliceCount;
                var slicesReceived = 0, gotAllSlices = true, docdataSlices = [];
                app.showNotification("File size:" + myFile.size + " #Slices: " + sliceCount);

                // Get the file slices.
                getSliceAsync(myFile, 0, sliceCount, gotAllSlices, docdataSlices, slicesReceived);
            }
            else {
                app.showNotification("Error:", result.error.message);
            }
    });
}

function getSliceAsync(file, nextSlice, sliceCount, gotAllSlices, docdataSlices, slicesReceived) {
    file.getSliceAsync(nextSlice, function (sliceResult) {
        if (sliceResult.status == "succeeded") {
            if (!gotAllSlices) { // Failed to get all slices, no need to continue.
                return;
            }

            // Got one slice, store it in a temporary array.
            // (Or you can do something else, such as
            // send it to a third-party server.)
            docdataSlices[sliceResult.value.index] = sliceResult.value.data;
            if (++slicesReceived == sliceCount) {
              // All slices have been received.
              file.closeAsync();
              onGotAllSlices(docdataSlices);
            }
            else {
                getSliceAsync(file, ++nextSlice, sliceCount, gotAllSlices, docdataSlices, slicesReceived);
            }
        }
            else {
                gotAllSlices = false;
                file.closeAsync();
                app.showNotification("getSliceAsync Error:", sliceResult.error.message);
            }
    });
}

function onGotAllSlices(docdataSlices) {
    var docdata = [];
    for (var i = 0; i < docdataSlices.length; i++) {
        docdata = docdata.concat(docdataSlices[i]);
    }

    var fileContent = new String();
    for (var j = 0; j < docdata.length; j++) {
        fileContent += String.fromCharCode(docdata[j]);
    }

    // Now all the file content is stored in 'fileContent' variable,
    // you can do something with it, such as print, fax...
}

// The following example gets the document in PDF format.
Office.context.document.getFileAsync(Office.FileType.Pdf,
    function(result) {
        if (result.status == "succeeded") {
            var myFile = result.value;
            var sliceCount = myFile.sliceCount;
            app.showNotification("File size:" + myFile.size + " #Slices: " + sliceCount);
            // Now, you can call getSliceAsync to download the files,
            // as described in the previous code segment (compressed format).
            
            myFile.closeAsync();
        }
        else {
            app.showNotification("Error:", result.error.message);
        }
}
);

getFileAsync(fileType, callback)

Возвращает полный файл документа по фрагментам размером до 4194304 байт (4 МБ). Для надстройок на iPad срез файла поддерживается до 65536 (64 КБ). Обратите внимание, что если указать размер фрагмента выше допустимого, возникнет сбой "Внутренняя ошибка".

getFileAsync(fileType: FileType, callback?: (result: AsyncResult<Office.File>) => void): void;

Параметры

fileType
Office.FileType

Формат, в котором будет возвращен файл

callback

(result: Office.AsyncResult<Office.File>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является объект File.

Возвращаемое значение

void

Комментарии

Наборы требований:

  • CompressedFile (при использовании Office.FileType.Compressed)

  • File

  • TextFile (при использовании Office.FileType.Text)

Для надстройок, работающих в хост-приложениях Office, помимо Office на iPad, метод поддерживает получение файлов в срезах до getFileAsync 4194304 bytes (4 МБ). Для надстройок, запущенных в Office в приложениях для iPad, метод поддерживает получение файлов в срезах до getFileAsync 65536 (64 КБ).

Параметр fileType можно укаменеть с помощью переумерия Office.FileType или текстовых значений. Но возможные значения зависят от хоста:

Поддерживаемые FileTypes с помощью платформы

Office для Windows Office в Интернете Office для iPad Office для Mac
Excel Compressed, Pdf, Text Compressed, Pdf Compressed, Pdf, Text
PowerPoint Compressed, Pdf Compressed, Pdf Compressed, Pdf Compressed, Pdf
Word Compressed, Pdf, Text Compressed, Pdf, Text Compressed Compressed, Pdf, Text

getFilePropertiesAsync(options, callback)

Получает свойства текущего документа.

getFilePropertiesAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<Office.FileProperties>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<Office.FileProperties>) => void

Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата являются свойства value файла (с URL-адресом, найденным в asyncResult.value.url).

Возвращаемое значение

void

Комментарии

Наборы требований. Не в наборе

Вы получаете URL-адрес файла с свойством URL-адреса asyncResult.value.url.

getFilePropertiesAsync(callback)

Получает свойства текущего документа.

getFilePropertiesAsync(callback?: (result: AsyncResult<Office.FileProperties>) => void): void;

Параметры

callback

(result: Office.AsyncResult<Office.FileProperties>) => void

Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата являются свойства value файла (с URL-адресом, найденным в asyncResult.value.url).

Возвращаемое значение

void

Комментарии

Наборы требований. Не в наборе

Вы получаете URL-адрес файла с свойством URL-адреса asyncResult.value.url.

Примеры

// To read the URL of the current file, you need to write a callback function that returns the URL.
// The following example shows how to:
// 1. Pass an anonymous callback function that returns the value of the file's URL
//    to the callback parameter of the getFilePropertiesAsync method.
// 2. Display the value on the add-in's page.
function getFileUrl() {
    // Get the URL of the current file.
    Office.context.document.getFilePropertiesAsync(function (asyncResult) {
        var fileUrl = asyncResult.value.url;
        if (fileUrl == "") {
            showMessage("The file hasn't been saved yet. Save the file and try again");
        }
        else {
            showMessage(fileUrl);
        }
    });
}

getMaxResourceIndexAsync(options, callback)

Только документы проекта. Получите максимальный индекс коллекции ресурсов в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxResourceIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<number>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является наивысшее число индексов в коллекции ресурсов value текущего проекта.

Возвращаемое значение

void

getMaxResourceIndexAsync(callback)

Только документы проекта. Получите максимальный индекс коллекции ресурсов в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxResourceIndexAsync(callback?: (result: AsyncResult<number>) => void): void;

Параметры

callback

(result: Office.AsyncResult<number>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является наивысшее число индексов в коллекции ресурсов value текущего проекта.

Возвращаемое значение

void

Примеры

// The following code example calls getResourceTaskIndexAsync to get the maximum index of the collection 
// of resources in the current project. Then it uses the returned value and the getResourceByIndexAsync
// method to get each resource GUID. The example assumes that your add-in has a reference to the 
// jQuery library and that the following page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";
    var resourceGuids = ;

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#get-info').click(getResourceInfo);
        });
    };

    // Get the maximum resource index, and then get the resource GUIDs.
    function getResourceInfo() {
        getMaxResourceIndex().then(
            function (data) {
                getResourceGuids(data);
            }
        );
    }

    // Get the maximum index of the resources for the current project.
    function getMaxResourceIndex() {
        var defer = $.Deferred();
        Office.context.document.getMaxResourceIndexAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get each resource GUID, and then display the GUIDs in the add-in.
    // There is no 0 index for resources, so start with index 1.
    function getResourceGuids(maxResourceIndex) {
        var defer = $.Deferred();
        for (var i = 1; i <= maxResourceIndex; i++) {
            getResourceGuid(i);
        }
        return defer.promise();
        function getResourceGuid(index) {
            Office.context.document.getResourceByIndexAsync(index,
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        resourceGuids.push(result.value);
                        if (index == maxResourceIndex) {
                            defer.resolve();
                            $('#message').html(resourceGuids.toString());
                        }
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
    }
    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getMaxTaskIndexAsync(options, callback)

Только документы проекта. Получите максимальный индекс коллекции задач в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxTaskIndexAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<number>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<number>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является самое высокое число индексов в текущем value наборе задач проекта.

Возвращаемое значение

void

getMaxTaskIndexAsync(callback)

Только документы проекта. Получите максимальный индекс коллекции задач в текущем проекте.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getMaxTaskIndexAsync(callback?: (result: AsyncResult<number>) => void): void;

Параметры

callback

(result: Office.AsyncResult<number>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является самое высокое число индексов в текущем value наборе задач проекта.

Возвращаемое значение

void

Примеры

// The following code example calls getMaxTaskIndexAsync to get the maximum index
// of the collection of tasks in the current project. Then it uses the returned value
// with the getTaskByIndexAsync method to get each task GUID.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";
    var taskGuids = ;

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#get-info').click(getTaskInfo);
        });
    };

    // Get the maximum task index, and then get the task GUIDs.
    function getTaskInfo() {
        getMaxTaskIndex().then(
            function (data) {
                getTaskGuids(data);
            }
        );
    }

    // Get the maximum index of the tasks for the current project.
    function getMaxTaskIndex() {
        var defer = $.Deferred();
        Office.context.document.getMaxTaskIndexAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get each task GUID, and then display the GUIDs in the add-in.
    function getTaskGuids(maxTaskIndex) {
        var defer = $.Deferred();
        for (var i = 0; i <= maxTaskIndex; i++) {
            getTaskGuid(i);
        }
        return defer.promise();
        function getTaskGuid(index) {
            Office.context.document.getTaskByIndexAsync(index,
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        taskGuids.push(result.value);
                        if (index == maxTaskIndex) {
                            defer.resolve();
                            $('#message').html(taskGuids.toString());
                        }
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
    }
    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getProjectFieldAsync(fieldId, options, callback)

Только документы проекта. Получить поле Project (Ex. ProjectWebAccessURL).

getProjectFieldAsync(fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

fieldId

number

Поля уровня проекта.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит свойство, которое представляет value значение fieldValue указанного поля.

Возвращаемое значение

void

getProjectFieldAsync(fieldId, callback)

Только документы проекта. Получить поле Project (Ex. ProjectWebAccessURL).

getProjectFieldAsync(fieldId: number, callback?: (result: AsyncResult<any>) => void): void;

Параметры

fieldId

number

Поля уровня проекта.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит свойство, которое представляет value значение fieldValue указанного поля.

Возвращаемое значение

void

Примеры

// The following code example gets the values of three specified fields for the active project, 
// and then displays the values in the add-in.
// The example calls getProjectFieldAsync recursively, after the previous call returns successfully.
// It also tracks the calls to determine when all calls are sent.
// The example assumes your add-in has a reference to the jQuery library and that the 
// following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // Get information for the active project.
            getProjectInformation();
        });
    };

    // Get the specified fields for the active project.
    function getProjectInformation() {
        var fields =
            [Office.ProjectProjectFields.Start, 
             Office.ProjectProjectFields.Finish, 
             Office.ProjectProjectFields.GUID];
        var fieldValues = ['Start: ', 'Finish: ', 'GUID: '];
        var index = 0; 
        getField();

        // Get each field, and then display the field values in the add-in.
        function getField() {
            if (index == fields.length) {
                var output = '';
                for (var i = 0; i < fieldValues.length; i++) {
                    output += fieldValues[i] + '<br />';
                }
                $('#message').html(output);
            }
            else {
                Office.context.document.getProjectFieldAsync(
                    fields[index],
                    function (result) {

                        // If the call is successful, get the field value and then get the next field.
                        if (result.status === Office.AsyncResultStatus.Succeeded) {
                            fieldValues[index] += result.value.fieldValue;
                            getField(index++);
                        }
                        else {
                            onError(result.error);
                        }
                    }
                );
            }
        }
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getResourceByIndexAsync(resourceIndex, options, callback)

Только документы проекта. Получите GUID ресурса с указанным индексом в коллекции ресурсов.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getResourceByIndexAsync(resourceIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Параметры

resourceIndex

number

Индекс ресурса в коллекции ресурсов для проекта.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

getResourceByIndexAsync(resourceIndex, callback)

Только документы проекта. Получите GUID ресурса с указанным индексом в коллекции ресурсов.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getResourceByIndexAsync(resourceIndex: number, callback?: (result: AsyncResult<string>) => void): void;

Параметры

resourceIndex

number

Индекс ресурса в коллекции ресурсов для проекта.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

Примеры

// The following code example calls getMaxResourceIndexAsync to get the maximum index in the project's resource
// collection, and then calls getResourceByIndexAsync to get the GUID for each resource.
// The example assumes that your add-in has a reference to the jQuery library and that the following 
// page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";
    var resourceGuids = ;

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#get-info').click(getResourceInfo);
        });
    };

    // Get the maximum resource index, and then get the resource GUIDs.
    function getResourceInfo() {
        getMaxResourceIndex().then(
            function (data) {
                getResourceGuids(data);
            }
        );
    }

    // Get the maximum index of the resources for the current project.
    function getMaxResourceIndex() {
        var defer = $.Deferred();
        Office.context.document.getMaxResourceIndexAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get each resource GUID, and then display the GUIDs in the add-in.
    // There is no 0 index for resources, so start with index 1.
    function getResourceGuids(maxResourceIndex) {
        var defer = $.Deferred();
        for (var i = 1; i <= maxResourceIndex; i++) {
            getResourceGuid(i);
        }
        return defer.promise();
        function getResourceGuid(index) {
            Office.context.document.getResourceByIndexAsync(index,
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        resourceGuids.push(result.value);
                        if (index == maxResourceIndex) {
                            defer.resolve();
                            $('#message').html(resourceGuids.toString());
                        }
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
    }
    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getResourceFieldAsync(resourceId, fieldId, options, callback)

Только документы проекта. Получите поле ресурсов для предоставленного имени ресурса. (Ex.ResourceName)

getResourceFieldAsync(resourceId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Параметры

resourceId

string

Строка или значение ИД ресурса.

fieldId

number

Поля ресурсов.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

getResourceFieldAsync(resourceId, fieldId, callback)

Только документы проекта. Получите поле ресурсов для предоставленного имени ресурса. (Ex.ResourceName)

getResourceFieldAsync(resourceId: string, fieldId: number, callback?: (result: AsyncResult<string>) => void): void;

Параметры

resourceId

string

Строка или значение ИД ресурса.

fieldId

number

Поля ресурсов.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedResourceAsync to get the GUID of the resource
// that's currently selected in a resource view. Then it gets three resource field values by calling 
// getResourceFieldAsync recursively.
// The example assumes your add-in has a reference to the jQuery library and that the following 
// page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getResourceInfo);
        });
    };

    // Get the GUID of the resource and then get the resource fields.
    function getResourceInfo() {
        getResourceGuid().then(
            function (data) {
                getResourceFields(data);
            }
        );
    }

    // Get the GUID of the selected resource.
    function getResourceGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get the specified fields for the selected resource.
    function getResourceFields(resourceGuid) {
        var targetFields =
            [Office.ProjectResourceFields.Name,
             Office.ProjectResourceFields.Units, 
             Office.ProjectResourceFields.BaseCalendar];
        var fieldValues = ['Name: ', 'Units: ', 'Base calendar: '];
        var index = 0; 
        getField();

        // Get each field, and then display the field values in the add-in.
        function getField() {
            if (index == targetFields.length) {
                var output = '';
                for (var i = 0; i < fieldValues.length; i++) {
                    output += fieldValues[i] + '<br />';
                }
                $('#message').html(output);
            }

            // If the call is successful, get the field value and then get the next field.
            else {
                Office.context.document.getResourceFieldAsync(
                    resourceGuid,
                    targetFields[index],
                    function (result) {
                        if (result.status === Office.AsyncResultStatus.Succeeded) {
                            fieldValues[index] += result.value.fieldValue;
                            getField(index++);
                        }
                        else {
                            onError(result.error);
                        }
                    }
                );
            }
        }
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getSelectedDataAsync(coercionType, options, callback)

Считывает данные в текущем выделенном фрагменте документа.

getSelectedDataAsync<T>(coercionType: Office.CoercionType, options?: GetSelectedDataOptions, callback?: (result: AsyncResult<T>) => void): void;

Параметры

coercionType
Office.CoercionType

Тип возвращаемой структуры данных. См. раздел замечания для поддерживаемых типов принуждения каждого хоста.

options
Office.GetSelectedDataOptions

Предоставляет параметры настройки возвращаемых данных и формата их формата.

callback

(result: Office.AsyncResult<T>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является данные в текущем выборе. Это возвращается в структуре данных или формате, заданном с помощью параметра coercionType. (Дополнительные сведения о приведении типов данных см. в разделе Замечания.)

Возвращаемое значение

void

Комментарии

Наборы требований:

  • HtmlCoercion (при использовании Office.CoercionType.Html)

  • MatrixCoercion (при использовании Office.CoercionType.Matrix)

  • OoxmlCoercion (при использовании Office.CoercionType.Ooxml)

  • Selection

  • TableCoercion (при использовании Office.CoercionType.Table)

  • TextCoercion (при использовании Office.CoercionType.Text)

В функции обратного вызова, которая передается методу getSelectedDataAsync, вы можете использовать свойства объекта AsyncResult для возврата следующих сведений.

Свойство Назначение
AsyncResult.value Всегда возвращает значение undefined, так как нет объекта или данных для извлечения.
AsyncResult.status Определяет, удалось ли выполнить операцию.
AsyncResult.error Доступ к объекту Error, который предоставляет сведения об ошибке, если операция завершилась неудачно.
AsyncResult.asyncContext Определяемый пользователем элемент любого типа, который возвращается в объекте AsyncResult без изменения.

Возможные значения для параметра Office.CoercionType различаются в зависимости от хоста.

Узел Поддерживаемое значение coercionType
Excel, PowerPoint, Project и Word `Office.CoercionType.Text` (строка)
Excel и Word `Office.CoercionType.Matrix` (массив массивов)
Excel и Word `Office.CoercionType.Table` (Объект TableData)
Word `Office.CoercionType.Html`
Word `Office.CoercionType.Ooxml` (Office Open XML)
PowerPoint в Интернете и Windows `Office.CoercionType.SlideRange`
Excel, PowerPoint и Word `Office.CoercionType.XmlSvg`

Примеры

// The following example uses the getSelectedDataAsync method of the Document object to retrieve the
// user's current selection as text, and then display it in the add-in's page.

// Display the user's current selection.
function showSelection() {
    Office.context.document.getSelectedDataAsync(
        "text",                        // coercionType
        {valueFormat: "unformatted",   // valueFormat
        filterType: "all"},            // filterType
        function (result) {            // callback
            var dataValue; 
            dataValue = result.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; 
}
// 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:
// 1. Pass an anonymous callback function that reads the value of the current selection
//    to the callback parameter of the getSelectedDataAsync method.
// 2. Read the selection as text, unformatted, and not filtered.
// 3. Display the value on the add-in's page.
function getText() {
    Office.context.document.getSelectedDataAsync(Office.CoercionType.Text, 
        { valueFormat: "unformatted", filterType: "all" },
        function (asyncResult) {
            var error = asyncResult.error;
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                write(error.name + ": " + 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; 
}
// The following code example gets the values of the selected cells. It uses the optional
// asyncContext parameter to pass some text to the callback function.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getSelectedText);
        });
    };

    // Get the text from the selected cells in the document, and display it in the add-in.
    function getSelectedText() {
        Office.context.document.getSelectedDataAsync(
            Office.CoercionType.Text,
            {asyncContext: 'Some related info'},
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var output = String.format(
                        'Selected text: {0}<br/>Passed info: {1}',
                        result.value, result.asyncContext);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getSelectedDataAsync(coercionType, callback)

Считывает данные в текущем выделенном фрагменте документа.

getSelectedDataAsync<T>(coercionType: Office.CoercionType, callback?: (result: AsyncResult<T>) => void): void;

Параметры

coercionType
Office.CoercionType

Тип возвращаемой структуры данных. См. раздел замечания для поддерживаемых типов принуждения каждого хоста.

callback

(result: Office.AsyncResult<T>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является данные в текущем выборе. Это возвращается в структуре данных или формате, заданном с помощью параметра coercionType. (Дополнительные сведения о приведении типов данных см. в разделе Замечания.)

Возвращаемое значение

void

Комментарии

Наборы требований:

  • HtmlCoercion (при использовании Office.CoercionType.Html)

  • MatrixCoercion (при использовании Office.CoercionType.Matrix)

  • OoxmlCoercion (при использовании Office.CoercionType.Ooxml)

  • Selection

  • TableCoercion (при использовании Office.CoercionType.Table)

  • TextCoercion (при использовании Office.CoercionType.Text)

В функции обратного вызова, которая передается методу getSelectedDataAsync, вы можете использовать свойства объекта AsyncResult для возврата следующих сведений.

Свойство Назначение
AsyncResult.value Всегда возвращает значение undefined, так как нет объекта или данных для извлечения.
AsyncResult.status Определяет, удалось ли выполнить операцию.
AsyncResult.error Доступ к объекту Error, который предоставляет сведения об ошибке, если операция завершилась неудачно.
AsyncResult.asyncContext Определяемый пользователем элемент любого типа, который возвращается в объекте AsyncResult без изменения.

Возможные значения для параметра Office.CoercionType различаются в зависимости от хоста.

Узел Поддерживаемое значение coercionType
Excel, PowerPoint, Project и Word `Office.CoercionType.Text` (строка)
Excel и Word `Office.CoercionType.Matrix` (массив массивов)
Excel и Word `Office.CoercionType.Table` (Объект TableData)
Word `Office.CoercionType.Html`
Word `Office.CoercionType.Ooxml` (Office Open XML)
PowerPoint в Интернете и Windows `Office.CoercionType.SlideRange`
Excel, PowerPoint и Word `Office.CoercionType.XmlSvg`

getSelectedResourceAsync(options, callback)

Только документы проекта. Получите текущий выбранный ИД ресурса.

getSelectedResourceAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

getSelectedResourceAsync(callback)

Только документы проекта. Получите текущий выбранный ИД ресурса.

getSelectedResourceAsync(callback?: (result: AsyncResult<string>) => void): void;

Параметры

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedResourceAsync to get the GUID of the resource that's 
// currently selected in a resource view. Then it gets three resource field values by calling 
// getResourceFieldAsync recursively.
// The example assumes your add-in has a reference to the jQuery library and that the following page controls are
// defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getResourceInfo);
        });
    };

    // Get the GUID of the resource and then get the resource fields.
    function getResourceInfo() {
        getResourceGuid().then(
            function (data) {
                getResourceFields(data);
            }
        );
    }

    // Get the GUID of the selected resource.
    function getResourceGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get the specified fields for the selected resource.
    function getResourceFields(resourceGuid) {
        var targetFields =
            [Office.ProjectResourceFields.Name,
             Office.ProjectResourceFields.Units, 
             Office.ProjectResourceFields.BaseCalendar];
        var fieldValues = ['Name: ', 'Units: ', 'Base calendar: '];
        var index = 0; 
        getField();

        // Get each field, and then display the field values in the add-in.
        function getField() {
            if (index == targetFields.length) {
                var output = '';
                for (var i = 0; i < fieldValues.length; i++) {
                    output += fieldValues[i] + '<br />';
                }
                $('#message').html(output);
            }

            // If the call is successful, get the field value and then get the next field.
            else {
                Office.context.document.getResourceFieldAsync(
                    resourceGuid,
                    targetFields[index],
                    function (result) {
                        if (result.status === Office.AsyncResultStatus.Succeeded) {
                            fieldValues[index] += result.value.fieldValue;
                            getField(index++);
                        }
                        else {
                            onError(result.error);
                        }
                    }
                );
            }
        }
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getSelectedTaskAsync(options, callback)

Только документы проекта. Получите текущий выбранный Id задачи.

getSelectedTaskAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

getSelectedTaskAsync(callback)

Только документы проекта. Получите текущий выбранный Id задачи.

getSelectedTaskAsync(callback?: (result: AsyncResult<string>) => void): void;

Параметры

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством результата является GUID ресурса value в качестве строки.

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedTaskAsync to get the GUID of the task that's currently
// selected in a task view. Then it gets task properties by calling getTaskAsync.
// The example assumes your add-in has a reference to the jQuery library and that the following page
// controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getTaskInfo);
        });
    };

    // // Get the GUID of the task, and then get local task properties.
    function getTaskInfo() {
        getTaskGuid().then(
            function (data) {
                getTaskProperties(data);
            }
        );
    }

    // Get the GUID of the selected task.
    function getTaskGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedTaskAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get local properties for the selected task, and then display it in the add-in.
    function getTaskProperties(taskGuid) {
        Office.context.document.getTaskAsync(
            taskGuid,
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var taskInfo = result.value;
                    var output = String.format(
                        'Name: {0}<br/>GUID: {1}<br/>SharePoint task ID: {2}<br/>Resource names: {3}',
                        taskInfo.taskName, taskGuid, taskInfo.wssTaskId, taskInfo.resourceNames);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getSelectedViewAsync(options, callback)

Только документы проекта. Получите текущий выбранный тип представления (Ex. Gantt) и Имя представления.

getSelectedViewAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит следующие свойства: — имя представления, как value viewName константа ProjectViewTypes. viewType - Тип представления, как многообразное значение константы ProjectViewTypes.

Возвращаемое значение

void

getSelectedViewAsync(callback)

Только документы проекта. Получите текущий выбранный тип представления (Ex. Gantt) и Имя представления.

getSelectedViewAsync(callback?: (result: AsyncResult<any>) => void): void;

Параметры

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит следующие свойства: — имя представления, как value viewName константа ProjectViewTypes. viewType - Тип представления, как многообразное значение константы ProjectViewTypes.

Возвращаемое значение

void

Примеры

// The following code example calls adds a ViewSelectionChanged event handler that
// calls getSelectedViewAsync to get the name and type of the active view in the document.
// The example assumes your add-in has a reference to the jQuery library and that
// the following page control is defined in the content div in the page body:
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.ViewSelectionChanged,
                getActiveView);
            getActiveView();
        });
    };

    // Get the active view's name and type.
    function getActiveView() {
        Office.context.document.getSelectedViewAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var output = String.format(
                        'View name: {0}<br/>View type: {1}',
                        result.value.viewName, viewType);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getTaskAsync(taskId, options, callback)

Только документы проекта. Получите имя задачи, Windows SharePoint Services задач и имена ресурсов для данного taskId.

getTaskAsync(taskId: string, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство value результата содержит следующие свойства: taskName — имя задачи. wssTaskId - ID задачи в синхронизированном списке задач SharePoint. Если проект не синхронизирован со списком задач, значение будет 0. resourceNames - Разделенный запятой список имен ресурсов, которые назначены для задачи.

Возвращаемое значение

void

getTaskAsync(taskId, callback)

Только документы проекта. Получите имя задачи, Windows SharePoint Services задач и имена ресурсов для данного taskId.

getTaskAsync(taskId: string, callback?: (result: AsyncResult<any>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство value результата содержит следующие свойства: taskName — имя задачи. wssTaskId - ID задачи в синхронизированном списке задач SharePoint. Если проект не синхронизирован со списком задач, значение будет 0. resourceNames - Разделенный запятой список имен ресурсов, которые назначены для задачи.

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedTaskAsync to get the task GUID of the currently
// selected task. Then it calls getTaskAsync to get the properties for the task that are
// available from the JavaScript API for Office.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getTaskInfo);
        });
    };

    // Get the GUID of the task, and then get local task properties.
    function getTaskInfo() {
        getTaskGuid().then(
            function (data) {
                getTaskProperties(data);
            }
        );
    }

    // Get the GUID of the selected task.
    function getTaskGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedTaskAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get local properties for the selected task, and then display it in the add-in.
    function getTaskProperties(taskGuid) {
        Office.context.document.getTaskAsync(
            taskGuid,
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    var taskInfo = result.value;
                    var output = String.format(
                        'Name: {0}<br/>GUID: {1}<br/>SharePoint task ID: {2}<br/>Resource names: {3}',
                        taskInfo.taskName, taskGuid, taskInfo.wssTaskId, taskInfo.resourceNames);
                    $('#message').html(output);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getTaskByIndexAsync(taskIndex, options, callback)

Только документы проекта. Получите GUID задачи с указанным индексом в коллекции задач.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getTaskByIndexAsync(taskIndex: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<string>) => void): void;

Параметры

taskIndex

number

Индекс задачи в коллекции задач для проекта.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является GUID задачи в качестве строки.

Возвращаемое значение

void

getTaskByIndexAsync(taskIndex, callback)

Только документы проекта. Получите GUID задачи с указанным индексом в коллекции задач.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

getTaskByIndexAsync(taskIndex: number, callback?: (result: AsyncResult<string>) => void): void;

Параметры

taskIndex

number

Индекс задачи в коллекции задач для проекта.

callback

(result: Office.AsyncResult<string>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является GUID задачи в качестве строки.

Возвращаемое значение

void

Примеры

// The following code example calls getMaxTaskIndexAsync to get the
// maximum index in the project's task collection, and then
// calls getTaskByIndexAsync to get the GUID for each task.
// The example assumes that your add-in has a reference to the
// jQuery library and that the following page controls are defined
// in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";
    var taskGuids = ;

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#get-info').click(getTaskInfo);
        });
    };

    // Get the maximum task index, and then get the task GUIDs.
    function getTaskInfo() {
        getMaxTaskIndex().then(
            function (data) {
                getTaskGuids(data);
            }
        );
    }

    // Get the maximum index of the tasks for the current project.
    function getMaxTaskIndex() {
        var defer = $.Deferred();
        Office.context.document.getMaxTaskIndexAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get each task GUID, and then display the GUIDs in the add-in.
    function getTaskGuids(maxTaskIndex) {
        var defer = $.Deferred();
        for (var i = 0; i <= maxTaskIndex; i++) {
            getTaskGuid(i);
        }
        return defer.promise();
        function getTaskGuid(index) {
            Office.context.document.getTaskByIndexAsync(index,
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        taskGuids.push(result.value);
                        if (index == maxTaskIndex) {
                            defer.resolve();
                            $('#message').html(taskGuids.toString());
                        }
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
    }
    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getTaskFieldAsync(taskId, fieldId, options, callback)

Только документы проекта. Получите поле задач для предоставленного ID задачи. (Ex. StartDate).

getTaskFieldAsync(taskId: string, fieldId: number, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

fieldId

number

Поля задач.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит свойство, которое представляет value значение fieldValue указанного поля.

Возвращаемое значение

void

getTaskFieldAsync(taskId, fieldId, callback)

Только документы проекта. Получите поле задач для предоставленного ID задачи. (Ex. StartDate).

getTaskFieldAsync(taskId: string, fieldId: number, callback?: (result: AsyncResult<any>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

fieldId

number

Поля задач.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит свойство, которое представляет value значение fieldValue указанного поля.

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedTaskAsync to get the GUID of the task that's currently
// selected in a task view. Then it gets two task field values by calling getTaskFieldAsync recursively.
// The example assumes your add-in has a reference to the jQuery library and that the following page
// controls are defined in the content div in the page body:
// <input id="get-info" type="button" value="Get info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {
            
            // After the DOM is loaded, add-in-specific code can run.
            $('#get-info').click(getTaskInfo);
        });
    };

    // Get the GUID of the task, and then get the task fields.
    function getTaskInfo() {
        getTaskGuid().then(
            function (data) {
                getTaskFields(data);
            }
        );
    }

    // Get the GUID of the selected task.
    function getTaskGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedTaskAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Get the specified fields for the selected task.
    function getTaskFields(taskGuid) {
        var output = '';
        var targetFields = [Office.ProjectTaskFields.Priority, Office.ProjectTaskFields.PercentComplete];
        var fieldValues = ['Priority: ', '% Complete: '];
        var index = 0;
        getField();

        // Get each field, and then display the field values in the add-in.
        function getField() {
            if (index == targetFields.length) {
                for (var i = 0; i < fieldValues.length; i++) {
                    output += fieldValues[i] + '<br />';
                }
                $('#message').html(output);
            }

            // Get the field value. If the call is successful, then get the next field.
            else {
                Office.context.document.getTaskFieldAsync(
                    taskGuid,
                    targetFields[index],
                    function (result) {
                        if (result.status === Office.AsyncResultStatus.Succeeded) {
                            fieldValues[index] += result.value.fieldValue;
                            getField(index++);
                        }
                        else {
                            onError(result.error);
                        }
                    }
                );
            }
        }
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

getWSSUrlAsync(options, callback)

Только документы проекта. Получите Windows SharePoint Services url и имя списка для списка задач, MPP также синхронизирован.

getWSSUrlAsync(options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит следующие свойства: — имя синхронизированного списка value listName задач SharePoint. serverUrl — URL-адрес синхронизированного списка задач SharePoint.

Возвращаемое значение

void

getWSSUrlAsync(callback)

Только документы проекта. Получите Windows SharePoint Services url и имя списка для списка задач, MPP также синхронизирован.

getWSSUrlAsync(callback?: (result: AsyncResult<any>) => void): void;

Параметры

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство результата содержит следующие свойства: — имя синхронизированного списка value listName задач SharePoint. serverUrl — URL-адрес синхронизированного списка задач SharePoint.

Возвращаемое значение

void

goToByIdAsync(id, goToType, options, callback)

Переходит к указанному объекту или месту в документе.

goToByIdAsync(id: string | number, goToType: GoToType, options?: GoToByIdOptions, callback?: (result: AsyncResult<any>) => void): void;

Параметры

id

string | number

Идентификатор объекта или расположения для перехода.

goToType
Office.GoToType

Тип расположения, к которому выполняется переход.

options
Office.GoToByIdOptions

Предоставляет параметры выбора местоположения, на которое навигатор.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является текущее представление.

Возвращаемое значение

void

Комментарии

Набор требований. Не в наборе

PowerPoint не поддерживает метод goToByIdAsync в мастер-представлениях.

Поведение, вызываемое параметром selectionMode, зависит от хоста:

В Excel: Office.SelectionMode.Selected выбирает все содержимое в привязке или с именем элемента. Office.SelectionMode.None для привязок к тексту выбирает ячейку; для привязок к матрицам, таблицам и именованных элементов — выбирает первую ячейку с данными (а не первую ячейку в столбце заготовка таблицы).

В PowerPoint: Office.SelectionMode.Selected выберите название слайда или первый текстовый ящик на слайде. Office.SelectionMode.None ничего не выбирает.

В Word: Office.SelectionMode.Selected выбирает все содержимое в привязке. Office.SelectionMode.None для текстовых привязок перемещает указатель в начало текста, а для привязок к матрицам и таблицам выбирает первую ячейку с данными (а не первую ячейку строки заголовка таблицы).

goToByIdAsync(id, goToType, callback)

Переходит к указанному объекту или месту в документе.

goToByIdAsync(id: string | number, goToType: GoToType, callback?: (result: AsyncResult<any>) => void): void;

Параметры

id

string | number

Идентификатор объекта или расположения для перехода.

goToType
Office.GoToType

Тип расположения, к которому выполняется переход.

callback

(result: Office.AsyncResult<any>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойством value результата является текущее представление.

Возвращаемое значение

void

Комментарии

Набор требований. Не в наборе

PowerPoint не поддерживает метод goToByIdAsync в мастер-представлениях.

Поведение, вызываемое параметром selectionMode, зависит от хоста:

В Excel: Office.SelectionMode.Selected выбирает все содержимое в привязке или с именем элемента. Office.SelectionMode.None для привязок к тексту выбирает ячейку; для привязок к матрицам, таблицам и именованных элементов — выбирает первую ячейку с данными (а не первую ячейку в столбце заготовка таблицы).

В PowerPoint: Office.SelectionMode.Selected выберите название слайда или первый текстовый ящик на слайде. Office.SelectionMode.None ничего не выбирает.

В Word: Office.SelectionMode.Selected выбирает все содержимое в привязке. Office.SelectionMode.None для текстовых привязок перемещает указатель в начало текста, а для привязок к матрицам и таблицам выбирает первую ячейку с данными (а не первую ячейку строки заголовка таблицы).

Примеры

// Go to a binding by id (Word and Excel)
// The following example shows how to:
// 1. Create a table binding using the addFromSelectionAsync method as a sample binding to work with.
// 2. Specify that binding as the binding to go to.
// 3. Pass an anonymous callback function that returns the status of the operation
//    to the callback parameter of the goToByIdAsync method.
// 4. Display the value on the add-in's page.
function gotoBinding() {
    // Create a new table binding for the selected table.
    Office.context.document.bindings.addFromSelectionAsync("table",{ id: "MyTableBinding" }, function (asyncResult) {
    if (asyncResult.status == "failed") {
              showMessage("Action failed with error: " + asyncResult.error.message);
          }
          else {
              showMessage("Added new binding with type: " + asyncResult.value.type +" and id: " + asyncResult.value.id);
          }
    });

    // Go to binding by id.
    Office.context.document.goToByIdAsync("MyTableBinding", Office.GoToType.Binding, function (asyncResult) {
        if (asyncResult.status == "failed") {
            showMessage("Action failed with error: " + asyncResult.error.message);
        }
        else {
            showMessage("Navigation successful");
        }
    });
}

// Go to a table in a spreadsheet (Excel)
// The following example shows how to:
// 1. Specify a table by name as the table to go to.
// 2. Pass an anonymous callback function that returns the status of the operation
//    to the callback parameter of the goToByIdAsync method.
// 3. Display the value on the add-in's page.
function goToTable() {
    Office.context.document.goToByIdAsync("Table1", Office.GoToType.NamedItem, function (asyncResult) {
        if (asyncResult.status == "failed") {
            showMessage("Action failed with error: " + asyncResult.error.message);
        }
        else {
            showMessage("Navigation successful");
        }
    });
}

// Go to the currently selected slide by id (PowerPoint)
// The following example shows how to:
// 1. Get the id of the currently selected slides using the getSelectedDataAsync method.
// 2. Specify the returned id as the slide to go to.
// 3. Pass an anonymous callback function that returns the status of the operation
//    to the callback parameter of the goToByIdAsync method.
// 4. Display the value of the stringified JSON object returned by asyncResult.value,
//    which contains information about the selected slides, on the add-in's page.
var firstSlideId = 0;
function gotoSelectedSlide() {
    //Get currently selected slide's id
    Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, function (asyncResult) {
        if (asyncResult.status == "failed") {
            app.showNotification("Action failed with error: " + asyncResult.error.message);
        }
        else {
            firstSlideId = asyncResult.value.slides[0].id;
            app.showNotification(JSON.stringify(asyncResult.value));
        }
    });
    //Go to slide by id.
    Office.context.document.goToByIdAsync(firstSlideId, Office.GoToType.Slide, function (asyncResult) {
        if (asyncResult.status == "failed") {
            app.showNotification("Action failed with error: " + asyncResult.error.message);
        }
        else {
            app.showNotification("Navigation successful");
        }
    });
}

// Go to slide by index (PowerPoint)
// The following example shows how to:
// 1. Specify the index of the first, last, previous, or next slide to go to.
// 2. Pass an anonymous callback function that returns the status of the operation
//    to the callback parameter of the goToByIdAsync method.
// 3. Display the value on the add-in's page.
function goToSlideByIndex() {
    var goToFirst = Office.Index.First;
    var goToLast = Office.Index.Last;
    var goToPrevious = Office.Index.Previous;
    var goToNext = Office.Index.Next;

    Office.context.document.goToByIdAsync(goToNext, Office.GoToType.Index, function (asyncResult) {
        if (asyncResult.status == "failed") {
            showMessage("Action failed with error: " + asyncResult.error.message);
        }
        else {
            showMessage("Navigation successful");
        }
    });
}

removeHandlerAsync(eventType, options, callback)

Удаляет обработник событий для указанного типа событий.

removeHandlerAsync(eventType: Office.EventType, options?: RemoveHandlerOptions, callback?: (result: AsyncResult<void>) => void): void;

Параметры

eventType
Office.EventType

Тип события. Для документа можно использовать "Document.SelectionChanged" или "Document.ActiveViewChanged".

options
Office.RemoveHandlerOptions

Предоставляет параметры, чтобы определить, какой обработчик событий или обработчики удалены.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Комментарии

Набор требований: DocumentEvents

removeHandlerAsync(eventType, callback)

Удаляет обработник событий для указанного типа событий.

removeHandlerAsync(eventType: Office.EventType, callback?: (result: AsyncResult<void>) => void): void;

Параметры

eventType
Office.EventType

Тип события. Для документа можно использовать "Document.SelectionChanged" или "Document.ActiveViewChanged".

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Комментарии

Набор требований: DocumentEvents

Примеры

// The following example removes the event handler named 'MyHandler'.
function removeSelectionChangedEventHandler() {
    Office.context.document.removeHandlerAsync(Office.EventType.DocumentSelectionChanged, {handler:MyHandler});
}

function MyHandler(eventArgs) {
    doSomethingWithDocument(eventArgs.document);
}
// The following code example uses addHandlerAsync to add an event handler for the
// ResourceSelectionChanged event and removeHandlerAsync to remove the handler.
// When a resource is selected in a resource view, the handler displays the
// resource GUID. When the handler is removed, the GUID is not displayed.
// The example assumes that your add-in has a reference to the jQuery library and
// that the following page control is defined in the content div in the page body:
// <input id="remove-handler" type="button" value="Remove handler" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            Office.context.document.addHandlerAsync(
                Office.EventType.ResourceSelectionChanged,
                getResourceGuid);
            $('#remove-handler').click(removeEventHandler);
        });
    };

    // Remove the event handler.
    function removeEventHandler() {
        Office.context.document.removeHandlerAsync(
            Office.EventType.ResourceSelectionChanged,
            {handler:getResourceGuid,
            asyncContext:'The handler is removed.'},
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    $('#remove-handler').attr('disabled', 'disabled');
                    $('#message').html(result.asyncContext);
                }
            }
        );
    }

    // Get the GUID of the currently selected resource and display it in the add-in.
    function getResourceGuid() {
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    $('#message').html('Resource GUID: ' + result.value);
                }
            }
        );
    }

    function onError(error) {
        $('#message').html(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

setResourceFieldAsync(resourceId, fieldId, fieldValue, options, callback)

Только документы проекта. Установите поле ресурсов для указанного ИД ресурса.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Параметры

resourceId

string

Строка или значение ИД ресурса.

fieldId

number

Поля ресурсов.

fieldValue

string | number | boolean | object

Значение целевого поля.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

setResourceFieldAsync(resourceId, fieldId, fieldValue, callback)

Только документы проекта. Установите поле ресурсов для указанного ИД ресурса.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setResourceFieldAsync(resourceId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;

Параметры

resourceId

string

Строка или значение ИД ресурса.

fieldId

number

Поля ресурсов.

fieldValue

string | number | boolean | object

Значение целевого поля.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedResourceAsync to get the GUID of the resource that's
// currently selected in a resource view. Then it sets two resource field values by calling
// setResourceFieldAsync recursively.
// The getSelectedTaskAsync method used in the example requires that a task view
// (for example, Task Usage) is the active view and that a task is selected. See the addHandlerAsync
// method for an example that activates a button based on the active view type.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page controls are defined in the content div in the page body:
// <input id="set-info" type="button" value="Set info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {

            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#set-info').click(setResourceInfo);
        });
    };

    // Get the GUID of the resource, and then get the resource fields.
    function setResourceInfo() {
        getResourceGuid().then(
            function (data) {
                setResourceFields(data);
            }
        );
    }

    // Get the GUID of the selected resource.
    function getResourceGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedResourceAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Set the specified fields for the selected resource.
    function setResourceFields(resourceGuid) {
        var targetFields = [Office.ProjectResourceFields.StandardRate, Office.ProjectResourceFields.Notes];
        var fieldValues = [.28, 'Notes for the resource.'];

        // Set the field value. If the call is successful, set the next field.
        for (var i = 0; i < targetFields.length; i++) {
            Office.context.document.setResourceFieldAsync(
                resourceGuid,
                targetFields[i],
                fieldValues[i],
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        i++;
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
        $('#message').html('Field values set');
    }

    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();

setSelectedDataAsync(data, options, callback)

Записывает указанные данные в текущий выбор.

setSelectedDataAsync(data: string | TableData | any[][], options?: SetSelectedDataOptions, callback?: (result: AsyncResult<void>) => void): void;

Параметры

data

string | Office.TableData | any[][]

Данные, которые необходимо установить. Либо строка, либо значение Office.CoercionType, 2d-массив или объект TableData.

Если передано data значение:

  • Строка. Записывается обычный текст или другие данные, которые могут быть приведены к типу string. В Excel можно также указать данные в качестве допустимой формулы, чтобы добавить эту формулу в выбранную ячейку. Например, если для data указать "=SUM(A1:A5)", будут получены итоговые значения в указанном диапазоне. Если задать формулу в связанной ячейке, добавленную (или существующую) формулу в этой ячейке будет невозможно считать. При вызове метода Document.getSelectedDataAsync в выделенной ячейке для считывания ее данных этот метод может возвращать только данные, отображаемые в ячейке (результат формулы).

  • Массив массивов ("matrix"). Будут вставлены табличные данные без заголовков. Например, для записи данных в три строки в двух столбцах можно передать массив, похожий на этот: [ [ "R1C1", ] "R1C2", [ "R2C1", ] [ "R2C2", "R3C1", "R3C2". ] ] Чтобы написать один столбец из трех строк, передай такой массив: [ [ "R1C1", ] [ "R2C1", ] [ "R3C1"]]

В Excel вы также можете указать data как массив массивов, содержащих допустимые формулы, чтобы добавить их в выбранные ячейки. Например, если другие данные не будут перезаписаны, в выбор будут добавлены эти две [ [ ] ] формулы. Как и при указании формулы в одной ячейке в текстовом виде, добавленные (или существующие) формулы невозможно считывать после того, как они заданы. Вы можете считывать только результаты формул.

  • Объект TableData Вставляются табличные данные с заголовками. Если вы укажете в Excel формулы в объекте TableData, который вы передаете для параметра data, вы можете не получить ожидаемые результаты, потому что функция "вычисляемые столбцы" Excel автоматически копирует формулы в столбце. Чтобы обойти это, если необходимо написать формулы в выбранную таблицу, попробуйте указать данные в качестве массива массивов (вместо объекта TableData) и указать принуждениеType как data Microsoft.Office.Matrix или "матрица". Однако этот метод блокирует функцию "вычислимые столбцы" только при одном из следующих условий: (1) вы записываете все ячейки столбца, или (2) в столбце уже есть по крайней мере две разные формулы.
options
Office.SetSelectedDataOptions

Предоставляет варианты вставки данных в выбор.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство AsyncResult.value всегда возвращается неопределяемо, так как нет объекта или данных для получения.

Возвращаемое значение

void

Комментарии

Наборы требований:

  • HtmlCoercion, (при использовании Office.CoercionType.Html)

  • ImageCoercion 1.1 (при использовании Office.CoercionType.Image)

  • MatrixCoercion (при использовании Office.CoercionType.Matrix)

  • OoxmlCoercion (при использовании Office.CoercionType.Ooxml)

  • Selection

  • TableCoercion (при использовании Office.CoercionType.Table)

  • TextCoercion (при использовании Office.CoercionType.Text)

  • ImageCoercion 1.2 (при использовании Office.CoercionType.XmlSvg)

Поведение, связанное с определенными приложениями

При написании данных к выбору применяются следующие действия, применимые к конкретным приложениям.

Word Если нет выбора и точка вставки находится в допустимом расположении, указанное вставляется в точку `data` вставки Если `data` строка, указанный текст вставляется.
Если `data` это массив массивов ("матрица") или объект TableData, вставляется новая таблица Word.
Если `data` ЭТО HTML, указанный HTML вставляется. (**Важно.** Если какой-либо из вставляемого HTML является недействительным, Word не вызывает ошибку. Word будет вставлять как можно больше HTML и опустить все недействительные данные).
Если `data` это XML Office Open, указанный XML вставляется.
Если `data` это закодированный поток изображений base64, указанное изображение вставляется.
Если имеется выбор Он будет заменен указанными по тем `data` же правилам, что и выше.
Вставка изображений Вставленные изображения помещаются в линию. Параметры imageLeft и imageTop игнорируются. Пропорции изображения всегда блокируются. Если задан только параметр imageWidth или imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.
Excel Если выбрана одна ячейка Если `data` строка, указанный текст вставляется в качестве значения текущей ячейки.
Если массив массивов ("матрица"), указанный набор строк и столбцов вставляется, если никакие другие данные в соседних ячейках не будут `data` перезаписаны.
Если это объект TableData, вставляется новая таблица Excel с заданным набором строк и заглавных элементов, если никакие другие данные в соседних ячейках не будут `data` перезаписаны.
Если выбрано несколько ячеек If the shape does not match the shape of `data`, возвращается ошибка.
If the shape of the selection exactly matches the shape of `data`, значения выбранных ячеек обновляются на основе значений в `data`.
Вставка изображений Вставляются плавающие изображения. Параметры положения imageLeft и imageTop указываются относительно выделенных ячеек. Отрицательные значения imageLeft и imageTop допустимы и могут быть откорректированы Excel для размещения изображения в пределах листа. Пропорции изображения блокируются, если не указан каждый из параметров imageWidth и imageHeight. Если задан только параметр imageWidth или только параметр imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.
Все остальные случаи Возвращается ошибка.
Excel в Интернете Помимо поведения, описанного выше для Excel, эти ограничения применяются при записи данных в Excel в Интернете Общее число ячеек, которые можно записать на таблицу с параметром, не может превышать 20 000 за один вызов `data` этого метода.
Количество групп форматирования, переданных `cellFormat` параметру, не может превышать 100. Одна группа форматирования состоит из набора вариантов форматирования, применяемого к указанному диапазону ячеек.
PowerPoint Вставка изображения Вставляются плавающие изображения. Параметры imageLeft и imageTop являются необязательными, но при условии должны присутствовать оба параметра. Если указано одно значение, оно игнорируется. Отрицательные значения imageLeft и imageTop допустимы и позволяют разместить изображение за пределами слайда. Если не указано ни одного необязательного параметра, а слайд содержит заполнитель, изображение заменит заполнитель в слайде. Пропорции изображения блокируются, если не указан каждый из параметров imageWidth и imageHeight. Если задан только параметр imageWidth или только параметр imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.

Hosts

Возможные значения для параметра Office.CoercionType различаются в зависимости от хоста.

Узел Поддерживаемое значение coercionType
Excel, PowerPoint, Project и Word `Office.CoercionType.Text` (строка)
Excel и Word `Office.CoercionType.Matrix` (массив массивов)
Excel и Word `Office.CoercionType.Table` (Объект TableData)
Word `Office.CoercionType.Html`
Word `Office.CoercionType.Ooxml` (Office Open XML)
PowerPoint в Интернете и Windows `Office.CoercionType.SlideRange`
Excel, PowerPoint и Word `Office.CoercionType.XmlSvg`

Примеры

// The following example sets the selected text or cell to "Hello World!", 
// and if that fails, displays the value of the error.message property.
function writeText() {
    Office.context.document.setSelectedDataAsync("Hello World!",
        function (asyncResult) {
            var error = asyncResult.error;
            if (asyncResult.status === Office.AsyncResultStatus.Failed){
                write(error.name + ": " + error.message);
            }
        });
}

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

// Specifying the optional coercionType parameter lets you specify the kind of data you want to write
// to a selection. The following example writes data as an array of three rows of two columns, 
// specifying the coercionType as `Matrix` for that data structure, and if that fails, 
// displays the value of the error.message property.
function writeMatrix() {
    Office.context.document.setSelectedDataAsync(
        [["Red", "Rojo"], ["Green", "Verde"], ["Blue", "Azul"]],
        {coercionType: Office.CoercionType.Matrix}
        function (asyncResult) {
            var error = asyncResult.error;
            if (asyncResult.status === Office.AsyncResultStatus.Failed){
                write(error.name + ": " + error.message);
            }
        });
}

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

// The following example writes data as a one column table with a header and four rows, 
// specifying the coercionType as `Table` for that data structure, and if that fails, 
// displays the value of the error.message property.
function writeTable() {
    // Build table.
    var myTable = new Office.TableData();
    myTable.headers = [["Cities"]];
    myTable.rows = [['Berlin'], ['Roma'], ['Tokyo'], ['Seattle']];

    // Write table.
    Office.context.document.setSelectedDataAsync(myTable, {coercionType: Office.CoercionType.Table},
        function (result) {
            var error = result.error
            if (result.status === Office.AsyncResultStatus.Failed) {
                write(error.name + ": " + error.message);
            }
    });
}

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

// In Word if you want to write HTML to the selection, you can specify the coercionType parameter as `Html`
// as shown in the following example, which uses HTML <b> tags to make "Hello" bold.
function writeHtmlData() {
    Office.context.document.setSelectedDataAsync(
        "<b>Hello</b> World!", {coercionType: Office.CoercionType.Html}, function (asyncResult) {
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                write('Error: ' + asyncResult.error.message);
            }
    });
}

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

// In Word, PowerPoint, or Excel, if you want to write an image to the selection, you can specify the coercionType
// parameter as `Image` as shown in the following example. Note that imageLeft and imageTop are ignored by Word.
function insertPictureAtSelection(base64EncodedImageStr) {

    Office.context.document.setSelectedDataAsync(base64EncodedImageStr, {
        coercionType: Office.CoercionType.Image,
        imageLeft: 50,
        imageTop: 50,
        imageWidth: 100,
        imageHeight: 100
    },
    function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.log("Action failed with error: " + asyncResult.error.message);
        }
    });
}

// In Word, PowerPoint, or Excel, if you want to write an scalable vector graphic (SVG) to the selection, you can specify the 
// coercionType parameter as `XmlSvg` as shown in the following example. Note that imageLeft and imageTop are ignored by Word.
function insertSvgAtSelection(base64EncodedImageStr) {
    Office.context.document.setSelectedDataAsync(getImageAsBase64String(), {
        coercionType: Office.CoercionType.XmlSvg,
        imageLeft: 50,
        imageTop: 50,
        imageWidth: 400
    },
        function (asyncResult) {
            if (asyncResult.status === Office.AsyncResultStatus.Failed) {
                console.log(asyncResult.error.message);
            }
        });
}

setSelectedDataAsync(data, callback)

Записывает указанные данные в текущий выбор.

setSelectedDataAsync(data: string | TableData | any[][], callback?: (result: AsyncResult<void>) => void): void;

Параметры

data

string | Office.TableData | any[][]

Данные, которые необходимо установить. Либо строка, либо значение Office.CoercionType, 2d-массив или объект TableData.

Если передано data значение:

  • Строка. Записывается обычный текст или другие данные, которые могут быть приведены к типу string. В Excel можно также указать данные в качестве допустимой формулы, чтобы добавить эту формулу в выбранную ячейку. Например, если для data указать "=SUM(A1:A5)", будут получены итоговые значения в указанном диапазоне. Если задать формулу в связанной ячейке, добавленную (или существующую) формулу в этой ячейке будет невозможно считать. При вызове метода Document.getSelectedDataAsync в выделенной ячейке для считывания ее данных этот метод может возвращать только данные, отображаемые в ячейке (результат формулы).

  • Массив массивов ("matrix"). Будут вставлены табличные данные без заголовков. Например, для записи данных в три строки в двух столбцах можно передать массив, похожий на этот: [ [ "R1C1", ] "R1C2", [ "R2C1", ] [ "R2C2", "R3C1", "R3C2". ] ] Чтобы написать один столбец из трех строк, передай такой массив: [ [ "R1C1", ] [ "R2C1", ] [ "R3C1"]]

В Excel вы также можете указать data как массив массивов, содержащих допустимые формулы, чтобы добавить их в выбранные ячейки. Например, если другие данные не будут перезаписаны, в выбор будут добавлены эти две [ [ ] ] формулы. Как и при указании формулы в одной ячейке в текстовом виде, добавленные (или существующие) формулы невозможно считывать после того, как они заданы. Вы можете считывать только результаты формул.

  • Объект TableData Вставляются табличные данные с заголовками. Если вы укажете в Excel формулы в объекте TableData, который вы передаете для параметра data, вы можете не получить ожидаемые результаты, потому что функция "вычисляемые столбцы" Excel автоматически копирует формулы в столбце. Чтобы обойти это, если необходимо написать формулы в выбранную таблицу, попробуйте указать данные в качестве массива массивов (вместо объекта TableData) и указать принуждениеType как data Microsoft.Office.Matrix или "матрица". Однако этот метод блокирует функцию "вычислимые столбцы" только при одном из следующих условий: (1) вы записываете все ячейки столбца, или (2) в столбце уже есть по крайней мере две разные формулы.
callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult.. Свойство AsyncResult.value всегда возвращается неопределяемо, так как нет объекта или данных для получения.

Возвращаемое значение

void

Комментарии

Наборы требований:

  • HtmlCoercion, (при использовании Office.CoercionType.Html)

  • ImageCoercion (при использовании Office.CoercionType.Image)

  • MatrixCoercion (при использовании Office.CoercionType.Matrix)

  • OoxmlCoercion (при использовании Office.CoercionType.Ooxml)

  • Selection

  • TableCoercion (при использовании Office.CoercionType.Table)

  • TextCoercion (при использовании Office.CoercionType.Text)

  • ImageCoercion 1.2 (при использовании Office.CoercionType.XmlSvg)

Поведение, связанное с определенными приложениями

При написании данных к выбору применяются следующие действия, применимые к конкретным приложениям.

Word Если нет выбора и точка вставки находится в допустимом расположении, указанное вставляется в точку `data` вставки Если `data` строка, указанный текст вставляется.
Если `data` это массив массивов ("матрица") или объект TableData, вставляется новая таблица Word.
Если `data` ЭТО HTML, указанный HTML вставляется. (**Важно.** Если какой-либо из вставляемого HTML является недействительным, Word не вызывает ошибку. Word будет вставлять как можно больше HTML и опустить все недействительные данные).
Если `data` это XML Office Open, указанный XML вставляется.
Если `data` это закодированный поток изображений base64, указанное изображение вставляется.
Если имеется выбор Он будет заменен указанными по тем `data` же правилам, что и выше.
Вставка изображений Вставленные изображения помещаются в линию. Параметры imageLeft и imageTop игнорируются. Пропорции изображения всегда блокируются. Если задан только параметр imageWidth или imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.
Excel Если выбрана одна ячейка Если `data` строка, указанный текст вставляется в качестве значения текущей ячейки.
Если массив массивов ("матрица"), указанный набор строк и столбцов вставляется, если никакие другие данные в соседних ячейках не будут `data` перезаписаны.
Если это объект TableData, вставляется новая таблица Excel с заданным набором строк и заглавных элементов, если никакие другие данные в соседних ячейках не будут `data` перезаписаны.
Если выбрано несколько ячеекIf the shape does not match the shape of `data`, возвращается ошибка.
If the shape of the selection exactly matches the shape of `data`, значения выбранных ячеек обновляются на основе значений в `data`.
Вставка изображений Вставляются плавающие изображения. Параметры положения imageLeft и imageTop указываются относительно выделенных ячеек. Отрицательные значения imageLeft и imageTop допустимы и могут быть откорректированы Excel для размещения изображения в пределах листа. Пропорции изображения блокируются, если не указан каждый из параметров imageWidth и imageHeight. Если задан только параметр imageWidth или только параметр imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.
Все остальные случаи Возвращается ошибка.
Excel в Интернете Помимо поведения, описанного выше для Excel, эти ограничения применяются при записи данных в Excel в Интернете Общее число ячеек, которые можно записать на таблицу с параметром, не может превышать 20 000 за один вызов `data` этого метода.
Количество групп форматирования, переданных `cellFormat` параметру, не может превышать 100. Одна группа форматирования состоит из набора вариантов форматирования, применяемого к указанному диапазону ячеек.
PowerPoint Вставка изображения Вставляются плавающие изображения. Параметры imageLeft и imageTop являются необязательными, но при условии должны присутствовать оба параметра. Если указано одно значение, оно игнорируется. Отрицательные значения imageLeft и imageTop допустимы и позволяют разместить изображение за пределами слайда. Если не указано ни одного необязательного параметра, а слайд содержит заполнитель, изображение заменит заполнитель в слайде. Пропорции изображения блокируются, если не указан каждый из параметров imageWidth и imageHeight. Если задан только параметр imageWidth или только параметр imageHeight, второе значение будет подобрано автоматически с учетом исходных пропорций.

Hosts

Возможные значения для параметра Office.CoercionType различаются в зависимости от хоста.

Узел Поддерживаемое значение coercionType
Excel, PowerPoint, Project и Word `Office.CoercionType.Text` (строка)
Excel и Word `Office.CoercionType.Matrix` (массив массивов)
Excel и Word `Office.CoercionType.Table` (Объект TableData)
Word `Office.CoercionType.Html`
Word `Office.CoercionType.Ooxml` (Office Open XML)
PowerPoint в Интернете и Windows `Office.CoercionType.SlideRange`
Excel, PowerPoint и Word `Office.CoercionType.XmlSvg`

setTaskFieldAsync(taskId, fieldId, fieldValue, options, callback)

Только документы проекта. Задай поле задач для указанного id задачи.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, options?: Office.AsyncContextOptions, callback?: (result: AsyncResult<void>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

fieldId

number

Поля задач.

fieldValue

string | number | boolean | object

Значение целевого поля.

options
Office.AsyncContextOptions

Предоставляет возможность сохранения контекстных данных любого типа без изменений для использования в вызове.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

setTaskFieldAsync(taskId, fieldId, fieldValue, callback)

Только документы проекта. Задай поле задач для указанного id задачи.

Важно. Этот API работает только в Project 2016 на рабочем столе Windows.

setTaskFieldAsync(taskId: string, fieldId: number, fieldValue: string | number | boolean | object, callback?: (result: AsyncResult<void>) => void): void;

Параметры

taskId

string

Строка или значение ID задачи.

fieldId

number

Поля задач.

fieldValue

string | number | boolean | object

Значение целевого поля.

callback

(result: Office.AsyncResult<void>) => void

Необязательное свойство. Функция, вызываемая при возвращении обратного вызова, единственным параметром которой является тип Office.AsyncResult..

Возвращаемое значение

void

Примеры

// The following code example calls getSelectedTaskAsync to get the GUID of the task that's
// currently selected in a task view. Then it sets two task field values by calling
// setTaskFieldAsync recursively.
// The getSelectedTaskAsync method used in the example requires that a task view
// (for example, Task Usage) is the active view and that a task is selected. See the
// addHandlerAsync method for an example that activates a button based on the active view type.
// The example assumes your add-in has a reference to the jQuery library and that the
// following page controls are defined in the content div in the page body:
// <input id="set-info" type="button" value="Set info" /><br />
// <span id="message"></span>

(function () {
    "use strict";

    // The initialize function must be run each time a new page is loaded.
    Office.initialize = function (reason) {
        $(document).ready(function () {
            
            // After the DOM is loaded, add-in-specific code can run.
            app.initialize();
            $('#set-info').click(setTaskInfo);
        });
    };

    // Get the GUID of the task, and then get the task fields.
    function setTaskInfo() {
        getTaskGuid().then(
            function (data) {
                setTaskFields(data);
            }
        );
    }

    // Get the GUID of the selected task.
    function getTaskGuid() {
        var defer = $.Deferred();
        Office.context.document.getSelectedTaskAsync(
            function (result) {
                if (result.status === Office.AsyncResultStatus.Failed) {
                    onError(result.error);
                }
                else {
                    defer.resolve(result.value);
                }
            }
        );
        return defer.promise();
    }

    // Set the specified fields for the selected task.
    function setTaskFields(taskGuid) {
        var targetFields = [Office.ProjectTaskFields.Active, Office.ProjectTaskFields.Notes];
        var fieldValues = [true, 'Notes for the task.'];

        // Set the field value. If the call is successful, set the next field.
        for (var i = 0; i < targetFields.length; i++) {
            Office.context.document.setTaskFieldAsync(
                taskGuid,
                targetFields[i],
                fieldValues[i],
                function (result) {
                    if (result.status === Office.AsyncResultStatus.Succeeded) {
                        i++;
                    }
                    else {
                        onError(result.error);
                    }
                }
            );
        }
        $('#message').html('Field values set');
    }

    function onError(error) {
        app.showNotification(error.name + ' ' + error.code + ': ' + error.message);
    }
})();