Word.Font class

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

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt an, ob die Schriftart fett formatiert ist. trueWenn die Schriftart fett formatiert ist, andernfalls wird . false

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 Dokument mit Lese-/Schreibrichtung von rechts nach links fett 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.

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 den 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 Dokument mit Leserichtung von rechts nach links 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 dem Objekt zugeordnete Anforderungskontext. 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 doppelt durchgestrichen ist. true Wenn die Schriftart als doppelt durchgestrichener Text formatiert ist, andernfalls falsewird .

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 : Keiner der Texte ist geprägt.

• null : Gibt zurück, wenn teilweise, aber nicht der gesamte Text geprägt ist.

emboss: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt einen EmphasisMark Wert an, der das Hervorhebungszeichen 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 graviert.

• false : Keiner der Texte ist eingraviert.

• null : Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text eingraviert ist.

engrave: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt ein FillFormat Objekt zurück, das Füllformatierungseigenschaften 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 Glühformatierung 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 markiert ist. trueWenn die Schriftart als ausgeblendeter Text formatiert ist, andernfalls wird . false

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 nullfest. Die zurückgegebene Hervorhebungsfarbe kann das Format '#RRGGBB', eine leere Zeichenfolge für gemischte Hervorhebungsfarben oder null keine Hervorhebungsfarbe haben. Hinweis: In Office für Windows Desktop sind nur die Standardfarben für Hervorhebungen verfügbar. Dies sind "Gelb", "Limette", "Türkis", "Pink", "Blau", "Rot", "Dunkelblau", "Blaugrün", "Grün", "Lila", "Dunkelrot", "Oliv", "Grau", "Hellgrau" und "Schwarz". Wenn das Add-In in Office für Windows Desktop ausgeführt wird, wird jede andere Farbe in die nächstliegende 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 ist. true Wenn die Schriftart kursiv ist, andernfalls false.

italic: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob die Schriftart in einem Dokument mit Lese-/Schreibrichtung von rechts nach links kursiv geschrieben wird. 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.

italicBidirectional: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt den Mindestschriftgrad 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 Font Objekt an.

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 einer 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 für lateinischen Text an (Zeichen mit Zeichencodes von 0 (Null) bis 127).

nameAscii: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt den Namen der Schriftart in einem Dokument mit Leserichtung von rechts nach links an.

nameBidirectional: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt den ostasiatischen Schriftnamen an.

nameFarEast: string;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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

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 Zahlenabstand für die Schriftart an.

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

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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

• true : Der gesamte Text ist gegliedert.

• false : Keiner der Texte ist umrissen.

• null : Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text umrissen ist.

outline: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt die Position von Text (in Punkten) relativ zur Grundlinie an.

position: number;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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

readonly reflection: Word.ReflectionFormat;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt den Skalierungsprozentsatz an, der auf die Schriftart angewendet wird.

scaling: number;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

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

• true : Der gesamte Text ist schattiert.

• false : Keiner der Texte ist schattiert.

• null : Wird zurückgegeben, wenn teilweise, aber nicht der gesamte Text schattiert ist.

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 in Punkten für Text mit der Schreibrichtung von rechts nach links an.

sizeBidirectional: number;

Eigenschaftswert

Hinweise

API-Satz: WordApiDesktop 1.3

Gibt an, ob die Schriftart als Kapitälchen formatiert ist, 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;

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. trueWenn die Schriftart als durchgestrichener Text formatiert ist, andernfalls wird . false

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 tiefgestellt ist. true Wenn die Schriftart tiefgestellt formatiert ist, andernfalls falsewird .

subscript: boolean;

Eigenschaftswert

Hinweise

API-Satz: WordApi 1.1

Gibt an, ob die Schriftart hochgestellt ist. trueWenn die Schriftart hochgestellt formatiert ist, andernfalls wird . false

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 3-dimensionale (3D) Effektformatierungseigenschaften 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 Font Objekt an. 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 manuelle Zeichenformatierungen.

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 sie übergeben wird.) Während das ursprüngliche Word.Font Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (als Word.Interfaces.FontData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften des ursprünglichen Objekts 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 aufrufübergreifend .sync 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 ein "InvalidObjectPath"-Fehler angezeigt wird, müssen Sie das Objekt der nachverfolgten Objektsammlung hinzufügen, wenn das Objekt zum ersten Mal erstellt wurde. Wenn dieses Objekt Teil einer Sammlung ist, sollten Sie auch die übergeordnete Sammlung 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 einen Aufruf durchführen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): Word.Font;

Gibt zurück