Excel.Worksheet class

Representa o AutoFilter objeto da planilha.

readonly autoFilter: Excel.AutoFilter;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Retorna uma coleção de gráficos que fazem parte da planilha.

readonly charts: Excel.ChartCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

Retorna um conjunto de todos os objetos Comments na planilha.

readonly comments: Excel.CommentCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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

Obtém uma coleção de propriedades personalizadas no nível da planilha.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.12]

Determina se o Excel deve recalcular a planilha quando necessário. Verdadeiro se o Excel recalcular a planilha quando necessário. False se o Excel não recalcular a planilha.

enableCalculation: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Obtém um objeto que pode ser usado para manipular painéis congelados na planilha.

readonly freezePanes: Excel.WorksheetFreezePanes;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.7]

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Comentários

[Conjunto de apis: ExcelApi 1.1]

O nome de exibição da planilha. O nome deve ter menos de 32 caracteres.

name: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

Coleção de nomes com escopo para a planilha atual.

readonly names: Excel.NamedItemCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.4]

Retorna uma coleção de todos os objetos de anotações na planilha.

readonly notes: Excel.NoteCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.18]

Obtém o PageLayout objeto da planilha.

readonly pageLayout: Excel.PageLayout;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

readonly pivotTables: Excel.PivotTableCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.3]

A posição baseada em zero da planilha na pasta de trabalho.

position: number;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

Retorna o objeto de proteção da planilha para uma planilha.

readonly protection: Excel.WorksheetProtection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.2]

Retorna a coleção de todos os objetos Shape na planilha.

readonly shapes: Excel.ShapeCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

Especifica se os ícones de tipo de dados estão visíveis na planilha. Por padrão, os ícones de tipo de dados ficam visíveis.

showDataTypeIcons: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.19]

Especifica se as linhas de grade são visíveis para o usuário.

showGridlines: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Especifica se os títulos são visíveis para o usuário.

showHeadings: boolean;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.8]

Retorna uma coleção de segmentações de dados que fazem parte da planilha.

readonly slicers: Excel.SlicerCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

Retorna a altura padrão de todas as linhas na planilha, em pontos.

readonly standardHeight: number;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.7]

Especifica a largura padrão (padrão) de todas as colunas na planilha. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

standardWidth: number;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.7]

A cor da guia da planilha. Ao recuperar a cor da guia, se a planilha estiver invisível, o valor será null. Se a planilha estiver visível, mas a cor da guia estiver definida como automática, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, use uma string vazia para definir uma cor "automática" ou uma cor real caso contrário.

tabColor: string;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.7]

Retorna um valor que representa essa planilha que pode ser lido pelo Open Office XML. Este é um valor inteiro, que é diferente de worksheet.id (que retorna um identificador global exclusivo) e worksheet.name (que retorna um valor como "Sheet1").

readonly tabId: number;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.14]

Coleção de tabelas que fazem parte da planilha.

readonly tables: Excel.TableCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1]

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.9]

A visibilidade da planilha.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.1 para visibilidade de leitura; 1.2 para configurá-lo.]

Ative a planilha na interface do usuário do Excel.

activate(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.1]

Calcula todas as células em uma planilha.

calculate(markAllDirty: boolean): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.6]

Copia uma planilha e a coloca na posição especificada.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parâmetros

Retornos

A planilha recém-criada.

Comentários

[Conjunto de apis: ExcelApi 1.7]

Copia uma planilha e a coloca na posição especificada.

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parâmetros

Retornos

A planilha recém-criada.

Comentários

[Conjunto de apis: ExcelApi 1.7]

Exclui a planilha da pasta de trabalho. Observe que se a visibilidade da planilha for definida como "VeryHidden", a operação de exclusão falhará com uma InvalidOperation exceção. Primeiro, você deve alterar sua visibilidade para oculto ou visível antes de excluí-lo.

delete(): void;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.1]

Localiza todas as ocorrências da cadeia de caracteres especificada com base nos critérios especificados e as retorna como um RangeAreas objeto, compreendendo um ou mais intervalos retangulares.

O conteúdo das planilhas ocultas não é retornado.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parâmetros

Retornos

