Word.Font class

Especifica si la fuente tiene el formato de todas las letras mayúsculas, lo que hace que las minúsculas aparezcan como mayúsculas. Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo en mayúsculas .

• false : ninguna parte del texto tiene el atributo Todo mayúsculas .

• null : devuelto si parte del texto, pero no todo, tiene el atributo Todo mayúsculas .

allCaps: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente está en negrita. true si la fuente tiene formato de negrita, de lo contrario, false.

bold: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 si la fuente tiene el formato de negrita en un documento de idioma de derecha a izquierda. Los valores posibles son los siguientes:

• true : Todo el texto está en negrita.

• false : Ninguna parte del texto está en negrita.

• null : devuelto si parte del texto (pero no todo) está en negrita.

boldBidirectional: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un BorderUniversalCollection objeto que representa todos los bordes de la fuente.

readonly borders: Word.BorderUniversalCollection;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el color de la fuente. Puede proporcionar el valor en el formato "#RRGGBB" o en el nombre del color.

color: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 un ColorIndex valor que representa el color de la fuente.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el color del Font objeto en un documento de idioma de derecha a izquierda.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Especifica si las alternativas contextuales están habilitadas para la fuente.

contextualAlternates: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el color que se usará para los diacríticos del Font objeto. Puede proporcionar el valor en el formato "#RRGGBB".

diacriticColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si Microsoft Word omite el número de caracteres por línea del objeto correspondienteFont.

disableCharacterSpaceGrid: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene un doble tachado. true si la fuente tiene formato de texto tachado doble, en caso contrario, false.

doubleStrikeThrough: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Especifica si la fuente tiene formato de gofrado. Los valores posibles son los siguientes:

• true : Todo el texto está grabado en relieve.

• false : Ninguna parte del texto está en relieve.

• null : devuelto si parte del texto está grabado en relieve, pero no todo.

emboss: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica un EmphasisMark valor que representa la marca de énfasis de un carácter o una cadena de caracteres designada.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene el formato de grabado. Los valores posibles son los siguientes:

• true : Todo el texto está grabado.

• false : Ninguno de los textos está grabado.

• null : devuelto si se graba parte del texto, pero no todo.

engrave: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un FillFormat objeto que contiene propiedades de formato de relleno para la fuente utilizada por el rango de texto.

readonly fill: Word.FillFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un GlowFormat objeto que representa el formato de resplandor de la fuente utilizada por el rango de texto.

readonly glow: Word.GlowFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente está etiquetada como oculta. true si la fuente tiene formato de texto oculto, de lo contrario, false.

hidden: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.2

Especifica el color de resaltado. Para configurarlo, use un valor en el formato "#RRGGBB" o en el nombre del color. Para quitar el color de resaltado, establézcalo en null. El color de resaltado devuelto puede tener el formato "#RRGGBB", una cadena vacía para mezclar colores de resaltado o null sin color de resaltado. Nota: Solo están disponibles los colores de resaltado predeterminados en Office para escritorio de Windows. Estos son "Amarillo", "Lima", "Turquesa", "Rosa", "Azul", "Rojo", "Azul oscuro", "Verde azulado", "Verde", "Morado", "Rojo oscuro", "Oliva", "Gris", "Gris claro" y "Negro". Cuando el complemento se ejecuta en Office para escritorio de Windows, cualquier otro color se convierte al color más cercano cuando se aplica a la fuente.

highlightColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 si la fuente está en cursiva. true Si la fuente está en cursiva, de lo contrario, false.

italic: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Especifica si la fuente está en cursiva en un documento de idioma de derecha a izquierda. Los valores posibles son los siguientes:

• true : todo el texto está en cursiva.

• false : Ninguna parte del texto está en cursiva.

• null : devuelto si parte del texto (pero no todo) está en cursiva.

italicBidirectional: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el tamaño de fuente mínimo para el que Microsoft Word ajustará el interletraje automáticamente.

kerning: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la configuración de ligadura del Font objeto.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un LineFormat objeto que especifica el formato de una línea.

readonly line: Word.LineFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el nombre de la fuente.

name: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 la fuente que se usa para el texto latino (caracteres con códigos de carácter de 0 (cero) a 127).

nameAscii: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el nombre de fuente en un documento de idioma de derecha a izquierda.

nameBidirectional: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el nombre de la fuente de Asia Oriental.

nameFarEast: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la fuente que se usa para los caracteres con códigos de 128 a 255.

nameOther: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la configuración del formato de número para una fuente OpenType.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la configuración de espaciado de número para la fuente.

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

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene el formato delineado. Los valores posibles son los siguientes:

• true : se esquematiza todo el texto.

• false : no se indica nada del texto.

• null : devuelto si se esboza parte del texto, pero no todo.

