Excel.NamedSheetViewCollection class

Pacote:

excel

Representa a coleção de exibições de planilha na planilha.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(name)	Cria uma nova exibição de planilha com o nome fornecido.
enterTemporary()	Cria e ativa uma nova exibição de planilha temporária. As exibições temporárias são removidas ao fechar o aplicativo, sair da exibição temporária com o método de saída ou alternar para outra exibição de planilha. A exibição temporária da planilha também pode ser acessada com a cadeia de caracteres vazia (""), se a exibição temporária existir.
exit()	Sai do modo de exibição da planilha ativa no momento.
getActive()	Obtém a exibição da planilha ativa atualmente.
getCount()	Obtém o número de exibições de planilha nesta planilha. Inclui a exibição temporária da planilha se ela existir.
getItem(key)	Obtém uma exibição de planilha usando seu nome.
getItemAt(index)	Obtém uma exibição de planilha por seu índice na coleção.
getItemOrNullObject(key)	Obtém uma exibição de planilha usando seu nome. Se o objeto de exibição de folha não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.NamedSheetViewCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedSheetViewCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

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

Excel.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.NamedSheetView[];

Valor da propriedade

Excel.NamedSheetView[]

Detalhes do método

add(name)

Cria uma nova exibição de planilha com o nome fornecido.

add(name: string): Excel.NamedSheetView;

Parâmetros

name

string

O nome da exibição da planilha a ser criada. Lança um erro quando o nome fornecido já existe, está vazio ou é um nome reservado pela planilha.

Retornos

Excel.NamedSheetView

O objeto de exibição de planilha recém-criado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

enterTemporary()

Cria e ativa uma nova exibição de planilha temporária. As exibições temporárias são removidas ao fechar o aplicativo, sair da exibição temporária com o método de saída ou alternar para outra exibição de planilha. A exibição temporária da planilha também pode ser acessada com a cadeia de caracteres vazia (""), se a exibição temporária existir.

enterTemporary(): Excel.NamedSheetView;

Retornos

Excel.NamedSheetView

O objeto de exibição de planilha recém-criado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

exit()

Sai do modo de exibição da planilha ativa no momento.

exit(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getActive()

Obtém a exibição da planilha ativa atualmente.

getActive(): Excel.NamedSheetView;

Retornos

Excel.NamedSheetView

A exibição da planilha ativa atualmente para esta planilha.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getCount()

Obtém o número de exibições de planilha nesta planilha. Inclui a exibição temporária da planilha se ela existir.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItem(key)

Obtém uma exibição de planilha usando seu nome.

getItem(key: string): Excel.NamedSheetView;

Parâmetros

key

string

O nome sensível a maiúsculas de maiúsculas e minúsculas do modo de exibição da planilha. Use a cadeia de caracteres vazia ("") para obter a exibição temporária da planilha, se a exibição temporária existir.

Retornos

Excel.NamedSheetView

A exibição da planilha com o nome determinado ou a exibição temporária se uma cadeia de caracteres vazia foi fornecida. Se não houver nenhuma exibição temporária atual e uma cadeia de caracteres vazia tiver sido fornecida, um ItemNotFound erro será gerado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemAt(index)

Obtém uma exibição de planilha por seu índice na coleção.

getItemAt(index: number): Excel.NamedSheetView;

Parâmetros

index

number

O índice do objeto de exibição de folha na coleção.

Retornos

Excel.NamedSheetView

A exibição da planilha no índice determinado.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Obtém uma exibição de planilha usando seu nome. Se o objeto de exibição de folha não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getItemOrNullObject(key: string): Excel.NamedSheetView;

Parâmetros

key

string

O nome sensível a maiúsculas de maiúsculas e minúsculas do modo de exibição da planilha. Use a cadeia de caracteres vazia ("") para obter a exibição temporária da planilha, se a exibição temporária existir.

Retornos

Excel.NamedSheetView

A exibição da planilha com o nome determinado ou a exibição temporária se uma cadeia de caracteres vazia foi fornecida.

Comentários

[ Conjunto de API: ExcelApi BETA (SOMENTE VERSÃO PRÉVIA) ]

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.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;

Parâmetros

options

Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.NamedSheetViewCollection

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.NamedSheetViewCollection;

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

Excel.NamedSheetViewCollection

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?: OfficeExtension.LoadOption): Excel.NamedSheetViewCollection;

Parâmetros

propertyNamesAndPaths

OfficeExtension.LoadOption

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

Excel.NamedSheetViewCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.NamedSheetViewCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedSheetViewCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

Retornos

Excel.Interfaces.NamedSheetViewCollectionData