PowerPoint.TextFrame class
Stellt den Textrahmen eines Formobjekts dar.
- Extends
Hinweise
[ API-Satz: PowerPointApi 1.4 ]
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
await context.sync();
if (shapeCount.value !== 1) {
console.warn("You must select only one shape with text in it.");
return;
}
const shape: PowerPoint.Shape = shapes.getItemAt(0);
const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
await context.sync();
if (textFrame.hasText != true) {
console.warn("You must select only one shape with text in it.");
return;
}
const textRange: PowerPoint.TextRange = textFrame.textRange;
textRange.load("text");
await context.sync();
if (textRange.text.length < 10) {
console.warn("You must select only one shape with at least 10 characters in it.");
return;
}
const textRange10 = textRange.getSubstring(0, 10);
textRange10.setSelected();
await context.sync();
});
Eigenschaften
| auto |
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. |
| bottom |
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. |
| has |
Gibt an, ob der Textrahmen Text enthält. |
| left |
Stellt den linken Rand des Textrahmens in Punkt dar. |
| 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 finden Sie unter PowerPoint.TextRange . |
| top |
Stellt den oberen Rand des Textrahmens in Punkt dar. |
| vertical |
Stellt die vertikale Ausrichtung des Textrahmens dar. Weitere Informationen finden Sie unter PowerPoint.TextVerticalAlignment . |
| word |
Bestimmt, ob Zeilen automatisch umbrechen, um Text in die Form einzupassen. |
Methoden
| delete |
Löscht den gesamten Text im Textrahmen. |
| get |
Gibt das übergeordnete PowerPoint.Shape-Objekt zurück, das dieses |
| 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 " |
| toJSON() | Überschreibt die JavaScript-Methode |
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: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";Eigenschaftswert
PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"
Hinweise
bottomMargin
Stellt den unteren Rand des Textrahmens in Punkt dar.
bottomMargin: number;Eigenschaftswert
number
Hinweise
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
hasText
Gibt an, ob der Textrahmen Text enthält.
readonly hasText: boolean;Eigenschaftswert
boolean
Hinweise
leftMargin
Stellt den linken Rand des Textrahmens in Punkt dar.
leftMargin: number;Eigenschaftswert
number
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 finden Sie unter PowerPoint.TextRange .
readonly textRange: PowerPoint.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 finden Sie unter PowerPoint.TextVerticalAlignment .
verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";Eigenschaftswert
PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"
Hinweise
wordWrap
Bestimmt, ob Zeilen automatisch umbrechen, um Text in die Form einzupassen.
wordWrap: boolean;Eigenschaftswert
boolean
Hinweise
Details zur Methode
deleteText()
Löscht den gesamten Text im Textrahmen.
deleteText(): void;Gibt zurück
void
Hinweise
getParentShape()
Gibt das übergeordnete PowerPoint.Shape-Objekt zurück, das dieses TextFrameenthält.
getParentShape(): PowerPoint.Shape;Gibt zurück
Hinweise
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?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
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[]): PowerPoint.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;
}): PowerPoint.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
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 PowerPoint.TextFrame Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.TextFrameData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): PowerPoint.Interfaces.TextFrameData;Gibt zurück
Office Add-ins