ExcelScript.Worksheet interface

Uma planilha do Excel é uma grade de células. Ela pode conter dados, tabelas, gráficos, etc.

Métodos

activate()

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

addChart(type, sourceData, seriesBy)

Cria um novo gráfico.

addComment(cellAddress, content, contentType)

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

addGeometricShape(geometricShapeType)

Adiciona uma forma geométrica à planilha. Retorna um objeto Shape que representa a nova forma.

addGroup(values)

Um subconjunto de formas na planilha do conjunto de grupos. Retorna um objeto Shape que representa o novo grupo de formas.

addHorizontalPageBreak(pageBreakRange)

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addImage(base64ImageString)

Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Retorna o objeto Shape que representa a nova imagem.

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Adiciona uma linha à planilha. Retorna um objeto Shape que representa a nova linha.

addNamedItem(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.

addNamedItemFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

addPivotTable(name, source, destination)

Adicione uma tabela dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino.

addSlicer(slicerSource, sourceField, slicerDestination)

Adiciona uma nova segmentação de dados à pasta de trabalho.

addTable(address, hasHeaders)

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

addTextBox(text)

Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um objeto Shape que representa a nova caixa de texto.

addVerticalPageBreak(pageBreakRange)

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addWorksheetCustomProperty(key, value)

Adiciona uma nova propriedade personalizada que é mapeada para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave.

calculate(markAllDirty)

Calcula todas as células em uma planilha.

copy(positionType, relativeTo)

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

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 InvalidOperation exceção. Você deve primeiro alterar sua visibilidade para oculto ou visível antes de excluí-lo.

findAll(text, criteria)

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

getAutoFilter()

Representa o objeto AutoFilter da planilha.

getCell(row, column)

Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que ela permaneça dentro da grade da planilha.

getChart(name)

Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. Se o gráfico não existir, retornará um objeto NULL.

getCharts()

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

getComment(commentId)

Obtém um comentário da coleção com base em seu ID.

getCommentByCell(cellAddress)

Obtém o comentário da célula especificada.

getCommentByReplyId(replyId)

Obtém o comentário ao qual a resposta fornecida está conectada.

getComments()

Retorna um conjunto de todos os objetos Comments na planilha.

getCustomProperties()

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

getEnableCalculation()

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

getFreezePanes()

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

getHorizontalPageBreaks()

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

getId()

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.

getName()

O nome de exibição da planilha.

getNamedItem(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem não existir, retornará um objeto null.

getNames()

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

getNext(visibleOnly)

Obtém a planilha que segue esta. Se não houver planilhas após esta, este método retornará um objeto NULL.

getPageLayout()

Obtém o objeto PageLayout da planilha.

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

getPivotTables()

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

getPosition()

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

getPrevious(visibleOnly)

Obtém a planilha que precede esta. Se não houver planilhas anteriores, este método retornará um objeto NULL.

getProtection()

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

getRange(address)

Obtém o objeto Range, representando um único bloco retangular de células, especificado pelo endereço ou nome.

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtém o objeto Range que começa em um determinado índice de linha e índice de coluna e que abrange um determinado número de linhas e colunas.

getRanges(address)

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

getShape(key)

Obtém uma forma usando seu nome ou ID.

getShapes()

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

getShowGridlines()

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

getShowHeadings()

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

getSlicer(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

getSlicers()

Retorna uma coleção de slicers que fazem parte da planilha.

getStandardHeight()

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

getStandardWidth()

Especifica a largura padrão de todas as colunas da 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).

getTabColor()

A cor da guia da planilha. Ao recuperar a cor de tabulação, se a planilha estiver invisível, o valor será NULL. Se a planilha estiver visível, mas a cor da guia estiver definida como auto, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formato " # 123456" ao definir a cor, usar uma cadeia de caracteres vazia para definir uma cor "auto" ou uma cor real caso contrário.

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

getTables()

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

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 a planilha inteira estiver em branco, esta função retornará um objeto null.

getVerticalPageBreaks()

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

getVisibility()

A visibilidade da planilha.

getWorksheetCustomProperty(key)

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Retorna um objeto NULL se a propriedade personalizada não existir.

refreshAllPivotTables()

Atualiza todas as tabelas dinâmicas da coleção.

removeAllHorizontalPageBreaks()

Redefine todas as quebras de página manuais na coleção.

removeAllVerticalPageBreaks()

Redefine todas as quebras de página manuais na coleção.

replaceAll(text, replacement, criteria)

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

setEnableCalculation(enableCalculation)

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

setName(name)

O nome de exibição da planilha.

setPosition(position)

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

setShowGridlines(showGridlines)

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

setShowHeadings(showHeadings)

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

setStandardWidth(standardWidth)

Especifica a largura padrão de todas as colunas da 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).

setTabColor(tabColor)

A cor da guia da planilha. Ao recuperar a cor de tabulação, se a planilha estiver invisível, o valor será NULL. Se a planilha estiver visível, mas a cor da guia estiver definida como auto, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formato " # 123456" ao definir a cor, usar uma cadeia de caracteres vazia para definir uma cor "auto" ou uma cor real caso contrário.

setVisibility(visibility)

A visibilidade da planilha.

showOutlineLevels(rowLevels, columnLevels)

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

Detalhes do método

activate()

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

activate(): void;

Retornos

void

addChart(type, sourceData, seriesBy)

Cria um novo gráfico.

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

Parâmetros

type
ChartType

Representa o tipo de um gráfico. Confira ExcelScript. ChartType para obter detalhes.

sourceData
Range

O objeto Range correspondente aos dados de origem.

seriesBy
ChartSeriesBy

Opcional. Especifica a forma como as colunas ou linhas são usadas como série de dados no gráfico. Consulte ExcelScript. ChartSeriesBy para obter detalhes.

Retornos

addComment(cellAddress, content, contentType)

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Parâmetros

cellAddress
Range | string

A célula à qual o comentário é adicionado. Pode ser um objeto Range ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

content
CommentRichContent | string

O conteúdo do comentário. Pode ser um objeto String ou CommentRichContent. As cadeias de caracteres são usadas para texto sem formatação. Os objetos CommentRichContent permitem outros recursos de comentários, como menção.

contentType
ContentType

Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enum ContentType.Plain.

Retornos

addGeometricShape(geometricShapeType)

Adiciona uma forma geométrica à planilha. Retorna um objeto Shape que representa a nova forma.

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Parâmetros

geometricShapeType
GeometricShapeType

Representa o tipo da forma geométrica. Consulte ExcelScript. GeometricShapeType para obter detalhes.

Retornos

addGroup(values)

Um subconjunto de formas na planilha do conjunto de grupos. Retorna um objeto Shape que representa o novo grupo de formas.

addGroup(values: Array<string | Shape>): Shape;

Parâmetros

values
Array<string | Shape>

Uma matriz de ID da forma ou objetos Shape.

Retornos

addHorizontalPageBreak(pageBreakRange)

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

pageBreakRange
Range | string

O intervalo imediatamente após a quebra de página ser adicionada.

Retornos

addImage(base64ImageString)

Cria uma imagem de uma cadeia de caracteres na base 64 e a adiciona à planilha. Retorna o objeto Shape que representa a nova imagem.

addImage(base64ImageString: string): Shape;

Parâmetros

base64ImageString
string

Uma cadeia de caracteres codificada em base64 que representa uma imagem no formato JPEG ou PNG.

Retornos

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Adiciona uma linha à planilha. Retorna um objeto Shape que representa a nova linha.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType
        ): Shape;