outline: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica la posición del texto (en puntos) con respecto a la línea base.

position: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un ReflectionFormat objeto que representa el formato de reflexión de una forma.

readonly reflection: Word.ReflectionFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el porcentaje de escala aplicado a la fuente.

scaling: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene formato sombreado. Los valores posibles son los siguientes:

• true : todo el texto está sombreado.

• false : no se oculta nada del texto.

• null : devuelto si se sombrea parte del texto, pero no todo.

shadow: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el tamaño de fuente en puntos.

size: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 el tamaño de fuente en puntos para el texto de derecha a izquierda.

sizeBidirectional: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene el formato de versalitas, lo que hace que las minúsculas aparezcan como minúsculas mayúsculas. Los valores posibles son los siguientes:

• true : todo el texto tiene el atributo versalitas .

• false : Ninguna parte del texto tiene el atributo de versalitas .

• null : devuelto si parte del texto, pero no todo, tiene el atributo versalitas .

smallCaps: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica el espaciado entre caracteres.

spacing: number;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente tiene un tachado. true si la fuente tiene formato de texto tachado, de lo contrario, false.

strikeThrough: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 el conjunto estilístico de la fuente.

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 de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Especifica si la fuente es un subíndice. true si la fuente tiene el formato de subíndice, de lo contrario, false.

subscript: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Especifica si la fuente es un superíndice. true si la fuente tiene formato de superíndice, de lo contrario, false.

superscript: boolean;

Valor de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Devuelve un ColorFormat objeto que representa el color de la fuente.

readonly textColor: Word.ColorFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un ShadowFormat objeto que especifica el formato de sombra de la fuente.

readonly textShadow: Word.ShadowFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Devuelve un ThreeDimensionalFormat objeto que contiene propiedades de formato de efecto tridimensional (3D) para la fuente.

readonly threeDimensionalFormat: Word.ThreeDimensionalFormat;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/apply-bevel-to-text.yaml

if (!Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
  console.error("This sample requires WordApiDesktop 1.3 or later.");
  return;
}

await Word.run(async (context) => {
  const paragraph: Word.Paragraph = context.document.body.insertParagraph(
    "Beveled text",
    Word.InsertLocation.start,
  );
  paragraph.font.size = 48;
  paragraph.font.bold = true;

  const threeDimensionalFormat: Word.ThreeDimensionalFormat = paragraph.font.threeDimensionalFormat;
  threeDimensionalFormat.isVisible = true;
  threeDimensionalFormat.bevelTopType = Word.BevelType.circle;
  threeDimensionalFormat.bevelTopDepth = 6;
  threeDimensionalFormat.bevelTopInset = 6;
  threeDimensionalFormat.load("bevelTopType,bevelTopDepth,bevelTopInset");

  await context.sync();

  console.log("Applied bevel formatting:", {
    type: threeDimensionalFormat.bevelTopType,
    depth: threeDimensionalFormat.bevelTopDepth,
    inset: threeDimensionalFormat.bevelTopInset,
  });
});

Especifica el tipo de subrayado de la fuente. none Si la fuente no está subrayada.

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 de propiedad

Comentarios

Conjunto de API: WordApi 1.1

Ejemplos

// 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 el color del subrayado del Font objeto. Puede proporcionar el valor en el formato "#RRGGBB".

underlineColor: string;

Valor de propiedad

Comentarios

Conjunto de API: WordApiDesktop 1.3

Reduce el tamaño de la fuente al siguiente tamaño disponible.

decreaseFontSize(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Aumenta el tamaño de la fuente con el siguiente tamaño disponible.

increaseFontSize(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

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

Parámetros

Devoluciones

Quita manualmente el formato de caracteres.

reset(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.

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

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Word.Font): void;

Parámetros

Devoluciones

Establece el formato de fuente especificado como predeterminado para el documento activo y para todos los nuevos documentos basados en la plantilla activa.

setAsTemplateDefault(): void;

Devoluciones

Comentarios

Conjunto de API: WordApiDesktop 1.3

Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Word.Font es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Word.Interfaces.FontData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Word.Interfaces.FontData;

Devoluciones

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura de context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y recibe un error "InvalidObjectPath" al establecer una propiedad o invocar un método en el objeto, debe agregar el objeto a la colección de objetos objeto de seguimiento cuando se creó el objeto por primera vez. Si este objeto forma parte de una colección, también debe realizar un seguimiento de la colección primaria.

track(): Word.Font;

Devoluciones

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es la abreviatura de context.trackedObjects.remove(thisObject). Tener muchos objetos marcados ralentiza la aplicación host, así que debe recordar liberar los objetos que agregue cuando haya terminado con ellos. Deberá llamar context.sync() antes de que la liberación de memoria surta efecto.

untrack(): Word.Font;

Devoluciones