Excel.NamedSheetView class

Pacote:

excel

Representa uma exibição de planilha nomeada de uma planilha. Uma exibição de planilha armazena as regras de classificação e filtro para uma planilha específica. Cada exibição de planilha (até mesmo uma exibição temporária de planilha) tem um nome exclusivo com escopo de planilha que é usado para acessar o modo de exibição.

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.
name	Obtém ou define o nome da exibição da planilha. O nome de exibição de folha temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição usando a propriedade name faz com que a exibição da planilha seja salva.

Métodos

activate()	Ativa essa exibição de planilha. Isso é equivalente ao uso de "Alternar para" na interface do usuário do Excel.
delete()	Remove a exibição da planilha da planilha.
duplicate(name)	Cria uma cópia desse modo de exibição de planilha.
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.) Enquanto o objeto Excel.NamedSheetView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedSheetViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

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

name

Obtém ou define o nome da exibição da planilha. O nome de exibição de folha temporária é a cadeia de caracteres vazia (""). Nomear o modo de exibição usando a propriedade name faz com que a exibição da planilha seja salva.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

activate()

Ativa essa exibição de planilha. Isso é equivalente ao uso de "Alternar para" na interface do usuário do Excel.

activate(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

delete()

Remove a exibição da planilha da planilha.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

duplicate(name)

Cria uma cópia desse modo de exibição de planilha.

duplicate(name?: string): Excel.NamedSheetView;

Parâmetros

name

string

O nome da exibição de planilha duplicada. Se nenhum nome for fornecido, um será gerado.

Retornos

Excel.NamedSheetView

A nova exibição de planilha duplicada.

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

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.NamedSheetViewLoadOptions): Excel.NamedSheetView;

Parâmetros

options

Excel.Interfaces.NamedSheetViewLoadOptions

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

Retornos

Excel.NamedSheetView

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

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.NamedSheetView

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

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

Excel.NamedSheetView

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.) Enquanto o objeto Excel.NamedSheetView original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NamedSheetViewData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.NamedSheetViewData;

Retornos

Excel.Interfaces.NamedSheetViewData