Parâmetros

startLeft
number

A distância, em pontos, desde o início da linha até o lado esquerdo da planilha.

startTop
number

A distância, em pontos, desde o início da linha até a parte superior da planilha.

endLeft
number

A distância, em pontos, do final da linha à esquerda da planilha.

endTop
number

A distância, em pontos, do final da linha até a parte superior da planilha.

connectorType
ConnectorType

Representa o tipo de conector. Confira ExcelScript. ConnectorType para obter detalhes.

Retornos

addNamedItem(name, reference, comment)

Adiciona um novo nome à coleção do escopo fornecido.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Parâmetros

name
string

O nome do item nomeado.

reference
Range | string

A fórmula ou o intervalo ao qual o nome fará referência.

comment
string

Opcional. O comentário associado ao item nomeado.

Retornos

addNamedItemFormulaLocal(name, formula, comment)

Adiciona um novo nome à coleção de escopo fornecido usando a localidade do usuário para a fórmula.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Parâmetros

name
string

O "nome" do item nomeado.

formula
string

A fórmula na localidade do usuário à qual o nome se referirá.

comment
string

Opcional. O comentário associado ao item nomeado.

Retornos

addPivotTable(name, source, destination)

Adicione uma tabela dinâmica com base nos dados de origem especificados e insira-a na célula superior esquerda do intervalo de destino.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Parâmetros

