Word.Font class

Especifica se a fonte é formatada como todas as letras maiúsculas, o que faz com que as letras minúsculas apareçam como letras maiúsculas. Os valores possíveis são os seguintes:

• true : todo o texto tem o atributo Todas em maiúsculas .

• false : Nenhum texto tem o atributo Todas em maiúsculas .

• null : retornado se algumas, mas não todas, partes do texto tiverem o atributo Todas em maiúsculas .

allCaps: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte está em negrito. true Se a fonte estiver formatada em negrito, caso contrário, false.

bold: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica se a fonte é formatada como negrito em um documento de idioma da direita para a esquerda. Os valores possíveis são os seguintes:

• true : todo o texto está em negrito.

• false : Nenhum texto está em negrito.

• null : retornado se parte do texto, mas não todo, estiver em negrito.

boldBidirectional: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um BorderUniversalCollection objeto que representa todas as bordas da fonte.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a cor da fonte. Você pode fornecer o valor no formato '#RRGGBB' ou no nome da cor.

color: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica um ColorIndex valor que representa a cor da fonte.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a cor do Font objeto em um documento de idioma da direita para a esquerda.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Especifica se as alternativas contextuais estão habilitadas para a fonte.

contextualAlternates: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a cor a ser usada para diacríticos do Font objeto. Você pode fornecer o valor no formato '#RRGGBB'.

diacriticColor: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se o Microsoft Word ignora o número de caracteres por linha para o objeto correspondenteFont.

disableCharacterSpaceGrid: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte tem um tachado duplo. true Se a fonte estiver formatada como texto tachado duplo, caso contrário, false.

doubleStrikeThrough: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Especifica se a fonte é formatada como em relevo. Os valores possíveis são os seguintes:

• true : todo o texto é gravado em relevo.

• false : Nenhum texto é gravado em relevo.

• null : retornado se parte do texto, mas não todo, estiver em relevo.

emboss: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica um EmphasisMark valor que representa a marca de ênfase para um caractere ou cadeia de caracteres designada.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte é formatada como gravada. Os valores possíveis são os seguintes:

• true : Todo o texto é gravado.

• false : Nenhum texto é gravado.

• null : retornado se parte do texto, mas não todo, estiver gravado.

engrave: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um FillFormat objeto que contém propriedades de formatação de preenchimento para a fonte usada pelo intervalo de texto.

readonly fill: Word.FillFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um GlowFormat objeto que representa a formatação de brilho da fonte usada pelo intervalo de texto.

readonly glow: Word.GlowFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte está marcada como oculta. true Se a fonte estiver formatada como Texto Oculto, caso contrário, false.

hidden: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.2

Especifica a cor de realce. Para configurá-lo, use um valor no formato '#RRGGBB' ou no nome da cor. Para remover a cor de realce, defina-a como null. A cor de realce retornada pode estar no formato '#RRGGBB', uma cadeia de caracteres vazia para cores de realce mistas ou null para nenhuma cor de realce. Observação: Somente as cores de realce padrão estão disponíveis no Office para Windows Desktop. Estes são "Amarelo", "Lima", "Turquesa", "Rosa", "Azul", "Vermelho", "DarkBlue", "Verde", "Roxo", "DarkRed", "Olive", "Gray", "LightGray" e "Black". Quando o suplemento é executado no Office para área de trabalho do Windows, qualquer outra cor é convertida para a cor mais próxima quando aplicada à fonte.

highlightColor: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica se a fonte está em itálico. true Se a fonte estiver em itálico, caso contrário, false.

italic: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Especifica se a fonte está em itálico em um documento de idioma da direita para a esquerda. Os valores possíveis são os seguintes:

• true : todo o texto está em itálico.

• false : Nenhum texto está em itálico.

• null : retornado se parte do texto, mas não todo, estiver em itálico.

italicBidirectional: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o tamanho de fonte mínimo para o qual o Microsoft Word ajustará o kerning automaticamente.

kerning: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a configuração de ligadura para o Font objeto.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um LineFormat objeto que especifica a formatação de uma linha.

readonly line: Word.LineFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o nome da fonte.

name: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica a fonte usada para texto latino (caracteres com códigos de caractere de 0 (zero) a 127).

nameAscii: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o nome da fonte em um documento de idioma da direita para a esquerda.

nameBidirectional: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o nome da fonte do Leste Asiático.

nameFarEast: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a fonte usada para caracteres com códigos de 128 a 255.

nameOther: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a configuração da forma de número para uma fonte OpenType.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a configuração de espaçamento entre números para a fonte.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte é formatada conforme contornado. Os valores possíveis são os seguintes:

• true : Todo o texto está destacado.

• false : Nenhum texto está descrito acima.

• null : retornado se parte do texto, mas não todo, estiver com estrutura de tópicos.

outline: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a posição do texto (em pontos) em relação à linha de base.

position: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um ReflectionFormat objeto que representa a formatação de reflexão de uma forma.

readonly reflection: Word.ReflectionFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica a porcentagem de escala aplicada à fonte.

scaling: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte é formatada como sombreada. Os valores possíveis são os seguintes:

• true : todo o texto está sombreado.

• false : Nenhum texto está sombreado.

• null : retornado se parte do texto, mas não todo, estiver sombreado.

shadow: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o tamanho da fonte em pontos.

size: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica o tamanho da fonte em pontos para texto da direita para a esquerda.

sizeBidirectional: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte é formatada como versalete, o que faz com que letras minúsculas apareçam como letras maiúsculas pequenas. Os valores possíveis são os seguintes:

• true : todo o texto tem o atributo versalete .

• false : Nenhum texto tem o atributo versalete .

• null : retornado se parte do texto, mas não todo, tiver o atributo versalete .

smallCaps: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o espaçamento entre os caracteres.

spacing: number;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte tem um tachado. true Se a fonte estiver formatada como texto tachado, caso contrário, false.

strikeThrough: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica o conjunto estilístico para a fonte.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica se a fonte é um subscrito. true Se a fonte estiver formatada como subscrita, caso contrário, false.

subscript: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Especifica se a fonte é sobrescrita. true Se a fonte estiver formatada como sobrescrito, caso contrário, false.

superscript: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Retorna um ColorFormat objeto que representa a cor da fonte.

readonly textColor: Word.ColorFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um ShadowFormat objeto que especifica a formatação de sombra para a fonte.

readonly textShadow: Word.ShadowFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Retorna um ThreeDimensionalFormat objeto que contém propriedades de formatação de efeito tridimensionais (3D) para a fonte.

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Especifica o tipo de sublinhado da fonte. none Se a fonte não estiver sublinhada.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApi 1.1

Exemplos

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

Especifica a cor do sublinhado do Font objeto. Você pode fornecer o valor no formato '#RRGGBB'.

underlineColor: string;

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Diminui o tamanho da fonte para o próximo tamanho disponível.

decreaseFontSize(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Aumenta o tamanho da fonte para o próximo tamanho disponível.

increaseFontSize(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.FontLoadOptions): Word.Font;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.Font;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Font;

Parâmetros

Retornos

Remove a formatação manual dos caracteres.

reset(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.FontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Word.Font): void;

Parâmetros

Retornos

Define a formatação de fonte especificada como padrão para o documento ativo e para todos os novos documentos baseados no modelo ativo.

setAsTemplateDefault(): void;

Retornos

Comentários

Conjunto de APIs: WordApiDesktop 1.3

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Font é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.FontData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.FontData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Font;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Font;

Retornos