Word.Font class

Pacote:

word

Representa uma fonte.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: WordApi 1.1 ]

Propriedades

bold	Especifica um valor que indica se o tipo de letra está a negrito. True quando a fonte é formatada como negrito; caso contrário, false.
color	Especifica a cor do tipo de letra especificado. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
doubleStrikeThrough	Especifica um valor que indica se o tipo de letra tem uma rasurado dupla. True quando a fonte é formatada como texto tachado duplo; caso contrário, false.
hidden	Especifica um valor que indica se o tipo de letra está marcado como oculto. Verdadeiro se o tipo de letra estiver formatado como texto oculto, caso contrário, falso.
highlightColor	Especifica a cor de realce. Para o definir, utilize um valor no formato "#RRGGBB" ou no nome da cor. Para remover a cor do realce, defina-a como nula. A cor de realce devolvida pode estar no formato "#RRGGBB", numa cadeia vazia para cores de realce mistas ou nula sem cor de realce. Nota: apenas as cores de realce predefinidas estão disponíveis no Office para Ambiente de Trabalho do Windows. Estes são "Amarelo", "Lima", "Turquesa", "Rosa", "Azul", "Vermelho", "Azul Escuro", "Teal", "Verde", "Roxo", "Cinzento", "Cinzento", "Claro" e "Preto". Quando o suplemento é executado no Office para Ambiente de Trabalho do Windows, qualquer outra cor é convertida para a cor mais próxima quando aplicada ao tipo de letra.
italic	Especifica um valor que indica se o tipo de letra está em itálico. True quando a fonte está em itálico; caso contrário, false.
name	Especifica um valor que representa o nome do tipo de letra.
size	Especifica um valor que representa o tamanho do tipo de letra em pontos.
strikeThrough	Especifica um valor que indica se o tipo de letra tem uma rasurado. True quando a fonte é formatada como texto tachado; caso contrário, false.
subscript	Especifica um valor que indica se o tipo de letra é inferior à linha. True quando a fonte é formatada como subscrito; caso contrário, false.
superscript	Especifica um valor que indica se o tipo de letra é superior à linha. True quando a fonte é formatada como sobrescrito; caso contrário, false.
underline	Especifica um valor que indica o tipo de sublinhado do tipo de letra. "Nenhum" se o tipo de letra não estiver sublinhado.

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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()	Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Font é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.FontData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

Detalhes da propriedade

bold

Especifica um valor que indica se o tipo de letra está a 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 do tipo de letra especificado. 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 do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

doubleStrikeThrough

Especifica um valor que indica se o tipo de letra tem uma rasurado dupla. 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 o tipo de letra está marcado como oculto. Verdadeiro se o tipo de letra estiver formatado como texto oculto, caso contrário, falso.

hidden: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: WordApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

highlightColor

Especifica a cor de realce. Para o definir, utilize um valor no formato "#RRGGBB" ou no nome da cor. Para remover a cor do realce, defina-a como nula. A cor de realce devolvida pode estar no formato "#RRGGBB", numa cadeia vazia para cores de realce mistas ou nula sem cor de realce. Nota: apenas as cores de realce predefinidas estão disponíveis no Office para Ambiente de Trabalho do Windows. Estes são "Amarelo", "Lima", "Turquesa", "Rosa", "Azul", "Vermelho", "Azul Escuro", "Teal", "Verde", "Roxo", "Cinzento", "Cinzento", "Claro" e "Preto". Quando o suplemento é executado no Office para Ambiente de Trabalho do Windows, qualquer outra cor é convertida para a cor mais próxima quando aplicada ao tipo de letra.

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 o tipo de letra está em itálico. 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 do tipo de letra.

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 do tipo de letra 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 o tipo de letra tem uma rasurado. 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 o tipo de letra é inferior à linha. 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 o tipo de letra é superior à linha. 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 do tipo de letra. "Nenhum" se o tipo de letra não estiver sublinhado.

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 as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Word.Font

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas 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 que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num 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 é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.Font é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.FontData) que contém cópias rasas de quaisquer propriedades subordinadas 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. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este 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, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.Font;

Retornos

Word.Font

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta 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. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.Font;

Retornos

Word.Font