Word.Font class

Gibt an, ob die Schriftart als Großbuchstaben formatiert ist, wodurch 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;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart fett formatiert ist. true , wenn die Schriftart fett formatiert ist, falseandernfalls .

bold: boolean;

Eigenschaftswert

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.');
});

Gibt an, ob die Schriftart in einem Rechts-nach-links-Dokument 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.

boldBidirectional: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein BorderUniversalCollection -Objekt zurück, das alle Rahmen für die Schriftart darstellt.

readonly borders: Word.BorderUniversalCollection;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

color: string;

Eigenschaftswert

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.');
});

Gibt einen ColorIndex Wert an, der die Farbe für die Schriftart darstellt.

colorIndex: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Farbe für das Font Objekt in einem Rechts-nach-links-Sprachdokument an.

colorIndexBidirectional: Word.ColorIndex | "Auto" | "Black" | "Blue" | "Turquoise" | "BrightGreen" | "Pink" | "Red" | "Yellow" | "White" | "DarkBlue" | "Teal" | "Green" | "Violet" | "DarkRed" | "DarkYellow" | "Gray50" | "Gray25" | "ClassicRed" | "ClassicBlue" | "ByAuthor";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

context: RequestContext;

Eigenschaftswert

Gibt an, ob kontextbezogene Alternativen für die Schriftart aktiviert sind.

contextualAlternates: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Farbe an, die für diakritische Zeichen für das Font -Objekt verwendet werden soll. Sie können den Wert im Format "#RRGGBB" angeben.

diacriticColor: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob Microsoft Word die Anzahl der Zeichen pro Zeile für das entsprechende Font Objekt ignoriert.

disableCharacterSpaceGrid: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart einen doppelten Durchstreichungsstrich aufweist. true , wenn die Schriftart als doppelt durchgestrichenen Text formatiert ist, falseandernfalls .

doubleStrikeThrough: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Gibt an, ob die Schriftart als geprägt formatiert ist. Die folgenden Werte sind möglich:

• true : Der gesamte Text ist geprägt.

• false : Kein Text ist geprägt.

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

emboss: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt einen EmphasisMark Wert an, der die Hervorhebungsmarke für ein Zeichen oder eine festgelegte Zeichenfolge darstellt.

emphasisMark: Word.EmphasisMark | "None" | "OverSolidCircle" | "OverComma" | "OverWhiteCircle" | "UnderSolidCircle";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart als graviert formatiert ist. Die folgenden Werte sind möglich:

• true : Der gesamte Text ist eingraviert.

• false : Kein Text ist eingraviert.

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

engrave: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein FillFormat -Objekt zurück, das Füllformateigenschaften für die Schriftart enthält, die vom Textbereich verwendet wird.

readonly fill: Word.FillFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein GlowFormat -Objekt zurück, das die Leuchtformatierung für die Schriftart darstellt, die vom Textbereich verwendet wird.

readonly glow: Word.GlowFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart als ausgeblendet gekennzeichnet ist. true , wenn die Schriftart als ausgeblendeter Text formatiert ist, falseandernfalls .

hidden: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.2 ]

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 fest null. Die zurückgegebene Hervorhebungsfarbe kann das Format "#RRGGBB", eine leere Zeichenfolge für gemischte Hervorhebungsfarben oder null keine Hervorhebungsfarbe aufweisen. 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

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.');
});

Gibt an, ob die Schriftart kursiv formatiert ist. true , wenn die Schriftart kursiv formatiert ist, falseandernfalls .

italic: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Gibt an, ob die Schriftart in einem Rechts-nach-links-Sprachdokument kursiv formatiert 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.

italicBidirectional: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den minimalen Schriftgrad an, für den Microsoft Word das Kerning automatisch anpasst.

kerning: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Ligatureinstellung für das -Objekt an Font .

ligature: Word.Ligature | "None" | "Standard" | "Contextual" | "StandardContextual" | "Historical" | "StandardHistorical" | "ContextualHistorical" | "StandardContextualHistorical" | "Discretional" | "StandardDiscretional" | "ContextualDiscretional" | "StandardContextualDiscretional" | "HistoricalDiscretional" | "StandardHistoricalDiscretional" | "ContextualHistoricalDiscretional" | "All";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein LineFormat -Objekt zurück, das die Formatierung für eine Zeile angibt.

readonly line: Word.LineFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Namen der Schriftart an.

name: string;

