Word.Font class

  • Referência
Pacote:
word

Representa uma fonte.

Extends
OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.1 ]

Propriedades

bold

Especifica um valor que indica se a fonte é em negrito. True quando a fonte é formatada como negrito; caso contrário, false.
color

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

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

Especifica um valor que indica se a fonte tem um strikethrough duplo. True quando a fonte é formatada como texto tachado duplo; caso contrário, false.
hidden

Especifica um valor que indica se a fonte está marcada como oculta. True se a fonte for formatada como texto oculto, caso contrário, false.
highlightColor

Especifica a cor de destaque. Para defini-lo, use um valor no formato '#RRGGBB' ou no nome da cor. Para remover a cor de destaque, defina-a como nula. A cor de destaque retornada pode estar no formato '#RRGGBB', uma cadeia de caracteres vazia para cores de destaque misturadas ou nula para nenhuma cor de destaque. Observação: somente as cores de destaque padrão estão disponíveis no Office para Windows Desktop. Estes são "Amarelo", "Limão", "Turquesa", "Rosa", "Azul", "Vermelho", "DarkBlue", "Teal", "Verde", "Roxo", "DarkRed", "Olive", "Cinza", "LightGray" e "Preto". Quando o suplemento é executado no Office para Windows Desktop, qualquer outra cor é convertida na cor mais próxima quando aplicada à fonte.
italic

Especifica um valor que indica se a fonte está itállica. True quando a fonte está em itálico; caso contrário, false.
name

Especifica um valor que representa o nome da fonte.
size

Especifica um valor que representa o tamanho da fonte em pontos.
strikeThrough

Especifica um valor que indica se a fonte tem um strikethrough. True quando a fonte é formatada como texto tachado; caso contrário, false.
subscript

Especifica um valor que indica se a fonte é um subscript. True quando a fonte é formatada como subscrito; caso contrário, false.
superscript

Especifica um valor que indica se a fonte é um superscript. True quando a fonte é formatada como sobrescrito; caso contrário, false.
underline

Especifica um valor que indica o tipo de sublinhado da fonte. "Nenhum" se a fonte não for sublinhada.

Métodos

load(options)

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

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

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

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)

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

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

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para 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, você 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.
untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar context.sync() antes que a versão da memória entre em vigor.

Detalhes da propriedade

bold

Especifica um valor que indica se a fonte é em negrito. True quando a fonte é formatada como negrito; caso contrário, false.

bold: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 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.');
});

color

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

color: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 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.');
});

context

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

Word.RequestContext

doubleStrikeThrough

Especifica um valor que indica se a fonte tem um strikethrough duplo. True quando a fonte é formatada como texto tachado duplo; caso contrário, false.

doubleStrikeThrough: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

hidden

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Especifica um valor que indica se a fonte está marcada como oculta. True se a fonte for formatada como texto oculto, caso contrário, false.

hidden: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (SOMENTE VERSÃO PRÉVIA) ]

highlightColor

Especifica a cor de destaque. Para defini-lo, use um valor no formato '#RRGGBB' ou no nome da cor. Para remover a cor de destaque, defina-a como nula. A cor de destaque retornada pode estar no formato '#RRGGBB', uma cadeia de caracteres vazia para cores de destaque misturadas ou nula para nenhuma cor de destaque. Observação: somente as cores de destaque padrão estão disponíveis no Office para Windows Desktop. Estes são "Amarelo", "Limão", "Turquesa", "Rosa", "Azul", "Vermelho", "DarkBlue", "Teal", "Verde", "Roxo", "DarkRed", "Olive", "Cinza", "LightGray" e "Preto". Quando o suplemento é executado no Office para Windows Desktop, qualquer outra cor é convertida na cor mais próxima quando aplicada à fonte.

highlightColor: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 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.');
});

italic

Especifica um valor que indica se a fonte está itállica. True quando a fonte está em itálico; caso contrário, false.

italic: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

name

Especifica um valor que representa o nome da fonte.

name: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 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.');
});

size

Especifica um valor que representa o tamanho da fonte em pontos.

size: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: 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.');
});

strikeThrough

Especifica um valor que indica se a fonte tem um strikethrough. True quando a fonte é formatada como texto tachado; caso contrário, false.

strikeThrough: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 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.');
});

subscript

Especifica um valor que indica se a fonte é um subscript. True quando a fonte é formatada como subscrito; caso contrário, false.

subscript: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

superscript

Especifica um valor que indica se a fonte é um superscript. True quando a fonte é formatada como sobrescrito; caso contrário, false.

superscript: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi 1.1 ]

underline

Especifica um valor que indica o tipo de sublinhado da fonte. "Nenhum" se a fonte não for 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

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

Comentários

[ Conjunto de API: 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.');
});

Detalhes do método

load(options)

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

options
Word.Interfaces.FontLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Word.Font

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Word.Font

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Font

set(properties, options)

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

properties
Word.Interfaces.FontUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options
OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

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

set(properties: Word.Font): void;

Parâmetros

properties
Word.Font

Retornos

void

toJSON()

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

toJSON(): Word.Interfaces.FontData;

Retornos

Word.Interfaces.FontData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para 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, você 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

Word.Font

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é abreviada para 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á chamar context.sync() antes que a versão da memória entre em vigor.

untrack(): Word.Font;

Retornos

Word.Font