Visio.PageCollection class

Paquet:

visio

Représente une collection d’objets Page faisant partie du document.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : 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

getCount()	Obtient le nombre de pages de la collection.
getItem(key)	Obtient une page à l’aide de sa clé (nom ou ID).
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.
setMockData(data)	Définir des données fictives
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 Visio.PageCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Visio.Interfaces.PageCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

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é

Visio.RequestContext

items

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

readonly items: Visio.Page[];

Valeur de propriété

Visio.Page[]

Détails de la méthode

getCount()

Obtient le nombre de pages de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : 1.1 ]

getItem(key)

Obtient une page à l’aide de sa clé (nom ou ID).

getItem(key: number | string): Visio.Page;

Paramètres

key

number | string

La clé est le nom ou l’ID de la page à récupérer.

Retours

Visio.Page

Remarques

[ Ensemble d’API : 1.1 ]

Exemples

Visio.run(session, function (ctx) {
    const pageName = 'Page-1';
    const page = ctx.document.pages.getItem(pageName);
    page.activate();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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?: Visio.Interfaces.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.PageCollection;

Paramètres

options

Visio.Interfaces.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

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

Retours

Visio.PageCollection

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[]): Visio.PageCollection;

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

Visio.PageCollection

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): Visio.PageCollection;

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

Visio.PageCollection

setMockData(data)

Définir des données fictives

setMockData(data: Visio.Interfaces.PageCollectionData): void;

Paramètres

data

Visio.Interfaces.PageCollectionData

Retours

void

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 Visio.PageCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Visio.Interfaces.PageCollectionDataque ) 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(): Visio.Interfaces.PageCollectionData;

Retours

Visio.Interfaces.PageCollectionData