Word.Font class

Especifica se o tipo de letra está formatado 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 as Maiúsculas .

• false : nenhum dos textos tem o atributo Todas as Maiúsculas .

• null : devolvido se algum, mas não todos, do texto tiver o atributo Todas as Maiúsculas .

allCaps: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está a negrito. true se o tipo de letra estiver formatado como negrito, caso contrário, false.

bold: boolean;

Valor da propriedade

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

Especifica se o tipo de letra está formatado como negrito num documento de idioma da direita para a esquerda. Os valores possíveis são os seguintes:

• true : todo o texto está a negrito.

• false : nenhum dos textos está a negrito.

• null : devolvido se algum, mas não todos, do texto estiver a negrito.

boldBidirectional: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um BorderUniversalCollection objeto que representa todos os limites do tipo de letra.

readonly borders: Word.BorderUniversalCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a cor do tipo de letra. Pode fornecer o valor no formato "#RRGGBB" ou no nome da cor.

color: string;

Valor da propriedade

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

Especifica um ColorIndex valor que representa a cor do tipo de letra.

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 API: WordApiDesktop 1.3 ]

Especifica a cor do Font objeto num 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 API: WordApiDesktop 1.3 ]

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

Especifica se as alternativas contextuais estão ativadas para o tipo de letra.

contextualAlternates: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a cor a ser utilizada para diacríticos para o Font objeto. Pode fornecer o valor no formato "#RRGGBB".

diacriticColor: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

disableCharacterSpaceGrid: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra tem uma rasurado dupla. true se o tipo de letra estiver formatado como texto rasurado duplo, caso contrário, false.

doubleStrikeThrough: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Especifica se o tipo de letra está formatado como embossado. Os valores possíveis são os seguintes:

• true : todo o texto é incorporado.

• false : nenhum dos textos é incorporado.

• null : devolvido se algum, mas não todos, do texto for incorporado.

emboss: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica um EmphasisMark valor que representa a marca de ênfase para um caráter ou uma cadeia de carateres designada.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está formatado como gravado. Os valores possíveis são os seguintes:

• true : todo o texto está gravado.

• false : nenhum dos textos está gravado.

• null : devolvido se algum, mas não todos, do texto estiver gravado.

engrave: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um FillFormat objeto que contém propriedades de formatação de preenchimento para o tipo de letra utilizado pelo intervalo de texto.

readonly fill: Word.FillFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um GlowFormat objeto que representa a formatação de brilho para o tipo de letra utilizado pelo intervalo de texto.

readonly glow: Word.GlowFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está marcado como oculto. true se o tipo de letra estiver formatado como texto oculto, caso contrário, false.

hidden: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.2 ]

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 null. A cor de realce devolvida pode estar no formato "#RRGGBB", numa cadeia vazia para cores de realce mistas ou null 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

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

Especifica se o tipo de letra está em itálico. true se o tipo de letra estiver em itálico, caso contrário, false.

italic: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Especifica se o tipo de letra está em itálico num 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 dos textos está em itálico.

• null : devolvido se algum, mas não todos, do texto estiver em itálico.

italicBidirectional: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

kerning: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a definiçã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 API: WordApiDesktop 1.3 ]

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

readonly line: Word.LineFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o nome do tipo de letra.

name: string;

Valor da propriedade

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

Especifica o tipo de letra utilizado para texto latino (carateres com códigos de carateres de 0 (zero) a 127).

nameAscii: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o nome do tipo de letra num documento de idioma da direita para a esquerda.

nameBidirectional: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o nome do tipo de letra asiático.

nameFarEast: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o tipo de letra utilizado para carateres com códigos de 128 a 255.

nameOther: string;

Valor da propriedade

Comentários

[ Conjunto de API: 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 API: WordApiDesktop 1.3 ]

Especifica a definição de espaçamento numérico para o tipo de letra.

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

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está formatado conforme descrito. Os valores possíveis são os seguintes:

• true : todo o texto está delineado.

• false : nenhum dos textos é delineado.

• null : devolvido se algum, mas não todos, do texto estiver destacado.

outline: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

position: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um ReflectionFormat objeto que representa a formatação de reflexo de uma forma.

readonly reflection: Word.ReflectionFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica a percentagem de dimensionamento aplicada ao tipo de letra.

scaling: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está formatado como sombreado. Os valores possíveis são os seguintes:

• true : todo o texto é sombreado.

• false : nenhum texto é sombreado.

• null : devolvido se algum, mas não todos, do texto estiver sombreado.

shadow: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o tamanho do tipo de letra em pontos.

size: number;

Valor da propriedade

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

Especifica o tamanho do tipo de letra em pontos para texto da direita para a esquerda.

sizeBidirectional: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra está formatado como maiúsculas pequenas, o que faz com que as 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 Maiúsculas Pequenas .

• false : nenhum dos textos tem o atributo Maiúsculas Pequenas .

• null : devolvido se algum, mas não todos, do texto tiver o atributo Maiúsculas Pequenas .

smallCaps: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o espaçamento entre carateres.

spacing: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra tem uma rasurado. true se o tipo de letra estiver formatado como texto rasurado, caso contrário, false.

strikeThrough: boolean;

Valor da propriedade

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

Especifica o conjunto estilístico do tipo de letra.

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 API: WordApiDesktop 1.3 ]

Especifica se o tipo de letra é inferior à linha. true se o tipo de letra estiver formatado como inferior à linha, caso contrário, false.

subscript: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Especifica se o tipo de letra é superior à linha. true se o tipo de letra estiver formatado como superior à linha, caso contrário, false.

superscript: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApi 1.1 ]

Devolve um ColorFormat objeto que representa a cor do tipo de letra.

readonly textColor: Word.ColorFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um ShadowFormat objeto que especifica a formatação de sombra para o tipo de letra.

readonly textShadow: Word.ShadowFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Devolve um ThreeDimensionalFormat objeto que contém propriedades de formatação de efeitos tridimensionais (3D) para o tipo de letra.

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

Especifica o tipo de sublinhado do tipo de letra. none 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

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

Especifica a cor do sublinhado para o Font objeto. Pode fornecer o valor no formato "#RRGGBB".

underlineColor: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

decreaseFontSize(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

increaseFontSize(): void;

Retornos

Comentários

[ Conjunto de API: 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 de carateres.

reset(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.3 ]

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

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num 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 API: WordApiDesktop 1.3 ]

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

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

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