Excel.NamedSheetViewCollection class
Représente l’ensemble des feuilles personnelles de la feuille de calcul.
- Extends
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(name) | Crée un nouvel affichage de feuille avec le nom donné. |
| enter |
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 sortie de l’affichage temporaire avec la méthode de sortie ou du basculement vers un autre affichage de feuille. La vue temporaire de la feuille est également accessible avec la chaîne vide (« »), si la vue temporaire existe. |
| exit() | Quitte la vue de feuille actuellement active. |
| get |
Obtient l’affichage de feuille actuellement actif de la feuille de calcul. |
| get |
Obtient le nombre de feuilles vues dans cette feuille de calcul. Inclut l’affichage de feuille temporaire, le cas échéant. |
| get |
Obtient un affichage de feuille en utilisant son nom. |
| get |
Obtient un affichage de feuille par son index dans la collection. |
| get |
Obtient un affichage de feuille en utilisant son nom. Si l’objet du mode Feuille n’existe pas, cette méthode renvoie un objet dont la |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
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 nouvel affichage de feuille avec le nom donné.
add(name: string): Excel.NamedSheetView;Paramètres
- name
-
string
Nom de l’affichage de feuille à créer. Génère une erreur lorsque le nom fourni existe déjà, est vide ou est un nom réservé par la feuille de calcul.
Retours
Objet Feuille personnelle nouvellement créé.
Remarques
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 sortie de l’affichage temporaire avec la méthode de sortie ou du basculement vers un autre affichage de feuille. La vue temporaire de la feuille est également accessible avec la chaîne vide (« »), si la vue temporaire existe.
enterTemporary(): Excel.NamedSheetView;Retours
Objet Feuille personnelle nouvellement créé.
Remarques
exit()
Quitte la vue de feuille actuellement active.
exit(): void;Retours
void
Remarques
getActive()
Obtient l’affichage de feuille actuellement actif de la feuille de calcul.
getActive(): Excel.NamedSheetView;Retours
Affichage de feuille actuellement actif pour cette feuille de calcul.
Remarques
getCount()
Obtient le nombre de feuilles vues dans cette feuille de calcul. Inclut l’affichage de feuille temporaire, le cas échéant.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Obtient un affichage de feuille en utilisant son nom.
getItem(key: string): Excel.NamedSheetView;Paramètres
- key
-
string
Nom de l’affichage de la feuille qui respecte la casse. Utilisez la chaîne vide (« ») pour obtenir la vue de feuille temporaire, si cette vue temporaire existe.
Retours
Affichage de feuille avec le nom donné, ou affichage temporaire si une chaîne vide était fournie. S’il n’existe aucune vue temporaire actuelle et qu’une chaîne vide a été fournie, une ItemNotFound erreur est générée.
Remarques
getItemAt(index)
Obtient un affichage 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 de la collection.
Retours
Feuille personnelle à l’index donné.
Remarques
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 un affichage de feuille en utilisant son nom. Si l’objet du mode Feuille n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(key: string): Excel.NamedSheetView;Paramètres
- key
-
string
Nom de l’affichage de la feuille qui respecte la casse. Utilisez la chaîne vide (« ») pour obtenir la vue de feuille temporaire, si cette vue temporaire existe.
Retours
Affichage de feuille avec le nom donné, ou affichage temporaire si une chaîne vide était fournie.
Remarques
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 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 propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.NamedSheetViewCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.NamedSheetViewCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;