Word.TextFrame class

Gibt die Einstellungen für die automatische Größenanpassung für den Textrahmen an. Für einen Textrahmen kann automatische Anpassung des Texts an den Textrahmen, automatische Anpassung des Textrahmens an den Text oder gar keine automatische Größenanpassung festgelegt werden.

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Beispiele

// 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);
});

Gibt den unteren Rand des Textrahmens in Punkt an.

bottomMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt zurück true , wenn der Textrahmen Text enthält, falseandernfalls .

readonly hasText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Gibt den linken Rand des Textrahmens in Punkt an.

leftMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Gibt an, ob der Text im Textrahmen nicht gedreht werden soll, wenn die Form gedreht wird.

noTextRotation: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Gibt den Winkel an, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter Word.ShapeTextOrientation .

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Beispiele

// 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);
});

Gibt den rechten Rand des Textrahmens in Punkt an.

rightMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Gibt den oberen Rand des Textrahmens in Punkt an.

topMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Gibt die vertikale Ausrichtung des Textrahmens an. Weitere Informationen finden Sie unter Word.ShapeTextVerticalAlignment .

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

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Beispiele

// 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);
});

Bestimmt, ob Zeilen automatisch umbrechen, um Text in die Form einzupassen.

wordWrap: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Word.TextFrame;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TextFrame;

Parameter

Gibt zurück

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.TextFrame): void;

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Word.TextFrame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.TextFrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.TextFrameData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.TextFrame;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.TextFrame;

Gibt zurück