Word.Font class

Paket:

word

Stellt eine Schriftart dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: WordApi 1.1 ]

Eigenschaften

bold	Gibt einen Wert an, der angibt, ob die Schriftart fett formatiert ist. True, wenn die Schriftart fett formatiert ist, andernfalls false.
color	Gibt die Farbe für die angegebene Schriftart an. Sie können den Wert im Format "#RRGGBB" oder im Farbnamen angeben.
context	Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
doubleStrikeThrough	Gibt einen Wert an, der angibt, ob die Schriftart doppelt durchgestrichen ist. True, wenn der Text doppelt durchgestrichen ist, andernfalls false.
hidden	Gibt einen Wert an, der angibt, ob die Schriftart als ausgeblendet gekennzeichnet ist. True, wenn die Schriftart als ausgeblendeter Text formatiert ist, andernfalls false.
highlightColor	Gibt die Hervorhebungsfarbe an. Verwenden Sie zum Festlegen einen Wert im Format "#RRGGBB" oder im Farbnamen. Um die Hervorhebungsfarbe zu entfernen, legen Sie sie auf NULL fest. Die zurückgegebene Hervorhebungsfarbe kann das Format "#RRGGBB", eine leere Zeichenfolge für gemischte Hervorhebungsfarben oder null für keine Hervorhebungsfarbe sein. Hinweis: Nur die standardmäßigen Hervorhebungsfarben sind in Office für Windows Desktop verfügbar. Dies sind "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" und "Black". Wenn das Add-In in Office für Windows Desktop ausgeführt wird, wird jede andere Farbe in die nächstgelegene Farbe konvertiert, wenn sie auf die Schriftart angewendet wird.
italic	Gibt einen Wert an, der angibt, ob die Schriftart kursiv formatiert ist. True, wenn die Schriftart kursiv ist, andernfalls false.
name	Gibt einen Wert an, der den Namen der Schriftart darstellt.
size	Gibt einen Wert an, der den Schriftgrad in Punkt darstellt.
strikeThrough	Gibt einen Wert an, der angibt, ob die Schriftart durchgestrichen ist. True, wenn der Text durchgestrichen ist, andernfalls false.
subscript	Gibt einen Wert an, der angibt, ob die Schriftart ein Tiefgestellt ist. True, wenn die Schriftart tiefgestellt ist, andernfalls false.
superscript	Gibt einen Wert an, der angibt, ob die Schriftart hochgestellt ist. True, wenn die Schriftart hochgestellt ist, andernfalls false.
underline	Gibt einen Wert an, der den Unterstreichungstyp der Schriftart angibt. "None", wenn die Schriftart nicht unterstrichen ist.

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.
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 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.) Die ursprüngliche Word. Font-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.FontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()	Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.
untrack()	Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

Details zur Eigenschaft

bold

Gibt einen Wert an, der angibt, ob die Schriftart fett formatiert ist. True, wenn die Schriftart fett formatiert ist, andernfalls false.

bold: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Bold format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to make the current selection bold.
    selection.font.bold = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection is now bold.');
});

color

Gibt die Farbe für die angegebene Schriftart an. Sie können den Wert im Format "#RRGGBB" oder im Farbnamen angeben.

color: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Change the font color
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the font color of the current selection.
    selection.font.color = 'blue';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font color of the selection has been changed.');
});

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

Word.RequestContext

doubleStrikeThrough

Gibt einen Wert an, der angibt, ob die Schriftart doppelt durchgestrichen ist. True, wenn der Text doppelt durchgestrichen ist, andernfalls false.

doubleStrikeThrough: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

hidden

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 einen Wert an, der angibt, ob die Schriftart als ausgeblendet gekennzeichnet ist. True, wenn die Schriftart als ausgeblendeter Text formatiert ist, andernfalls false.

hidden: boolean;

Eigenschaftswert

boolean

Hinweise

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

highlightColor