Eigenschaftswert

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.');
});

Gibt die Schriftart an, die für lateinischen Text verwendet wird (Zeichen mit Zeichencodes von 0 (null) bis 127).

nameAscii: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Schriftartnamen in einem Rechts-nach-links-Dokument an.

nameBidirectional: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Namen der ostasiatischen Schriftart an.

nameFarEast: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Schriftart an, die für Zeichen mit Codes von 128 bis 255 verwendet wird.

nameOther: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Zahlenzeicheneinstellung für eine OpenType-Schriftart an.

numberForm: Word.NumberForm | "Default" | "Lining" | "OldStyle";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Einstellung für den Nummernabstand für die Schriftart an.

numberSpacing: Word.NumberSpacing | "Default" | "Proportional" | "Tabular";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart wie konturiert formatiert ist. Die folgenden Werte sind möglich:

• true : Der gesamte Text ist umrandet.

• false : Keiner des Texts ist umrissen.

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

outline: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt die Position des Texts (in Punkt) relativ zur Basislinie an.

position: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein ReflectionFormat -Objekt zurück, das die Reflektionsformatierung für eine Form darstellt.

readonly reflection: Word.ReflectionFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den auf die Schriftart angewendeten Skalierungsprozentsatz an.

scaling: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart als schattiert formatiert ist. Die folgenden Werte sind möglich:

• true : Der gesamte Text ist schattiert.

• false : Kein Text wird überschatt.

• null : Wird zurückgegeben, wenn ein Teil des Texts, aber nicht der gesamte Text beschatten wird.

shadow: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Schriftgrad in Punkt an.

size: number;

Eigenschaftswert

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.');
});

Gibt den Schriftgrad für Text von rechts nach links in Punkt an.

sizeBidirectional: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart als Kleinbuchstaben formatiert ist, wodurch 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;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Abstand zwischen Zeichen an.

spacing: number;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart durchgestrichen ist. true , wenn die Schriftart als durchgestrichenen Text formatiert ist, falseandernfalls .

strikeThrough: boolean;

Eigenschaftswert

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.');
});

Gibt den Stilsatz für die Schriftart an.

stylisticSet: Word.StylisticSet | "Default" | "Set01" | "Set02" | "Set03" | "Set04" | "Set05" | "Set06" | "Set07" | "Set08" | "Set09" | "Set10" | "Set11" | "Set12" | "Set13" | "Set14" | "Set15" | "Set16" | "Set17" | "Set18" | "Set19" | "Set20";

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt an, ob die Schriftart ein Tiefgestellt ist. true , wenn die Schriftart als tiefgestellt formatiert ist, falseandernfalls .

subscript: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Gibt an, ob die Schriftart hochgestellt ist. true , wenn die Schriftart hochgestellt formatiert ist, falseandernfalls .

superscript: boolean;

Eigenschaftswert

Hinweise

[ API-Satz: WordApi 1.1 ]

Gibt ein ColorFormat -Objekt zurück, das die Farbe für die Schriftart darstellt.

readonly textColor: Word.ColorFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein ShadowFormat -Objekt zurück, das die Schattenformatierung für die Schriftart angibt.

readonly textShadow: Word.ShadowFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt ein ThreeDimensionalFormat -Objekt zurück, das 3D-Effektformateigenschaften für die Schriftart enthält.

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Gibt den Unterstreichungstyp der Schriftart an. 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

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.');
});

Gibt die Farbe der Unterstreichung für das Objekt an Font . Sie können den Wert im Format "#RRGGBB" angeben.

underlineColor: string;

Eigenschaftswert

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Reduziert die Schriftgröße auf die nächste verfügbare Größe.

decreaseFontSize(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Erhöht den Schriftgrad auf den nächsten verfügbaren Grad.

increaseFontSize(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

Gibt zurück

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

Gibt zurück

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

Gibt zurück

Entfernt die manuelle Zeichenformatierung.

reset(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

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

Gibt zurück

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Word.Font): void;

Parameter

Gibt zurück

Legt die angegebene Schriftartformatierung als Standard für das aktive Dokument und alle neuen Dokumente fest, die auf der aktiven Vorlage basieren.

setAsTemplateDefault(): void;

Gibt zurück

Hinweise

[ API-Satz: WordApiDesktop 1.3 ]

Ü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 Word.Font Objekt ein API-Objekt ist, gibt die toJSON Methode 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

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

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