Office.GoToByIdOptions interface
Fornece opções para selecionar o local para o qual será navegado.
Comentários
O comportamento causado pela opção options.selectionMode varia de acordo com o aplicativo do Office:
No Excel: Office.SelectionMode.Selected seleciona todo o conteúdo da associação ou item nomeado.
Office.SelectionMode.None para associações de texto, seleciona a célula; Para associações de matriz, associações de tabela e itens nomeados, seleciona a primeira célula de dados (não a primeira célula na linha de cabeçalho para tabelas).
No PowerPoint: Office.SelectionMode.Selected seleciona o título do slide ou a primeira caixa de texto no slide.
Office.SelectionMode.None não seleciona nada.
No Word: Office.SelectionMode.Selected seleciona todo o conteúdo da associação.
Office.SelectionMode.None para associações de texto, move o cursor para o início do texto; Para associações de matriz e associações de tabela, seleciona a primeira célula de dados (não a primeira célula na linha de cabeçalho para tabelas).
Usada por
Exemplos
// 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");
}
});
}
Propriedades
| async |
Um item definido pelo usuário de qualquer tipo que é retornado, inalterado, na propriedade asyncContext do objeto AsyncResult que é passado para um retorno de chamada. |
| selection |
Especifica se o local especificado pelo |
Detalhes da propriedade
asyncContext
Um item definido pelo usuário de qualquer tipo que é retornado, inalterado, na propriedade asyncContext do objeto AsyncResult que é passado para um retorno de chamada.
asyncContext?: anyValor da propriedade
any
selectionMode
Especifica se o local especificado pelo id parâmetro está selecionado (realçado). Use Office.SelectionMode ou o equivalente de cadeia de caracteres. Consulte as Observações para obter mais informações.
selectionMode?: Office.SelectionMode | stringValor da propriedade
Office.SelectionMode | string