name
string

O nome da nova tabela dinâmica.

source
Range | string | Table

Os dados de origem da nova tabela dinâmica, podem ser um intervalo (ou um endereço de cadeia de caracteres incluindo o nome da planilha) ou uma tabela.

destination
Range | string

A célula no canto superior esquerdo do intervalo de destino do relatório de tabela dinâmica (o intervalo na planilha em que o relatório resultante será inserido).

Retornos

addSlicer(slicerSource, sourceField, slicerDestination)

Adiciona uma nova segmentação de dados à pasta de trabalho.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Parâmetros

slicerSource
string | PivotTable | Table

A fonte de dados na qual o novo slicer será baseado. Pode ser um objeto PivotTable, um objeto Table ou uma cadeia de caracteres. Quando um objeto PivotTable é passado, a fonte de dados é a fonte do objeto PivotTable. Quando um objeto Table é passado, a fonte de dados é o objeto Table. Quando uma cadeia de caracteres é passada, ela é interpretada como o nome/ID de uma tabela dinâmica.

sourceField
string | PivotField | number | TableColumn

O campo na fonte de dados a ser filtrado. Pode ser um objeto PivotField, um objeto TableColumn, a ID de um PivotField ou a ID/nome de TableColumn.

slicerDestination
string | Worksheet

Opcional. A planilha na qual a nova segmentação de trabalho será criada. Pode ser um objeto Worksheet ou o nome/ID de uma planilha. Esse parâmetro pode ser omitido se a coleção slicer for recuperada da planilha.

Retornos

addTable(address, hasHeaders)

Cria uma nova tabela. O objeto de intervalo ou endereço de origem determina a planilha à qual a tabela será adicionada. Se a tabela não puder ser adicionada (por exemplo, porque o endereço é inválido ou a tabela se sobreporia a outra), será gerado um erro.

addTable(address: Range | string, hasHeaders: boolean): Table;

Parâmetros

address
Range | string

Um objeto Range, um endereço de cadeia de caracteres ou o nome do objeto de intervalo que representa a fonte de dados. Se o endereço não contiver o nome de uma planilha, a folha ativa no momento será usada.

hasHeaders
boolean

Valor booliano que indica se os dados que estão sendo importados têm rótulos de coluna. Se a origem não contiver cabeçalhos (ou seja, quando essa propriedade estiver definida como falso), o Excel gerará automaticamente um cabeçalho, deslocando os dados uma linha para baixo.

Retornos

Exemplos

