Excel.Worksheet class
Uma planilha do Excel é uma grade de células. Pode conter dados, tabelas, gráficos, etc. Para saber mais sobre o modelo de objeto de folha de cálculo, leia Trabalhar com folhas de cálculo com a API JavaScript do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Exemplos
// Get a Worksheet object by its name and activate it.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
Propriedades
| charts | Devolve uma coleção de gráficos que fazem parte da folha de cálculo. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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. O nome tem de ter menos de 32 carateres. |
| position | A posição baseada em zero da planilha na pasta de trabalho. |
| 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. Tenha em atenção que se a visibilidade da folha de cálculo estiver definida como "VeryHidden", a operação de eliminação falhará com uma exceção |
| get |
Obtém o |
| get |
Obtém o |
| 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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
charts
Devolve uma coleção de gráficos que fazem parte da folha de cálculo.
readonly charts: Excel.ChartCollection;Valor da propriedade
Comentários
context
O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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. O nome tem de ter menos de 32 carateres.
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();
});
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-lo. ]
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. Tenha em atenção que se a visibilidade da folha de cálculo estiver definida como "VeryHidden", a operação de eliminação falhará com uma exceção InvalidOperation . Primeiro, deve alterar a visibilidade para oculta ou visível antes de a eliminar.
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 única célula com base nos números de linha e coluna. A célula pode estar fora dos limites do respetivo intervalo principal, desde que permaneça na grelha da folha de cálculo.
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 que representa o endereço ou 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);
});
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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de 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 num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Worksheet é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Excel.Interfaces.WorksheetData;