Excel.TableChangedEventArgs interface
Fornece informações sobre a tabela que levantou o evento alterado.
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Propriedades
address | Obtém o endereço que representa a área alterada de uma tabela em uma planilha específica. |
change |
Obtém o tipo de alteração que representa a forma como o evento alterado é acionado. Veja |
details | Obtém as informações sobre os detalhes da alteração. Esta propriedade pode ser obtida quando o evento alterado é acionado numa única célula. Se o evento alterado for acionado em múltiplas células, esta propriedade não pode ser obtida. |
source | Obtém a origem do evento. Veja |
table |
Obtém o ID da tabela na qual os dados foram alterados. |
type | Obtém o tipo do evento. Veja |
worksheet |
Obtém o ID da folha de cálculo na qual os dados foram alterados. |
Métodos
get |
Obtém o intervalo que representa a área alterada de uma tabela numa folha de cálculo específica. |
get |
Obtém o intervalo que representa a área alterada de uma tabela numa folha de cálculo específica. Pode retornar o objeto null. |
Detalhes da propriedade
address
Obtém o endereço que representa a área alterada de uma tabela em uma planilha específica.
address: string;
Valor da propriedade
string
Comentários
changeType
Obtém o tipo de alteração que representa a forma como o evento alterado é acionado. Veja Excel.DataChangeType
para obter detalhes.
changeType: Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted";
Valor da propriedade
Excel.DataChangeType | "Unknown" | "RangeEdited" | "RowInserted" | "RowDeleted" | "ColumnInserted" | "ColumnDeleted" | "CellInserted" | "CellDeleted"
Comentários
details
Obtém as informações sobre os detalhes da alteração. Esta propriedade pode ser obtida quando o evento alterado é acionado numa única célula. Se o evento alterado for acionado em múltiplas células, esta propriedade não pode ser obtida.
details: Excel.ChangedEventDetail;
Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.9 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/data-change-event-details.yaml
async function onTableChanged(eventArgs: Excel.TableChangedEventArgs) {
await Excel.run(async (context) => {
const details = eventArgs.details;
const address = eventArgs.address;
console.log(`Change at ${address}: was ${details.valueBefore}(${details.valueTypeBefore}),`
+ ` now is ${details.valueAfter}(${details.valueTypeAfter})`);
});
}
source
Obtém a origem do evento. Veja Excel.EventSource
para obter detalhes.
source: Excel.EventSource | "Local" | "Remote";
Valor da propriedade
Excel.EventSource | "Local" | "Remote"
Comentários
tableId
Obtém o ID da tabela na qual os dados foram alterados.
tableId: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml
async function onChange(event) {
await Excel.run(async (context) => {
let table = context.workbook.tables.getItem(event.tableId);
let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
worksheet.load("name");
await context.sync();
console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
console.log("Table Id : " + event.tableId);
console.log("Worksheet Id : " + worksheet.name);
});
}
type
Obtém o tipo do evento. Veja Excel.EventType
para obter detalhes.
type: "TableChanged";
Valor da propriedade
"TableChanged"
Comentários
worksheetId
Obtém o ID da folha de cálculo na qual os dados foram alterados.
worksheetId: string;
Valor da propriedade
string
Comentários
[ Conjunto de API: ExcelApi 1.7 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-tablecollection-changed.yaml
async function onChange(event) {
await Excel.run(async (context) => {
let table = context.workbook.tables.getItem(event.tableId);
let worksheet = context.workbook.worksheets.getItem(event.worksheetId);
worksheet.load("name");
await context.sync();
console.log("Handler for table collection onChanged event has been triggered. Data changed address: " + event.address);
console.log("Table Id : " + event.tableId);
console.log("Worksheet Id : " + worksheet.name);
});
}
Detalhes do método
getRange(ctx)
Obtém o intervalo que representa a área alterada de uma tabela numa folha de cálculo específica.
[ Conjunto de API: ExcelApi 1.8 ]
getRange(ctx: Excel.RequestContext): Excel.Range;
Parâmetros
Retornos
getRangeOrNullObject(ctx)
Obtém o intervalo que representa a área alterada de uma tabela numa folha de cálculo específica. Pode retornar o objeto null.
[ Conjunto de API: ExcelApi 1.8 ]
getRangeOrNullObject(ctx: Excel.RequestContext): Excel.Range;