Excel.Worksheet class
Uma planilha do Excel é uma grade de células. Ele pode conter dados, tabelas, gráficos etc. Para saber mais sobre o modelo de objeto de planilha, leia Trabalhar com planilhas usando a API JavaScript do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
charts | Retorna uma coleção de gráficos que fazem parte da planilha. |
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
id | Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida. |
name | O nome de exibição da planilha. |
position | A posição baseada em zero da planilha na pasta de trabalho. |
protection | Retorna o objeto de proteção de planilha para uma planilha. |
tables | Coleção de tabelas que fazem parte da planilha. |
visibility | A visibilidade da planilha. |
Métodos
activate() | Ative a planilha na interface do usuário do Excel. |
delete() | Exclui a planilha da pasta de trabalho. Observe que, se a visibilidade da planilha estiver definida como "VeryHidden", a operação de exclusão falhará com uma exceção |
get |
Obtém o |
get |
Obtém o |
get |
O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, essa função retornará a célula superior esquerda (ou seja, não gerará um erro). |
load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
charts
Retorna uma coleção de gráficos que fazem parte da planilha.
readonly charts: Excel.ChartCollection;
Valor da propriedade
Comentários
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;
Valor da propriedade
id
Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.
readonly id: string;
Valor da propriedade
string
Comentários
name
O nome de exibição da planilha.
name: string;
Valor da propriedade
string
Comentários
position
A posição baseada em zero da planilha na pasta de trabalho.
position: number;
Valor da propriedade
number
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Set worksheet position.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.position = 2;
await context.sync();
});
protection
Retorna o objeto de proteção de planilha para uma planilha.
readonly protection: Excel.WorksheetProtection;
Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.2 ]
Exemplos
// Unprotecting a worksheet with unprotect() will remove all
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
sheet.protection.protect({
allowInsertRows: false, // Protect row insertion
allowDeleteRows: true // Unprotect row deletion
});
});
tables
Coleção de tabelas que fazem parte da planilha.
readonly tables: Excel.TableCollection;
Valor da propriedade
Comentários
visibility
A visibilidade da planilha.
visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";
Valor da propriedade
Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"
Comentários
[ Conjunto de API: ExcelApi 1.1 para visibilidade de leitura; 1.2 para defini-la. ]
Detalhes do método
activate()
Ative a planilha na interface do usuário do Excel.
activate(): void;
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
delete()
Exclui a planilha da pasta de trabalho. Observe que, se a visibilidade da planilha estiver definida como "VeryHidden", a operação de exclusão falhará com uma exceção InvalidOperation
. Primeiro, você deve alterar sua visibilidade para oculta ou visível antes de excluí-la.
delete(): void;
Retornos
void
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.delete();
await context.sync();
});
getCell(row, column)
Obtém o Range
objeto que contém a célula única com base em números de linha e coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que permaneça dentro da grade da planilha.
getCell(row: number, column: number): Excel.Range;
Parâmetros
- row
-
number
O número da linha da célula a ser recuperada. Indexados com zero.
- column
-
number
O número da coluna da célula a ser recuperada. Indexados com zero.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const cell = worksheet.getCell(0,0);
cell.load('address');
await context.sync();
console.log(cell.address);
});
getRange(address)
Obtém o Range
objeto, representando um único bloco retangular de células, especificado pelo endereço ou nome.
getRange(address?: string): Excel.Range;
Parâmetros
- address
-
string
Opcional. A cadeia de caracteres que representa o endereço ou o nome do intervalo. Por exemplo, "A1:B2". Caso não seja especificado, todo o intervalo da planilha será retornado.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Use the range address to get the range object.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
getUsedRange(valuesOnly)
O intervalo usado é o menor intervalo que abrange todas as células que têm um valor ou uma formatação atribuída a elas. Se toda a planilha estiver em branco, essa função retornará a célula superior esquerda (ou seja, não gerará um erro).
getUsedRange(valuesOnly?: boolean): Excel.Range;
Parâmetros
- valuesOnly
-
boolean
Opcional. Se true
, considerará apenas células com valores como células usadas (ignorando a formatação). [Conjunto de API: ExcelApi 1.2]
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
const usedRange = worksheet.getUsedRange();
usedRange.load('address');
await context.sync();
console.log(usedRange.address);
});
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(options?: Excel.Interfaces.WorksheetLoadOptions): Excel.Worksheet;
Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.Worksheet;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
Exemplos
// Get worksheet properties based on sheet name.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.load('position')
await context.sync();
console.log(worksheet.position);
});
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync()
antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Worksheet;
Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.WorksheetUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Excel.Interfaces.WorksheetUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
Exemplos
// Set the color and name of the current worksheet.
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.set({
tabColor: "yellow",
name: "MySheet"
});
await context.sync();
});
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.Worksheet): void;
Parâmetros
- properties
- Excel.Worksheet
Retornos
void
toJSON()
Substitui o método JavaScript toJSON()
para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify()
. (JSON.stringify
por sua vez, chama o toJSON
método do objeto que é passado para ele.) Enquanto o objeto Excel.Worksheet original é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetData
) que contém cópias rasas de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.WorksheetData;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de