Excel.NamedSheetViewCollection class
Représente la collection d’affichages feuille dans la feuille de calcul.
- Extends
Remarques
[ Ensemble d’API : ExcelApiOnline 1.1 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(name) | Crée une vue feuille avec le nom donné. |
| enter |
Crée et active une nouvelle vue de feuille temporaire. Les vues temporaires sont supprimées lors de la fermeture de l’application, de la sortie de la vue temporaire avec la méthode de sortie ou du basculement vers une autre vue feuille. La vue feuille temporaire est également accessible avec la chaîne vide (« »), si l’affichage temporaire existe. |
| exit() | Quitte l’affichage feuille actuellement actif. |
| get |
Obtient l’affichage feuille actuellement actif de la feuille de calcul. |
| get |
Obtient le nombre d’affichages de feuille dans cette feuille de calcul. Inclut l’affichage de feuille temporaire s’il existe. |
| get |
Obtient une vue de feuille à l’aide de son nom. |
| get |
Obtient une vue feuille par son index dans la collection. |
| get |
Obtient une vue de feuille à l’aide de son nom. Si l’objet en mode Feuille n’existe pas, cette méthode retourne un objet avec sa |
| 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 . Cela connecte le processus du complément au processus 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 une vue feuille avec le nom donné.
add(name: string): Excel.NamedSheetView;Paramètres
- name
-
string
Nom de l’affichage feuille à créer. Génère une erreur lorsque le nom fourni existe déjà, est vide ou s’il s’agit d’un nom réservé par la feuille de calcul.
Retours
Objet d’affichage feuille nouvellement créé.
Remarques
enterTemporary()
Crée et active une nouvelle vue de feuille temporaire. Les vues temporaires sont supprimées lors de la fermeture de l’application, de la sortie de la vue temporaire avec la méthode de sortie ou du basculement vers une autre vue feuille. La vue feuille temporaire est également accessible avec la chaîne vide (« »), si l’affichage temporaire existe.
enterTemporary(): Excel.NamedSheetView;Retours
Objet d’affichage feuille nouvellement créé.
Remarques
exit()
Quitte l’affichage feuille actuellement actif.
exit(): void;Retours
void
Remarques
getActive()
Obtient l’affichage feuille actuellement actif de la feuille de calcul.
getActive(): Excel.NamedSheetView;Retours
Affichage feuille actuellement actif pour cette feuille de calcul.
Remarques
getCount()
Obtient le nombre d’affichages de feuille dans cette feuille de calcul. Inclut l’affichage de feuille temporaire s’il existe.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(key)
Obtient une vue de feuille à l’aide de son nom.
getItem(key: string): Excel.NamedSheetView;Paramètres
- key
-
string
Nom respectant la casse de l’affichage feuille. Utilisez la chaîne vide (« ») pour obtenir l’affichage de feuille temporaire, si l’affichage temporaire existe.
Retours
Affichage feuille avec le nom donné, ou vue temporaire si une chaîne vide a été 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 une vue feuille par son index dans la collection.
getItemAt(index: number): Excel.NamedSheetView;Paramètres
- index
-
number
Index de l’objet en mode Feuille dans la collection.
Retours
Affichage feuille à 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 une vue de feuille à l’aide de son nom. Si l’objet en mode Feuille n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getItemOrNullObject(key: string): Excel.NamedSheetView;Paramètres
- key
-
string
Nom respectant la casse de l’affichage feuille. Utilisez la chaîne vide (« ») pour obtenir l’affichage de feuille temporaire, si l’affichage temporaire existe.
Retours
Affichage feuille avec le nom donné, ou vue temporaire si une chaîne vide a été 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 qui spécifient 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.NamedSheetViewCollectionDataque ) qui 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;