Um RangeAreas objeto, compreendendo um ou mais intervalos retangulares, que corresponde aos critérios de pesquisa. Se nenhuma célula atender a esses critérios, um ItemNotFound erro será gerado.

Comentários

[Conjunto de apis: ExcelApi 1.9]

Localiza todas as ocorrências da cadeia de caracteres especificada com base nos critérios especificados e as retorna como um RangeAreas objeto, compreendendo um ou mais intervalos retangulares.

O conteúdo das planilhas ocultas não é retornado.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parâmetros

Retornos

Um RangeAreas objeto, compreendendo um ou mais intervalos retangulares, que corresponde aos critérios de pesquisa. Se não houver correspondências, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

Comentários

[Conjunto de apis: ExcelApi 1.9]

Obtém o Range objeto que contém a única célula 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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.1]

Obtém a planilha seguinte a esta. Se não houver planilhas após esta, esse método gerará um erro.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.5]

Obtém a planilha seguinte a esta. Se não houver planilhas após esta, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.5]

Obtém a planilha que antecede esta. Se não houver planilhas anteriores, esse método gerará um erro.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.5]

Obtém a planilha que antecede esta. Se não houver planilhas anteriores, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.5]

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

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.1]

Faz com que o Range objeto comece em um determinado índice de linha e índice de coluna, e abrangendo um determinado número de linhas e colunas.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.7]

Obtém o RangeAreas objeto, representando um ou mais blocos de intervalos retangulares, especificados pelo endereço ou nome.

getRanges(address?: string): Excel.RangeAreas;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.9]

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, esta função retornará a célula superior esquerda (ou seja, não gerará um erro).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.1]

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, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.4]

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

Retornos

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

Retornos

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

Retornos

Localiza e substitui a cadeia de caracteres fornecida com base nos critérios especificados na planilha atual.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parâmetros

Retornos

O número de substituições realizadas.

Comentários

[Conjunto de apis: ExcelApi 1.9]

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

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Worksheet): void;

Parâmetros

Retornos

Mostra grupos de linha ou coluna por seus níveis de estrutura de tópicos. Descreve grupos e resume uma lista de dados na planilha. Os rowLevels parâmetros and columnLevels especificam quantos níveis da estrutura de tópicos serão exibidos. O intervalo de argumentos aceitável está entre 0 e 8. Um valor de 0 não altera a exibição atual. Um valor maior que o número atual de níveis exibe todos os níveis.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.10]

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 original Excel.Worksheet é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.WorksheetData;

Retornos

Ocorre quando a planilha é ativada.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.7]

Ocorre quando a planilha é calculada.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.8]

Ocorre quando os dados são alterados em uma planilha específica.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.7]

Ocorre quando uma ou mais colunas são classificadas. Isso acontece como resultado de uma operação de classificação da esquerda para a direita.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.10]

Ocorre quando a planilha é desativada.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.7]

Ocorre quando o formato é alterado em uma planilha específica.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.9]

Ocorre quando uma ou mais fórmulas são alteradas nesta planilha. Esse evento é para quando a fórmula em si é alterada, e não o valor de dados resultante do cálculo da fórmula.

O evento só é disparado quando a célula já contém uma fórmula.

O novo valor da célula pode não incluir uma fórmula. Esse evento não é acionado quando uma fórmula é inserida em uma célula que não continha uma fórmula anteriormente.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.13]

Ocorre quando o nome da planilha é alterado.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.17]

Ocorre quando o estado de proteção da planilha é alterado.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.14]

Ocorre quando o estado oculto de uma ou mais linhas é alterado em uma planilha específica.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.11]

Ocorre quando uma ou mais linhas são classificadas. Isso ocorre como resultado de uma operação de classificação de cima para baixo.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.10]

Ocorre quando a seleção é alterada em uma planilha específica.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.7]

Ocorre quando uma ação do botão esquerdo/tocado ocorre na planilha. Este evento não será acionado ao clicar nos seguintes casos:

• O usuário arrasta o mouse para fazer várias seleções.

• O usuário seleciona uma célula no modo em que os argumentos de célula são selecionados para referências de fórmula.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.10]

Ocorre quando a visibilidade da planilha é alterada.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.17]