/**
 * This sample creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

addTextBox(text)

Adiciona uma caixa de texto na planilha com o texto fornecido como conteúdo. Retorna um objeto Shape que representa a nova caixa de texto.

addTextBox(text?: string): Shape;

Parâmetros

text
string

Representa o texto que será mostrado na caixa de texto criado.

Retornos

addVerticalPageBreak(pageBreakRange)

Adiciona uma quebra de página antes da célula superior esquerda do intervalo especificado.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Parâmetros

pageBreakRange
Range | string

O intervalo imediatamente após a quebra de página ser adicionada.

Retornos

addWorksheetCustomProperty(key, value)

Adiciona uma nova propriedade personalizada que é mapeada para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave.

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

Parâmetros

key
string

A chave que identifica o objeto de propriedade personalizada. Não diferencia maiúsculas de minúsculas. A chave está limitada a 255 caracteres (valores maiores causarão o erro "InvalidArgument".)

value
string

O valor dessa propriedade personalizada.

Retornos

calculate(markAllDirty)

Calcula todas as células em uma planilha.

calculate(markAllDirty: boolean): void;

Parâmetros

markAllDirty
boolean

True, para marcar tudo como sujo.

Retornos

void

copy(positionType, relativeTo)

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

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

Parâmetros

positionType
WorksheetPositionType

O local na pasta de trabalho para colocar a planilha recém-criada. O valor padrão é "nenhum", que insere a planilha no início da planilha.

relativeTo
Worksheet

A planilha existente que determina a posição da planilha recém-criada. Isso só será necessário se positionType for "antes" ou "depois".

Retornos

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 InvalidOperation exceção. Você deve primeiro alterar sua visibilidade para oculto ou visível antes de excluí-lo.

delete(): void;

Retornos

void

Exemplos

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

findAll(text, criteria)

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

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

Parâmetros

text
string

A cadeia de caracteres a ser localizada.

criteria
WorksheetSearchCriteria

Critérios de pesquisa adicionais, incluindo se a pesquisa precisa corresponder à célula inteira ou diferenciar maiúsculas de minúsculas.

Retornos

getAutoFilter()

Representa o objeto AutoFilter da planilha.

getAutoFilter(): AutoFilter;

Retornos

getCell(row, column)

Obtém o objeto de intervalo que contém a célula única com base nos números de linha e de coluna. A célula pode estar fora dos limites de seu intervalo pai, desde que ela permaneça dentro da grade da planilha.

getCell(row: number, column: number): 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. Indexado com zero.

Retornos

getChart(name)

Obtém um gráfico usando o respectivo nome. Quando houver vários gráficos com o mesmo nome, o sistema retornará o primeiro deles. Se o gráfico não existir, retornará um objeto NULL.

getChart(name: string): Chart | undefined;

Parâmetros

name
string

Nome do gráfico a recuperar.

Retornos

Chart | undefined

getCharts()

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

getCharts(): Chart[];

Retornos

Chart[]

getComment(commentId)

Obtém um comentário da coleção com base em seu ID.

getComment(commentId: string): Comment;

Parâmetros

commentId
string

O identificador para o comentário.

Retornos

getCommentByCell(cellAddress)

Obtém o comentário da célula especificada.

getCommentByCell(cellAddress: Range | string): Comment;

Parâmetros

cellAddress
Range | string

A célula na qual o comentário está. Pode ser um objeto Range ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será acionado se o intervalo fornecido for maior que uma célula.

Retornos

getCommentByReplyId(replyId)

Obtém o comentário ao qual a resposta fornecida está conectada.

getCommentByReplyId(replyId: string): Comment;

Parâmetros

replyId
string

O identificador de resposta de comentário.

Retornos

getComments()

Retorna um conjunto de todos os objetos Comments na planilha.

getComments(): Comment[];

Retornos

getCustomProperties()

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

getCustomProperties(): WorksheetCustomProperty[];

Retornos

getEnableCalculation()

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

getEnableCalculation(): boolean;

Retornos

boolean

getFreezePanes()

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

getFreezePanes(): WorksheetFreezePanes;

Retornos

getHorizontalPageBreaks()

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

getHorizontalPageBreaks(): PageBreak[];

Retornos

getId()

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.

getId(): string;

Retornos

string

getName()

O nome de exibição da planilha.

getName(): string;

Retornos

string

Exemplos

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

getNamedItem(name)

Obtém um objeto NamedItem usando seu nome. Se o objeto getNamedItem não existir, retornará um objeto null.

getNamedItem(name: string): NamedItem | undefined;

Parâmetros

name
string

NamedItem Name.

Retornos

NamedItem | undefined

getNames()

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

getNames(): NamedItem[];

Retornos

getNext(visibleOnly)

Obtém a planilha que segue esta. Se não houver planilhas após esta, este método retornará um objeto NULL.

getNext(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

Opcional. Se true, só considera planilhas visíveis, ignorando as ocultas.

Retornos

getPageLayout()

Obtém o objeto PageLayout da planilha.

getPageLayout(): PageLayout;

Retornos

getPivotTable(name)

Obtém uma Tabela Dinâmica por nome. Se a tabela dinâmica não existir, retornará um objeto null.

getPivotTable(name: string): PivotTable | undefined;

Parâmetros

name
string

Nome da Tabela Dinâmica a ser recuperada.

Retornos

PivotTable | undefined

getPivotTables()

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

getPivotTables(): PivotTable[];

Retornos

getPosition()

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

getPosition(): number;

Retornos

number

getPrevious(visibleOnly)

Obtém a planilha que precede esta. Se não houver planilhas anteriores, este método retornará um objeto NULL.

getPrevious(visibleOnly?: boolean): Worksheet;

Parâmetros

visibleOnly
boolean

Opcional. Se true, só considera planilhas visíveis, ignorando as ocultas.

Retornos

getProtection()

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

getProtection(): WorksheetProtection;

Retornos

getRange(address)

Obtém o objeto Range, representando um único bloco retangular de células, especificado pelo endereço ou nome.

getRange(address?: string): 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

Exemplos

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtém o objeto Range que começa em um determinado índice de linha e índice de coluna e que abrange um determinado número de linhas e colunas.

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

Parâmetros

startRow
number

Linha inicial (indexada por zero).

startColumn
number

Coluna inicial (indexada por zero).

rowCount
number

Número de linhas a serem incluídas no intervalo.

columnCount
number

Número de colunas a serem incluídas no intervalo.

Retornos

getRanges(address)

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

getRanges(address?: string): RangeAreas;

Parâmetros

address
string

Opcional. Uma cadeia de caracteres que contém os endereços ou nomes separados por vírgulas de intervalos individuais. Por exemplo, "a1: B2, A5: B5". Se não for especificado, será retornado um objeto RangeArea para a planilha inteira.

Retornos

getShape(key)

Obtém uma forma usando seu nome ou ID.

getShape(key: string): Shape;

Parâmetros

key
string

Nome ou ID da forma a ser recuperada.

Retornos

getShapes()

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

getShapes(): Shape[];

Retornos

Shape[]

getShowGridlines()

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

getShowGridlines(): boolean;

Retornos

boolean

getShowHeadings()

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

getShowHeadings(): boolean;

Retornos

boolean

getSlicer(key)

Obtém uma segmentação de dados usando seu nome ou id. Se a ela não existir, retornará um objeto null.

getSlicer(key: string): Slicer | undefined;

Parâmetros

key
string

Nome ou ID da segmentação de, a ser recuperada.

Retornos

Slicer | undefined

getSlicers()

Retorna uma coleção de slicers que fazem parte da planilha.

getSlicers(): Slicer[];

Retornos

Slicer[]

getStandardHeight()

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

getStandardHeight(): number;

Retornos

number

getStandardWidth()

Especifica a largura padrão de todas as colunas da 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).

getStandardWidth(): number;

Retornos

number

getTabColor()

A cor da guia da planilha. Ao recuperar a cor de tabulação, se a planilha estiver invisível, o valor será NULL. Se a planilha estiver visível, mas a cor da guia estiver definida como auto, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formato " # 123456" ao definir a cor, usar uma cadeia de caracteres vazia para definir uma cor "auto" ou uma cor real caso contrário.

getTabColor(): string;

Retornos

string

getTable(key)

Obtém uma tabela pelo nome ou ID. Se a tabela não existir, retornará um objeto null.

getTable(key: string): Table | undefined;

Parâmetros

key
string

Nome ou ID da tabela a ser recuperada.

Retornos

Table | undefined

getTables()

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

getTables(): Table[];

Retornos

Table[]

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 a planilha inteira estiver em branco, esta função retornará um objeto null.

getUsedRange(valuesOnly?: boolean): Range;

Parâmetros

valuesOnly
boolean

Opcional. Considera apenas as células com valores como células usadas.

Retornos

getVerticalPageBreaks()

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

getVerticalPageBreaks(): PageBreak[];

Retornos

getVisibility()

A visibilidade da planilha.

getVisibility(): SheetVisibility;

Retornos

getWorksheetCustomProperty(key)

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Retorna um objeto NULL se a propriedade personalizada não existir.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Parâmetros

key
string

A chave que identifica o objeto de propriedade personalizada. Não diferencia maiúsculas de minúsculas.

Retornos

refreshAllPivotTables()

Atualiza todas as tabelas dinâmicas da coleção.

refreshAllPivotTables(): void;

Retornos

void

removeAllHorizontalPageBreaks()

Redefine todas as quebras de página manuais na coleção.

removeAllHorizontalPageBreaks(): void;

Retornos

void

removeAllVerticalPageBreaks()

Redefine todas as quebras de página manuais na coleção.

removeAllVerticalPageBreaks(): void;

Retornos

void

replaceAll(text, replacement, criteria)

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

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Parâmetros

text
string

Cadeia de caracteres a ser localizada.

replacement
string

Cadeia de caracteres para substituir o original por.

criteria
ReplaceCriteria

Critérios adicionais de substituição.

Retornos

number

setEnableCalculation(enableCalculation)

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

setEnableCalculation(enableCalculation: boolean): void;

Parâmetros

enableCalculation
boolean

Retornos

void

setName(name)

O nome de exibição da planilha.

setName(name: string): void;

Parâmetros

name
string

Retornos

void

setPosition(position)

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

setPosition(position: number): void;

Parâmetros

position
number

Retornos

void

setShowGridlines(showGridlines)

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

setShowGridlines(showGridlines: boolean): void;

Parâmetros

showGridlines
boolean

Retornos

void

setShowHeadings(showHeadings)

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

setShowHeadings(showHeadings: boolean): void;

Parâmetros

showHeadings
boolean

Retornos

void

setStandardWidth(standardWidth)

Especifica a largura padrão de todas as colunas da 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).

setStandardWidth(standardWidth: number): void;

Parâmetros

standardWidth
number

Retornos

void

setTabColor(tabColor)

A cor da guia da planilha. Ao recuperar a cor de tabulação, se a planilha estiver invisível, o valor será NULL. Se a planilha estiver visível, mas a cor da guia estiver definida como auto, uma cadeia de caracteres vazia será retornada. Caso contrário, a propriedade será definida como uma cor, no formato " # 123456" ao definir a cor, usar uma cadeia de caracteres vazia para definir uma cor "auto" ou uma cor real caso contrário.

setTabColor(tabColor: string): void;

Parâmetros

tabColor
string

Retornos

void

Exemplos

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

setVisibility(visibility)

A visibilidade da planilha.

setVisibility(visibility: SheetVisibility): void;

Parâmetros

visibility
SheetVisibility

Retornos

void

showOutlineLevels(rowLevels, columnLevels)

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

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

Parâmetros

rowLevels
number

O número de níveis de linha de uma estrutura de tópicos a ser exibido.

columnLevels
number

O número de níveis de coluna de uma estrutura de tópicos a ser exibido.

Retornos

void