Excel.TextFrame class
Stellt den Textrahmen eines Formobjekts dar.
- Extends
Eigenschaften
| auto |
Die automatischen Größeneinstellungen 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. |
| bottom |
Stellt den unteren Rand des Textrahmens in Punkt dar. |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| has |
Gibt an, ob der Textrahmen Text enthält. |
| horizontal |
Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen findest du hier |
| horizontal |
Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen findest du hier |
| left |
Stellt den linken Rand des Textrahmens in Punkt dar. |
| orientation | Stellt den Winkel dar, in dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen findest du hier |
| reading |
Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen findest du hier |
| right |
Stellt den rechten Rand des Textrahmens in Punkt dar. |
| text |
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 findest du hier |
| top |
Stellt den oberen Rand des Textrahmens in Punkt dar. |
| vertical |
Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen findest du hier |
| vertical |
Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen findest du hier |
Methoden
| delete |
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 " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
Details zur Eigenschaft
autoSizeSetting
Die automatischen Größeneinstellungen 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
bottomMargin
Stellt den unteren Rand des Textrahmens in Punkt dar.
bottomMargin: number;Eigenschaftswert
number
Hinweise
context
Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
hasText
Gibt an, ob der Textrahmen Text enthält.
readonly hasText: boolean;Eigenschaftswert
boolean
Hinweise
horizontalAlignment
Stellt die horizontale Ausrichtung des Textrahmens dar. Weitere Informationen findest du hier Excel.ShapeTextHorizontalAlignment .
horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";Eigenschaftswert
Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"
Hinweise
horizontalOverflow
Stellt das horizontale Überlaufverhalten des Textrahmens dar. Weitere Informationen findest du hier Excel.ShapeTextHorizontalOverflow .
horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";Eigenschaftswert
Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"
Hinweise
leftMargin
Stellt den linken Rand des Textrahmens in Punkt dar.
leftMargin: number;Eigenschaftswert
number
Hinweise
orientation
Stellt den Winkel dar, in dem der Text für den Textrahmen ausgerichtet ist. Weitere Informationen findest du hier Excel.ShapeTextOrientation .
orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";Eigenschaftswert
Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"
Hinweise
readingOrder
Stellt die Lesereihenfolge des Textrahmens dar, entweder von links nach rechts oder von rechts nach links. Weitere Informationen findest du hier Excel.ShapeTextReadingOrder .
readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";Eigenschaftswert
Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"
Hinweise
rightMargin
Stellt den rechten Rand des Textrahmens in Punkt dar.
rightMargin: number;Eigenschaftswert
number
Hinweise
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 findest du hier Excel.TextRange .
readonly textRange: Excel.TextRange;Eigenschaftswert
Hinweise
topMargin
Stellt den oberen Rand des Textrahmens in Punkt dar.
topMargin: number;Eigenschaftswert
number
Hinweise
verticalAlignment
Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen findest du hier Excel.ShapeTextVerticalAlignment .
verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";Eigenschaftswert
Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"
Hinweise
verticalOverflow
Stellt das vertikale Überlaufverhalten des Textrahmens dar. Weitere Informationen findest du hier Excel.ShapeTextVerticalOverflow .
verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";Eigenschaftswert
Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"
Hinweise
Details zur Methode
deleteText()
Löscht den gesamten Text im Textrahmen.
deleteText(): void;Gibt zurück
void
Hinweise
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
Stellt Optionen für die zu ladenden Eigenschaften des Objekts bereit.
Gibt zurück
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
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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.
Gibt zurück
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
Bietet eine Option zum Unterdrücken von Fehlern, wenn das properties-Objekt 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 sie übergeben wird.) Während das ursprüngliche Excel.TextFrame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Excel.Interfaces.TextFrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): Excel.Interfaces.TextFrameData;