PowerPoint.ShapeFont class
Stellt die Schriftartattribute wie Schriftartname, Schriftgrad und Farbe für das TextRange-Objekt einer Form 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
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
Eigenschaften
bold | Stellt den Fett-Status der Schriftart dar. Gibt zurück |
color | HTML-Farbcodedarstellung der Textfarbe (z. B. "#FF0000" steht für Rot). Gibt zurück |
context | Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
italic | Stellt den Kursiv-Status der Schriftart dar. Gibt "null" zurück, wenn "TextRange" sowohl kursiv formatierte als auch nicht kursiv formatierte Textfragmente enthält. |
name | Stellt den Namen der Schriftart dar (z. B. "Calibri"). Wenn der Text eine komplexe Schrift oder eine ostasiatische Sprache ist, ist dies der entsprechende Schriftartname; andernfalls ist dies der lateinische Schriftartname. |
size | Stellt den Schriftgrad in Punkt dar (z. B. 11). Gibt NULL zurück, wenn das TextRange-Objekt Textabschnitte mit verschiedenen Schriftgraden enthält. |
underline | Art der auf die Schriftart angewendeten Unterstreichung. Gibt zurück |
Methoden
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
bold
Stellt den Fett-Status der Schriftart dar. Gibt zurück null
, wenn sowohl TextRange
fett formatierte als auch nicht fett formatierte Textfragmente enthalten sind.
bold: boolean;
Eigenschaftswert
boolean
Hinweise
color
HTML-Farbcodedarstellung der Textfarbe (z. B. "#FF0000" steht für Rot). Gibt zurück null
, wenn die TextRange
Textfragmente mit unterschiedlichen Farben enthält.
color: string;
Eigenschaftswert
string
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
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
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
italic
Stellt den Kursiv-Status der Schriftart dar. Gibt "null" zurück, wenn "TextRange" sowohl kursiv formatierte als auch nicht kursiv formatierte Textfragmente enthält.
italic: boolean;
Eigenschaftswert
boolean
Hinweise
name
Stellt den Namen der Schriftart dar (z. B. "Calibri"). Wenn der Text eine komplexe Schrift oder eine ostasiatische Sprache ist, ist dies der entsprechende Schriftartname; andernfalls ist dies der lateinische Schriftartname.
name: string;
Eigenschaftswert
string
Hinweise
size
Stellt den Schriftgrad in Punkt dar (z. B. 11). Gibt NULL zurück, wenn das TextRange-Objekt Textabschnitte mit verschiedenen Schriftgraden enthält.
size: number;
Eigenschaftswert
number
Hinweise
underline
Art der auf die Schriftart angewendeten Unterstreichung. Gibt zurück null
, wenn die TextRange
Textfragmente mit unterschiedlichen Unterstreichungsstilen enthält. Weitere Informationen finden Sie unter PowerPoint.ShapeFontUnderlineStyle .
underline: PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";
Eigenschaftswert
PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
Hinweise
Details zur Methode
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.ShapeFontLoadOptions): PowerPoint.ShapeFont;
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.ShapeFont;
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.ShapeFont;
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.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche PowerPoint.ShapeFont
Objekt ein API-Objekt ist, gibt die toJSON
Methode ein einfaches JavaScript-Objekt (typisiert als PowerPoint.Interfaces.ShapeFontData
) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): PowerPoint.Interfaces.ShapeFontData;
Gibt zurück
Office Add-ins