Excel.NamedSheetViewCollection class

Représente la collection d’affichages de feuille dans la feuille de calcul.

Extends

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

items

Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(name)

Crée un affichage feuille avec le nom donné.

enterTemporary()

Crée et active un nouvel affichage de feuille temporaire. Les affichages temporaires sont supprimés lors de la fermeture de l’application, de la fermeture de l’affichage temporaire avec la méthode de sortie ou du basculement vers une autre vue de feuille. L’affichage feuille temporaire peut également être acccessé avec la chaîne vide («  »), si l’affichage temporaire existe.

exit()

Quitte l’affichage feuille actif.

getActive()

Obtient l’affichage feuille de calcul actif.

getCount()

Obtient le nombre d’affichages de feuille dans cette feuille de calcul. Inclut l’affichage feuille temporaire s’il existe.

getItem(key)

Obtient une vue de feuille à l’aide de son nom.

getItemAt(index)

Obtient une vue de feuille par son index dans la collection.

getItemOrNullObject(key)

Obtient une vue de feuille à l’aide de son nom. Si l’objet d’affichage feuille n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.NamedSheetViewCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.NamedSheetViewCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

context: RequestContext;

Valeur de propriété

items

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.NamedSheetView[];

Valeur de propriété

Détails de la méthode

add(name)

Crée un affichage feuille avec le nom donné.

add(name: string): Excel.NamedSheetView;

Paramètres

name

string

Nom de la vue de feuille à créer. Envoie une erreur lorsque le nom fourni existe déjà, est vide ou est un nom réservé par la feuille de calcul.

Retours

Objet d’affichage feuille nouvellement créé.

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

enterTemporary()

Crée et active un nouvel affichage de feuille temporaire. Les affichages temporaires sont supprimés lors de la fermeture de l’application, de la fermeture de l’affichage temporaire avec la méthode de sortie ou du basculement vers une autre vue de feuille. L’affichage feuille temporaire peut également être acccessé avec la chaîne vide («  »), si l’affichage temporaire existe.

enterTemporary(): Excel.NamedSheetView;

Retours

Objet d’affichage feuille nouvellement créé.

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

exit()

Quitte l’affichage feuille actif.

exit(): void;

Retours

void

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

getActive()

Obtient l’affichage feuille de calcul actif.

getActive(): Excel.NamedSheetView;

Retours

Affichage feuille actuellement actif pour cette feuille de calcul.

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

getCount()

Obtient le nombre d’affichages de feuille dans cette feuille de calcul. Inclut l’affichage feuille temporaire s’il existe.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

getItem(key)

Obtient une vue de feuille à l’aide de son nom.

getItem(key: string): Excel.NamedSheetView;

Paramètres

key

string

Nom sensible à la cas de l’affichage feuille. Utilisez la chaîne vide («  ») pour obtenir la vue de feuille temporaire, si l’affichage temporaire existe.

Retours

Affichage feuille avec le nom donné ou affichage temporaire si une chaîne vide a été fournie. S’il n’existe aucun affichage temporaire actuel et qu’une chaîne vide a été fournie, une ItemNotFound erreur est lancée.

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

getItemAt(index)

Obtient une vue de feuille par son index dans la collection.

getItemAt(index: number): Excel.NamedSheetView;

Paramètres

index

number

Index de l’objet de vue de feuille dans la collection.

Retours

Vue de feuille à l’index donné.

Remarques

[Ensemble d’API : ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient une vue de feuille à l’aide de son nom. Si l’objet d’affichage feuille n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getItemOrNullObject(key: string): Excel.NamedSheetView;

Paramètres

key

string

Nom sensible à la cas de l’affichage feuille. Utilisez la chaîne vide («  ») pour obtenir la vue de feuille temporaire, si l’affichage temporaire existe.

Retours

Affichage feuille avec le nom donné ou affichage temporaire si une chaîne vide a été fournie.

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;

Paramètres

options

Excel.Interfaces.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fournit des options pour lesquelles les propriétés de l’objet à charger.

Retours

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.NamedSheetViewCollection;

Paramètres

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedSheetViewCollection;

Paramètres

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

toJSON()

Remplace la méthode JavaScript afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.NamedSheetViewCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.NamedSheetViewCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;

Retours