Excel.TextFrame class

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Stellt den unteren Rand des Textrahmens in Punkt dar.

bottomMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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 an, ob der Textrahmen Text enthält.

readonly hasText: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Stellt den linken Rand des Textrahmens in Punkt dar.

leftMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Stellt den rechten Rand des Textrahmens in Punkt dar.

rightMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Stellt den oberen Rand des Textrahmens in Punkt dar.

topMargin: number;

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

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

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

Eigenschaftswert

Hinweise

[ API-Satz: ExcelApi 1.9 ]

Löscht den gesamten Text im Textrahmen.

deleteText(): void;

Gibt zurück

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

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

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