Freigeben über


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

allCaps

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Attribut "Alle Großbuchstaben " verwendet wird, mit dem Kleinbuchstaben als Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut All Caps auf .

  • false : Keiner des Texts verfügt über das Attribut "Alle Feststelltaste ".

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text das Attribut "Alle Feststelltaste " aufweist.

bold

Gibt an, ob der Text im TextRange fett formatiert ist. Die folgenden Werte sind möglich:

  • true : Der gesamte Text ist fett formatiert.

  • false : Kein Text ist fett formatiert.

  • null : Wird zurückgegeben, wenn ein Teil des Texts fett formatiert ist, aber nicht der gesamte Text.

color

Gibt die HTML-Farbcodedarstellung der Textfarbe an (z. B. "#FF0000" steht für Rot). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Farben enthält.

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

doubleStrikethrough

Gibt an, ob der Text im TextRange so festgelegt ist, dass er das Double-Durchstreichungsattribut verwendet. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Double strikethrough auf .

  • false : Keiner des Texts weist das Double-Durchgestrich-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text das Double-Durchstreichungsattribut aufweist.

italic

Gibt an, ob der Text im TextRange auf kursiv festgelegt ist. Die folgenden Werte sind möglich:

  • true : Der gesamte Text ist kursiv formatiert.

  • false : Kein Text ist kursiv formatiert.

  • null : Wird zurückgegeben, wenn ein Teil des Texts kursiv formatiert ist, aber nicht der gesamte Text.

name

Gibt den Namen der Schriftart an (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. Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftartnamen enthält.

size

Gibt den Schriftgrad in Punkt an (z. B. 11). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftgraden enthält.

smallCaps

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Small Caps-Attribut verwendet wird, mit dem Kleinbuchstaben als kleine Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Small Caps auf .

  • false : Keiner des Texts weist das Attribut Small Caps auf .

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Attribut Small Caps verfügt .

strikethrough

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Strikethrough-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Strikethrough-Attribut auf.

  • false : Keiner des Texts weist das Strikethrough-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Strikethrough-Attribut verfügt .

subscript

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Subscript-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Subscript auf.

  • false : Keiner des Texts weist das Subscript-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Subscript-Attribut verfügt.

superscript

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Superscript-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Superscript-Attribut auf.

  • false : Keiner des Texts weist das Superscript-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Hochgestellte Attribut verfügt.

underline

Gibt die Art der Unterstreichung an, die auf die Schriftart angewendet wird. Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Unterstreichungsstilen enthält. Weitere Informationen finden Sie unter PowerPoint.ShapeFontUnderlineStyle .

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 "context.sync()" aufrufen.

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(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.

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.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.

Details zur Eigenschaft

allCaps

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Attribut "Alle Großbuchstaben " verwendet wird, mit dem Kleinbuchstaben als Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut All Caps auf .

  • false : Keiner des Texts verfügt über das Attribut "Alle Feststelltaste ".

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text das Attribut "Alle Feststelltaste " aufweist.

allCaps: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

bold

Gibt an, ob der Text im TextRange fett formatiert ist. Die folgenden Werte sind möglich:

  • true : Der gesamte Text ist fett formatiert.

  • false : Kein Text ist fett formatiert.

  • null : Wird zurückgegeben, wenn ein Teil des Texts fett formatiert ist, aber nicht der gesamte Text.

bold: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

color

Gibt die HTML-Farbcodedarstellung der Textfarbe an (z. B. "#FF0000" steht für Rot). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Farben enthält.

color: string | null;

Eigenschaftswert

string | null

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

doubleStrikethrough

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass er das Double-Durchstreichungsattribut verwendet. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Double strikethrough auf .

  • false : Keiner des Texts weist das Double-Durchgestrich-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text das Double-Durchstreichungsattribut aufweist.

doubleStrikethrough: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

italic

Gibt an, ob der Text im TextRange auf kursiv festgelegt ist. Die folgenden Werte sind möglich:

  • true : Der gesamte Text ist kursiv formatiert.

  • false : Kein Text ist kursiv formatiert.

  • null : Wird zurückgegeben, wenn ein Teil des Texts kursiv formatiert ist, aber nicht der gesamte Text.

italic: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

name

Gibt den Namen der Schriftart an (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. Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftartnamen enthält.

name: string | null;

Eigenschaftswert

string | null

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

size

Gibt den Schriftgrad in Punkt an (z. B. 11). Gibt zurück null , wenn die TextRange Textfragmente mit unterschiedlichen Schriftgraden enthält.

size: number | null;

Eigenschaftswert

number | null

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

smallCaps

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Small Caps-Attribut verwendet wird, mit dem Kleinbuchstaben als kleine Großbuchstaben angezeigt werden. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Small Caps auf .

  • false : Keiner des Texts weist das Attribut Small Caps auf .

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Attribut Small Caps verfügt .

smallCaps: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

strikethrough

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Strikethrough-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Strikethrough-Attribut auf.

  • false : Keiner des Texts weist das Strikethrough-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Strikethrough-Attribut verfügt .

strikethrough: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

subscript

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Subscript-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Attribut Subscript auf.

  • false : Keiner des Texts weist das Subscript-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Subscript-Attribut verfügt.

subscript: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

superscript

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Gibt an, ob der Text im TextRange so festgelegt ist, dass das Superscript-Attribut verwendet wird. Die folgenden Werte sind möglich:

  • true : Der gesamte Text weist das Superscript-Attribut auf.

  • false : Keiner des Texts weist das Superscript-Attribut auf.

  • null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text über das Hochgestellte Attribut verfügt.

superscript: boolean | null;

Eigenschaftswert

boolean | null

Hinweise

[ API-Satz: PowerPointApi BETA (NUR VORSCHAU) ]

underline

Gibt die Art der Unterstreichung an, die auf die Schriftart angewendet wird. 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" | null;

Eigenschaftswert

PowerPoint.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble" | null

Hinweise

[ API-Satz: PowerPointApi 1.4 ]

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

options
PowerPoint.Interfaces.ShapeFontLoadOptions

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.stringifyruft 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