Word.StyleCollection class

Référence

Paquet:: word

Contient une collection de Word. Objets style.

Extends: OfficeExtension.ClientObject

Remarques

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

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

getByName(name)	Obtient l’objet de style par son nom.
getByNameOrNullObject(name)	Si le style correspondant n’existe pas, cette méthode retourne un objet avec sa `isNullObject` propriété définie sur `true`.
getCount()	Obtient le nombre de styles dans la collection.
getItem(index)	Obtient un objet de style par son index dans la collection.
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 `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 `Word.StyleCollection` est un objet API, la `toJSON` méthode renvoie un objet JavaScript brut (typé en tant `Word.Interfaces.StyleCollectionData`que ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des `.sync` appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler `context.sync()` avant que la mise en production de la mémoire ne prenne effet.

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é

Word.RequestContext

items

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

readonly items: Word.Style[];

Valeur de propriété

Word.Style[]

Détails de la méthode

getByName(name)

Obtient l’objet de style par son nom.

getByName(name: string): Word.Style;

Paramètres

name: string

Obligatoire. Nom du style.

Retours

Word.Style

Remarques

[ Ensemble d’API : WordApi 1.5 ]

getByNameOrNullObject(name)

Si le style correspondant n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true.

getByNameOrNullObject(name: string): Word.Style;

Paramètres

name: string

Obligatoire. Nom du style.

Retours

Word.Style

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = $("#new-style-name").val() as string;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ($("#new-style-type").val() as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

getCount()

Obtient le nombre de styles dans la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : WordApi 1.5 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

getItem(index)

Obtient un objet de style par son index dans la collection.

getItem(index: number): Word.Style;

Paramètres

index: number

Nombre qui identifie l’emplacement d’index d’un objet de style.

Retours

Word.Style

Remarques

[ Ensemble d’API : WordApi 1.5 ]

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?: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.StyleCollection;

Paramètres

options: Word.Interfaces.StyleCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions

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

Retours

Word.StyleCollection

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[]): Word.StyleCollection;

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

Word.StyleCollection

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): Word.StyleCollection;

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

Word.StyleCollection

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 Word.StyleCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.StyleCollectionDataque ) 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(): Word.Interfaces.StyleCollectionData;

Retours

Word.Interfaces.StyleCollectionData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.StyleCollection;

Retours

Word.StyleCollection

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.StyleCollection;

Retours

Word.StyleCollection

Partager via

Word.StyleCollection class

Remarques

Exemples

Propriétés

Méthodes

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

getByName(name)

Paramètres

Retours

Remarques

getByNameOrNullObject(name)

Paramètres

Retours

Remarques

Exemples

getCount()

Retours

Remarques

Exemples

getItem(index)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

track()

Retours

untrack()

Retours

Ressources supplémentaires