Office.GoToByIdOptions interface

注釈

options.selectionMode オプションによって発生する動作は、Office アプリケーションによって異なります。

Excel の場合: Office.SelectionMode.Selected は、製本または名前付きアイテム内のすべてのコンテンツを選択します。 Office.SelectionMode.None テキスト バインドの場合は、セルを選択します。マトリックス バインディング、テーブル バインディング、および名前付きアイテムの場合、最初のデータ セル (テーブルのヘッダー行の最初のセルではない) を選択します。

PowerPoint の場合: Office.SelectionMode.Selected 、スライド タイトルまたはスライド上の最初のテキスト ボックスを選択します。 Office.SelectionMode.None では何も選択されません。

Word: Office.SelectionMode.Selected は、バインド内のすべてのコンテンツを選択します。 Office.SelectionMode.None テキスト バインディングの場合は、カーソルをテキストの先頭に移動します。マトリックス バインディングとテーブル バインディングで、最初のデータ セルを選択します (テーブルのヘッダー行の最初のセルではありません)。

使用元

• Office.Document: goToByIdAsync

例

// 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(Office.BindingType.Table, { id: "MyTableBinding" }, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error("Action failed with error: " + asyncResult.error.message);
        } else {
            console.log("Added new binding with type: " + asyncResult.value.type + " and ID: " + asyncResult.value.id);
        }
    });

    // Go to binding by ID, setting option to ensure entire binding is selected.
    let goToByIdOptions: Office.GoToByIdOptions = {
        selectionMode: Office.SelectionMode.Selected
    };
    Office.context.document.goToByIdAsync("MyTableBinding", Office.GoToType.Binding, goToByIdOptions, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error("Action failed with error: " + asyncResult.error.message);
        } else {
            console.log("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 === Office.AsyncResultStatus.Failed) {
            console.error("Action failed with error: " + asyncResult.error.message);
        } else {
            console.log("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.
let firstSlideId = 0;
function gotoSelectedSlide() {
    // Get currently selected slide's ID.
    Office.context.document.getSelectedDataAsync(Office.CoercionType.SlideRange, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error("Action failed with error: " + asyncResult.error.message);
        } else {
            firstSlideId = asyncResult.value.slides[0].id;
            console.log(JSON.stringify(asyncResult.value));
        }
    });
    
    // Go to slide by ID.
    Office.context.document.goToByIdAsync(firstSlideId, Office.GoToType.Slide, function (asyncResult) {
        if (asyncResult.status === Office.AsyncResultStatus.Failed) {
            console.error("Action failed with error: " + asyncResult.error.message);
        } else {
            console.log("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() {
    const goToFirst = Office.Index.First;
    const goToLast = Office.Index.Last;
    const goToPrevious = Office.Index.Previous;
    const goToNext = Office.Index.Next;

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

プロパティ

asyncContext

asyncContext?: any

selectionMode

selectionMode?: Office.SelectionMode | string