Gibt die Hervorhebungsfarbe an. Verwenden Sie zum Festlegen einen Wert im Format "#RRGGBB" oder im Farbnamen. Um die Hervorhebungsfarbe zu entfernen, legen Sie sie auf NULL fest. Die zurückgegebene Hervorhebungsfarbe kann das Format "#RRGGBB", eine leere Zeichenfolge für gemischte Hervorhebungsfarben oder null für keine Hervorhebungsfarbe sein. Hinweis: Nur die standardmäßigen Hervorhebungsfarben sind in Office für Windows Desktop verfügbar. Dies sind "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" und "Black". Wenn das Add-In in Office für Windows Desktop ausgeführt wird, wird jede andere Farbe in die nächstgelegene Farbe konvertiert, wenn sie auf die Schriftart angewendet wird.

highlightColor: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Highlight selected text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to highlight the current selection.
    selection.font.highlightColor = '#FFFF00'; // Yellow

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection has been highlighted.');
});

italic

Gibt einen Wert an, der angibt, ob die Schriftart kursiv formatiert ist. True, wenn die Schriftart kursiv ist, andernfalls false.

italic: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

name

Gibt einen Wert an, der den Namen der Schriftart darstellt.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Change the font name
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font name.
    selection.font.name = 'Arial';

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font name has changed.');
});

size

Gibt einen Wert an, der den Schriftgrad in Punkt darstellt.

size: number;

Eigenschaftswert

number

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Change the font size
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to change the current selection's font size.
    selection.font.size = 20;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The font size has changed.');
});

strikeThrough

Gibt einen Wert an, der angibt, ob die Schriftart durchgestrichen ist. True, wenn der Text durchgestrichen ist, andernfalls false.

strikeThrough: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Strike format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to strikethrough the font of the current selection.
    selection.font.strikeThrough = true;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has a strikethrough.');
});

subscript

Gibt einen Wert an, der angibt, ob die Schriftart ein Tiefgestellt ist. True, wenn die Schriftart tiefgestellt ist, andernfalls false.

subscript: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

superscript

Gibt einen Wert an, der angibt, ob die Schriftart hochgestellt ist. True, wenn die Schriftart hochgestellt ist, andernfalls false.

superscript: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: WordApi 1.1 ]

underline

Gibt einen Wert an, der den Unterstreichungstyp der Schriftart angibt. "None", wenn die Schriftart nicht unterstrichen ist.

underline: Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble";

Eigenschaftswert

Word.UnderlineType | "Mixed" | "None" | "Hidden" | "DotLine" | "Single" | "Word" | "Double" | "Thick" | "Dotted" | "DottedHeavy" | "DashLine" | "DashLineHeavy" | "DashLineLong" | "DashLineLongHeavy" | "DotDashLine" | "DotDashLineHeavy" | "TwoDotDashLine" | "TwoDotDashLineHeavy" | "Wave" | "WaveHeavy" | "WaveDouble"

Hinweise

[ API-Satz: WordApi 1.1 ]

Beispiele

// Underline format text
// Run a batch operation against the Word object model.
await Word.run(async (context) => {

    // Create a range proxy object for the current selection.
    const selection = context.document.getSelection();

    // Queue a command to underline the current selection.
    selection.font.underline = Word.UnderlineType.single;

    // Synchronize the document state by executing the queued commands,
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('The selection now has an underline style.');
});

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?: Word.Interfaces.FontLoadOptions): Word.Font;

Parameter

options

Word.Interfaces.FontLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

Word.Font

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[]): Word.Font;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Word.Font

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;
        }): Word.Font;

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

Word.Font

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.FontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameter

properties

Word.Interfaces.FontUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options

OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt 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: Word.Font): void;

Parameter

properties

Word.Font

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 das Objekt übergeben wird.) Die ursprüngliche Word. Font-Objekt ist ein API-Objekt. Die toJSON Methode gibt ein einfaches JavaScript-Objekt (typisiert als Word.Interfaces.FontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Word.Interfaces.FontData;

Gibt zurück

Word.Interfaces.FontData

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Auflistung ist, sollten Sie auch die übergeordnete Auflistung nachverfolgen.

track(): Word.Font;

Gibt zurück

Word.Font

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Font;

Gibt zurück

Word.Font