Partager via


Word.DropCap class

Représente une lettre majuscule supprimée dans un document Word.

Extends

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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.

distanceFromText

Obtient la distance (en points) entre la lettre majuscule supprimée et le texte du paragraphe.

fontName

Obtient le nom de la police pour la lettre majuscule supprimée.

linesToDrop

Obtient la hauteur (en lignes) de la lettre majuscule supprimée.

position

Obtient la position de la lettre majuscule supprimée.

Méthodes

clear()

Annule la mise en forme lettrine.

enable()

Crée une lettrine à partir du premier caractère du paragraphe actif.

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.DropCap est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DropCapDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

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é

distanceFromText

Obtient la distance (en points) entre la lettre majuscule supprimée et le texte du paragraphe.

readonly distanceFromText: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

fontName

Obtient le nom de la police pour la lettre majuscule supprimée.

readonly fontName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

linesToDrop

Obtient la hauteur (en lignes) de la lettre majuscule supprimée.

readonly linesToDrop: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

position

Obtient la position de la lettre majuscule supprimée.

readonly position: Word.DropPosition | "None" | "Normal" | "Margin";

Valeur de propriété

Word.DropPosition | "None" | "Normal" | "Margin"

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

Détails de la méthode

clear()

Annule la mise en forme lettrine.

clear(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

enable()

Crée une lettrine à partir du premier caractère du paragraphe actif.

enable(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApiDesktop 1.4 ]

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

Paramètres

options
Word.Interfaces.DropCapLoadOptions

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

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?: {
            select?: string;
            expand?: string;
        }): Word.DropCap;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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 Word.DropCap est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.DropCapDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.DropCapData;

Retours

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.DropCap;

Retours

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.DropCap;

Retours