Freigeben über

Excel.TextFrame class

  • Referenz
Paket:
excel

Stellt den Textrahmen eines Formobjekts dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Eigenschaften

autoSizeSetting

Die Einstellungen für die automatische Größenanpassung für den Textrahmen. 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.
bottomMargin

Stellt den unteren Rand des Textrahmens in Punkt dar.
context

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

Gibt an, ob der Textrahmen Text enthält.
horizontalAlignment

Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextHorizontalAlignment .
horizontalOverflow

Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextHorizontalOverflow .
leftMargin

Stellt den linken Rand des Textrahmens in Punkt dar.
orientation

Stellt den Winkel dar, an dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen finden Sie unter Excel.ShapeTextOrientation .
readingOrder

Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter Excel.ShapeTextReadingOrder .
rightMargin

Stellt den rechten Rand des Textrahmens in Punkt dar.
textRange

Stellt den Text dar, der an eine Form im Textrahmen angefügt ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts. Weitere Informationen finden Sie unter Excel.TextRange .
topMargin

Stellt den oberen Rand des Textrahmens in Punkt dar.
verticalAlignment

Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextVerticalAlignment .
verticalOverflow

Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextVerticalOverflow .

Methoden

deleteText()

Löscht den gesamten Text im Textrahmen.
load(options)

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)

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)

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

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)

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

Ü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 Excel.TextFrame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TextFrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

autoSizeSetting

Die Einstellungen für die automatische Größenanpassung für den Textrahmen. 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: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

Eigenschaftswert

Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

bottomMargin

Stellt den unteren Rand des Textrahmens in Punkt dar.

bottomMargin: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

context

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

context: RequestContext;

Eigenschaftswert

Excel.RequestContext

hasText

Gibt an, ob der Textrahmen Text enthält.

readonly hasText: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.9 ]

horizontalAlignment

Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextHorizontalAlignment .

horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

Eigenschaftswert

Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

horizontalOverflow

Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextHorizontalOverflow .

horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

Eigenschaftswert

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

leftMargin

Stellt den linken Rand des Textrahmens in Punkt dar.

leftMargin: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

orientation

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

orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

Eigenschaftswert

Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

readingOrder

Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen finden Sie unter Excel.ShapeTextReadingOrder .

readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

Eigenschaftswert

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

rightMargin

Stellt den rechten Rand des Textrahmens in Punkt dar.

rightMargin: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

textRange

Stellt den Text dar, der an eine Form im Textrahmen angefügt ist, sowie Eigenschaften und Methoden für das Bearbeiten des Texts. Weitere Informationen finden Sie unter Excel.TextRange .

readonly textRange: Excel.TextRange;

Eigenschaftswert

Excel.TextRange

Hinweise

[ API-Satz: ExcelApi 1.9 ]

topMargin

Stellt den oberen Rand des Textrahmens in Punkt dar.

topMargin: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: ExcelApi 1.9 ]

verticalAlignment

Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextVerticalAlignment .

verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

Eigenschaftswert

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

verticalOverflow

Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen finden Sie unter Excel.ShapeTextVerticalOverflow .

verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

Eigenschaftswert

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Details zur Methode

deleteText()

Löscht den gesamten Text im Textrahmen.

deleteText(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Beispiele

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

load(options)

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?: Excel.Interfaces.TextFrameLoadOptions): Excel.TextFrame;

Parameter

options
Excel.Interfaces.TextFrameLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Excel.TextFrame

load(propertyNames)

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[]): Excel.TextFrame;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Excel.TextFrame

load(propertyNamesAndPaths)

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;
        }): Excel.TextFrame;

Parameter

propertyNamesAndPaths

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

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

Excel.TextFrame

set(properties, options)

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

properties
Excel.Interfaces.TextFrameUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

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

set(properties: Excel.TextFrame): void;

Parameter

properties
Excel.TextFrame

Gibt zurück

void

toJSON()

Ü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 Excel.TextFrame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.TextFrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.TextFrameData;

Gibt zurück

Excel.Interfaces.TextFrameData