Partager via

Word.TextFrame class

  • Référence
Paquet:
word

Représente le cadre de texte d’un objet de forme.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Propriétés

autoSizeSetting

Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.
bottomMargin

Représente la marge bas, en points du cadre du texte.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
hasText

Spécifie si le cadre de texte contient du texte.
leftMargin

Représente la marge gauche, en points du cadre du texte.
noTextRotation

Renvoie la valeur True si le texte du cadre de texte ne doit pas pivoter lorsque la forme est pivotée.
orientation

Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez Word.ShapeTextOrientation .
rightMargin

Représente la marge droite, en points du cadre du texte.
topMargin

Représente la marge du haut, en points du cadre du texte.
verticalAlignment

Représente l’alignement vertical pour le style. Pour plus d’informations, consultez Word.ShapeTextVerticalAlignment .
wordWrap

Détermine si les lignes se cassent automatiquement pour insérer du texte à l’intérieur de la forme.

Méthodes

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.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
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.TextFrame est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TextFrameDataque ) 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é

autoSizeSetting

Paramètres de dimensionnement automatique pour le cadre de texte. Un bloc de texte peut être configuré pour ajuster automatiquement le texte pour le cadre du texte, pour ajuster automatiquement le bloc de texte au texte ou de ne pas effectuer tout problème de dimensionnement automatique.

autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";

Valeur de propriété

Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

bottomMargin

Représente la marge bas, en points du cadre du texte.

bottomMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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

hasText

Spécifie si le cadre de texte contient du texte.

readonly hasText: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

leftMargin

Représente la marge gauche, en points du cadre du texte.

leftMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

noTextRotation

Renvoie la valeur True si le texte du cadre de texte ne doit pas pivoter lorsque la forme est pivotée.

noTextRotation: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

orientation

Représente l’angle vers lequel le texte est orienté pour le cadre de texte. Pour plus d’informations, consultez Word.ShapeTextOrientation .

orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";

Valeur de propriété

Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

rightMargin

Représente la marge droite, en points du cadre du texte.

rightMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

topMargin

Représente la marge du haut, en points du cadre du texte.

topMargin: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

verticalAlignment

Représente l’alignement vertical pour le style. Pour plus d’informations, consultez Word.ShapeTextVerticalAlignment .

verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";

Valeur de propriété

Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

wordWrap

Détermine si les lignes se cassent automatiquement pour insérer du texte à l’intérieur de la forme.

wordWrap: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Détails de la méthode

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

Paramètres

options
Word.Interfaces.TextFrameLoadOptions

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

Retours

Word.TextFrame

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

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.TextFrame

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

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

Word.TextFrame

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Word.Interfaces.TextFrameUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Word.TextFrame): void;

Paramètres

properties
Word.TextFrame

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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Word.TextFrame est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.TextFrameDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Word.Interfaces.TextFrameData;

Retours

Word.Interfaces.TextFrameData

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

Retours

Word.TextFrame

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

Retours

Word.TextFrame