Excel.NamedSheetViewCollection class
Representa a coleção de vistas de folha na folha de cálculo.
- Extends
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. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(name) | Cria uma nova vista de folha com o nome especificado. |
| enter |
Cria e ativa uma nova vista de folha temporária. As vistas temporárias são removidas ao fechar a aplicação, ao sair da vista temporária com o método de saída ou ao mudar para outra vista de folha. A vista de folha temporária também pode ser acedida com a cadeia vazia (""), se a vista temporária existir. |
| exit() | Sai da vista de folha atualmente ativa. |
| get |
Obtém a vista de folha de cálculo atualmente ativa. |
| get |
Obtém o número de vistas de folha nesta folha de cálculo. Inclui a vista de folha temporária, se existir. |
| get |
Obtém uma vista de folha com o respetivo nome. |
| get |
Obtém uma vista de folha pelo respetivo índice na coleção. |
| get |
Obtém uma vista de folha com o respetivo nome. Se o objeto de vista de folha não existir, este método devolve um objeto com a respetiva |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| toJSON() | Substitui o método JavaScript |
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.NamedSheetView[];Valor da propriedade
Detalhes do método
add(name)
Cria uma nova vista de folha com o nome especificado.
add(name: string): Excel.NamedSheetView;Parâmetros
- name
-
string
O nome da vista de folha a ser criada. Gera um erro quando o nome fornecido já existe, está vazio ou é um nome reservado pela folha de cálculo.
Retornos
O objeto de vista de folha recentemente criado.
Comentários
enterTemporary()
Cria e ativa uma nova vista de folha temporária. As vistas temporárias são removidas ao fechar a aplicação, ao sair da vista temporária com o método de saída ou ao mudar para outra vista de folha. A vista de folha temporária também pode ser acedida com a cadeia vazia (""), se a vista temporária existir.
enterTemporary(): Excel.NamedSheetView;Retornos
O objeto de vista de folha recentemente criado.
Comentários
exit()
Sai da vista de folha atualmente ativa.
exit(): void;Retornos
void
Comentários
getActive()
Obtém a vista de folha de cálculo atualmente ativa.
getActive(): Excel.NamedSheetView;Retornos
A vista de folha atualmente ativa para esta folha de cálculo.
Comentários
getCount()
Obtém o número de vistas de folha nesta folha de cálculo. Inclui a vista de folha temporária, se existir.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém uma vista de folha com o respetivo nome.
getItem(key: string): Excel.NamedSheetView;Parâmetros
- key
-
string
O nome sensível às maiúsculas e minúsculas da vista de folha. Utilize a cadeia vazia ("") para obter a vista de folha temporária, se a vista temporária existir.
Retornos
A vista de folha com o nome especificado ou a vista temporária se tiver sido fornecida uma cadeia vazia. Se não existir uma vista temporária atual e for fornecida uma cadeia vazia, é gerado um ItemNotFound erro.
Comentários
getItemAt(index)
Obtém uma vista de folha pelo respetivo índice na coleção.
getItemAt(index: number): Excel.NamedSheetView;Parâmetros
- index
-
number
O índice do objeto de vista de folha na coleção.
Retornos
A vista de folha no índice especificado.
Comentários
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 vista de folha com o respetivo nome. Se o objeto de vista de folha não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).
getItemOrNullObject(key: string): Excel.NamedSheetView;Parâmetros
- key
-
string
O nome sensível às maiúsculas e minúsculas da vista de folha. Utilize a cadeia vazia ("") para obter a vista de folha temporária, se a vista temporária existir.
Retornos
A vista de folha com o nome especificado ou a vista temporária se tiver sido fornecida uma cadeia vazia.
Comentários
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 as propriedades do objeto a carregar.
Retornos
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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
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 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
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.NamedSheetViewCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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;