Word.TextFrame class

Spécifie les 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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Sets text frame properties of the first text box in the main document.
  const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
  shape.load("textFrame");
  await context.sync();

  if (shape.isNullObject) {
    console.log("No shapes with text boxes found in the main document.");
    return;
  }

  const textFrame: Word.TextFrame = shape.textFrame;
  textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
  textFrame.orientation = Word.ShapeTextOrientation.vertical270;
  textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;

  console.log("The first text box's text frame properties were updated:", textFrame);
});

Spécifie la marge inférieure, en points, du cadre de texte.

bottomMargin: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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é

Retourne true si le cadre de texte contient du texte ; sinon, false.

readonly hasText: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie la marge gauche, en points, du cadre de texte.

leftMargin: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie si le texte du cadre de texte ne doit pas pivoter lorsque la forme est pivotée.

noTextRotation: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie 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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Sets text frame properties of the first text box in the main document.
  const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
  shape.load("textFrame");
  await context.sync();

  if (shape.isNullObject) {
    console.log("No shapes with text boxes found in the main document.");
    return;
  }

  const textFrame: Word.TextFrame = shape.textFrame;
  textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
  textFrame.orientation = Word.ShapeTextOrientation.vertical270;
  textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;

  console.log("The first text box's text frame properties were updated:", textFrame);
});

Spécifie la marge droite, en points, du cadre de texte.

rightMargin: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie la marge supérieure, en points, du cadre de texte.

topMargin: number;

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Spécifie l’alignement vertical du cadre de texte. Pour plus d’informations, consultez Word.ShapeTextVerticalAlignment .

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

Valeur de propriété

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml

await Word.run(async (context) => {
  // Sets text frame properties of the first text box in the main document.
  const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
  shape.load("textFrame");
  await context.sync();

  if (shape.isNullObject) {
    console.log("No shapes with text boxes found in the main document.");
    return;
  }

  const textFrame: Word.TextFrame = shape.textFrame;
  textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
  textFrame.orientation = Word.ShapeTextOrientation.vertical270;
  textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;

  console.log("The first text box's text frame properties were updated:", textFrame);
});

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é

Remarques

[ Ensemble d’API : WordApiDesktop 1.2 ]

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

Retours

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

Retours

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

Retours

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

Retours

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

Retours

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

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

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