PowerPoint.ShapeFont class
Stellt die Schriftartattribute (z. B. Schriftartname, Schriftgrad und Schriftfarbe) für das TextRange-Objekt einer Form dar.
- Extends
Hinweise
Verwendet von
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
const parentTextFrame: PowerPoint.TextFrame = textRange.getParentTextFrame();
const parentShape: PowerPoint.Shape = parentTextFrame.getParentShape();
const parentSlide: PowerPoint.Slide = parentShape.getParentSlide();
parentShape.load("id");
parentSlide.load("id");
await context.sync();
console.log(`Selected text range found in parent shape with ID ${parentShape.id} on parentSlide with ID ${parentSlide.id}`);
console.log("Font properties of selected text range:");
console.log(`\tallCaps: ${textRange.font.allCaps}`);
console.log(`\tbold: ${textRange.font.bold}`);
console.log(`\tcolor: ${textRange.font.color}`);
console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
console.log(`\titalic: ${textRange.font.italic}`);
console.log(`\tname: ${textRange.font.name}`);
console.log(`\tsize: ${textRange.font.size}`);
console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
console.log(`\tsubscript: ${textRange.font.subscript}`);
console.log(`\tsuperscript: ${textRange.font.superscript}`);
console.log(`\tunderline: ${textRange.font.underline}`);
console.log("Paragraph format properties of selected text range:");
console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});
Eigenschaften
| all |
Gibt an, ob für den Text im
|
| bold | Gibt an, ob der Text im fett
|
| color | Gibt die HTML-Farbcodedarstellung der Textfarbe an (z. B. "#FF0000" steht für Rot). Gibt zurück |
| context | Der dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden. |
| double |
Gibt an, ob für den Text im
|
| italic | Gibt an, ob der Text im auf
|
| name | Gibt den Namen der Schriftart an (z. B. "Calibri"). Wenn es sich bei dem Text um eine komplexe Schrift oder eine ostasiatische Sprache handelt, ist dies der entsprechende Schriftname. andernfalls ist es der lateinische Schriftname. Gibt zurück |
| size | Gibt den Schriftgrad in Punkt an (z. B. 11). Gibt zurück |
| small |
Gibt an, ob für den Text im
|
| strikethrough | Gibt an, ob für den Text im
|
| subscript | Gibt an, ob für den Text im
|
| superscript | Gibt an, ob der Text im für die
|
| underline | Gibt den Typ der Unterstreichung an, die auf die Schriftart angewendet wird. 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
allCaps
Gibt an, ob für den Text im TextRange das Attribut "Alles in Großbuchstaben" verwendet wird, wodurch Kleinbuchstaben als Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:
true: Der gesamte Text verfügt über das Attribut "Großbuchstaben ".false: Keiner der Texte ist mit dem Attribut "Großbuchstaben" versehen .null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text das Attribut "Alles in Großbuchstaben" aufweist.
allCaps: boolean | null;Eigenschaftswert
boolean | null
Hinweise
bold
Gibt an, ob der Text im fett TextRange formatiert ist. Die folgenden Werte sind möglich:
true: Der gesamte Text ist fett formatiert.false: Keiner der Texte ist fett formatiert.null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text fett formatiert ist.
bold: boolean | null;Eigenschaftswert
boolean | null
Hinweise
color
Gibt die HTML-Farbcodedarstellung der Textfarbe an (z. B. "#FF0000" steht für Rot). Gibt zurück null , wenn der Textfragmente TextRange mit unterschiedlichen Farben enthält.
color: string | null;Eigenschaftswert
string | null
Hinweise
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 dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
context: RequestContext;Eigenschaftswert
doubleStrikethrough
Gibt an, ob für den Text im TextRange das Attribut "Doppelt durchgestrichen" verwendet wird. Die folgenden Werte sind möglich:
true: Der gesamte Text weist das Attribut Doppelt durchgestrichen auf.false: Keiner der Texte weist das Attribut Doppelt durchgestrichen auf.null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text das Attribut Double strikethrough aufweist.
doubleStrikethrough: boolean | null;Eigenschaftswert
boolean | null
Hinweise
italic
Gibt an, ob der Text im auf TextRange kursiv gesetzt ist. Die folgenden Werte sind möglich:
true: Der gesamte Text ist kursiv.false: Keiner der Texte ist kursiv.null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text kursiv geschrieben ist.
italic: boolean | null;Eigenschaftswert
boolean | null
Hinweise
name
Gibt den Namen der Schriftart an (z. B. "Calibri"). Wenn es sich bei dem Text um eine komplexe Schrift oder eine ostasiatische Sprache handelt, ist dies der entsprechende Schriftname. andernfalls ist es der lateinische Schriftname. Gibt zurück null , ob der TextRange Text Fragmente mit unterschiedlichen Schriftartnamen enthält.
name: string | null;Eigenschaftswert
string | null
Hinweise
size
Gibt den Schriftgrad in Punkt an (z. B. 11). Gibt zurück null , wenn der Textfragmente mit unterschiedlichen TextRange Schriftgraden enthält.
size: number | null;Eigenschaftswert
number | null
Hinweise
smallCaps
Gibt an, ob für den Text im TextRange das Kapitälchen-Attribut verwendet wird, wodurch Kleinbuchstaben als kleine Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:
true: Der gesamte Text hat das Attribut Kapitälchen .false: Keiner der Texte weist das Attribut Kapitälchen auf.null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text das Attribut Kapitälchen aufweist.
smallCaps: boolean | null;Eigenschaftswert
boolean | null
Hinweise
strikethrough
Gibt an, ob für den Text im TextRange das Attribut "Durchgestrichen" verwendet wird. Die folgenden Werte sind möglich:
true: Der gesamte Text weist das Attribut "Durchgestrichen " auf.false: Keiner der Texte weist das Attribut "Durchgestrichen " auf.null: Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text das Attribut "Durchgestrichen" aufweist.
strikethrough: boolean | null;Eigenschaftswert
boolean | null
Hinweise
subscript
Gibt an, ob für den Text im TextRangeSubscript-Attribut die Verwendung des Subscript-Attributs festgelegt ist. Die folgenden Werte sind möglich:
true: Der gesamte Text verfügt über das Subscript-Attribut .false: Keiner der Texte verfügt über das Subscript-Attribut .null: Wird zurückgegeben, wenn ein Teil, aber nicht der gesamte Text das Subscript-Attribut aufweist.
subscript: boolean | null;Eigenschaftswert
boolean | null
Hinweise
superscript
Gibt an, ob der Text im für die TextRange Verwendung des Attributs "Hochgestellt" festgelegt ist. Die folgenden Werte sind möglich:
true: Der gesamte Text verfügt über das Attribut "Hochgestellt ".false: Keiner der Texte verfügt über das Attribut "Hochgestellt ".null: Wird zurückgegeben, wenn ein Teil, aber nicht der gesamte Text das Attribut "Hochgestellt" aufweist.
superscript: boolean | null;Eigenschaftswert
boolean | null
Hinweise
underline
Gibt den Typ der Unterstreichung an, die auf die Schriftart angewendet wird. Gibt zurück null , wenn der TextRange Textfragmente mit unterschiedlichen Unterstreichungsformatvorlagen 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" | null;Eigenschaftswert
PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null
Hinweise
Beispiele
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/shapes.yaml
// This function gets the collection of shapes on the first slide,
// and adds a brace pair, {}, to the collection, while specifying its
// location and size. Then it names the shape, sets its text and font
// color, and centers it inside the braces.
await PowerPoint.run(async (context) => {
const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
const braces: PowerPoint.Shape = shapes.addGeometricShape(PowerPoint.GeometricShapeType.bracePair, {
left: 100,
top: 400,
height: 50,
width: 150,
});
braces.name = "Braces";
braces.textFrame.textRange.text = "Shape text";
braces.textFrame.textRange.font.color = "purple";
braces.textFrame.textRange.font.underline = PowerPoint.ShapeFontUnderlineStyle.heavy;
braces.textFrame.verticalAlignment = PowerPoint.TextVerticalAlignment.middleCentered;
braces.textFrame.autoSizeSetting = PowerPoint.ShapeAutoSize.autoSizeShapeToFitText;
return context.sync();
});
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 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[]): 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 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
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 PowerPoint.ShapeFont Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als PowerPoint.Interfaces.ShapeFontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts enthält.
toJSON(): PowerPoint.Interfaces.ShapeFontData;