Excel.NamedSheetView class

Pacote:

excel

Representa uma vista de folha com nome de uma folha de cálculo. Uma vista de folha armazena as regras de ordenação e filtro de uma folha de cálculo específica. Cada vista de folha (até mesmo uma vista de folha temporária) tem um nome exclusivo no âmbito da folha de cálculo que é utilizado para aceder à vista.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
name	Obtém ou define o nome da vista de folha. O nome da vista de folha temporária é a cadeia vazia (""). Atribuir um nome à vista com a propriedade name faz com que a vista de folha seja guardada.

Métodos

activate()	Ativa esta vista de folha. Isto é equivalente à utilização de "Mudar Para" na IU do Excel.
delete()	Remove a vista de folha da folha de cálculo.
duplicate(name)	Cria uma cópia desta vista de folha.
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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.NamedSheetView é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.NamedSheetViewData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Detalhes da propriedade

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

Excel.RequestContext

name

Obtém ou define o nome da vista de folha. O nome da vista de folha temporária é a cadeia vazia (""). Atribuir um nome à vista com a propriedade name faz com que a vista de folha seja guardada.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

Detalhes do método

activate()

Ativa esta vista de folha. Isto é equivalente à utilização de "Mudar Para" na IU do Excel.

activate(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

delete()

Remove a vista de folha da folha de cálculo.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApiOnline 1.1 ]

duplicate(name)

Cria uma cópia desta vista de folha.

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

Parâmetros

name

string

O nome da vista de folha duplicada. Se não for fornecido nenhum nome, será gerado um.

Retornos

Excel.NamedSheetView

A nova vista de folha 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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

Excel.NamedSheetView

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

toJSON(): Excel.Interfaces.NamedSheetViewData;

Retornos

Excel.Interfaces.NamedSheetViewData