Word.Font class

  • Referencia
Paquete:
word

Representa una fuente.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: WordApi 1.1 ]

Propiedades

bold

Especifica un valor que indica si la fuente está en negrita. True si la fuente tiene formato de negrita; en caso contrario, false.
color

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

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
doubleStrikeThrough

Especifica un valor que indica si la fuente tiene un tachado doble. True si la fuente tiene formato de texto con doble tachado; en caso contrario, false.
hidden

Especifica un valor que indica si la fuente está etiquetada como oculta. True si la fuente tiene formato de texto oculto; de lo contrario, false.
highlightColor

Especifica el color de resaltado. Para establecerlo, 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 estar en el formato "#RRGGBB", una cadena vacía para colores de resaltado mixtos o null sin color de resaltado. Nota: Solo los colores de resaltado predeterminados están disponibles en Office para Escritorio de Windows. Se trata de "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" y "Black". Cuando el complemento se ejecuta en Office para Windows Desktop, cualquier otro color se convierte al color más cercano cuando se aplica a la fuente.
italic

Especifica un valor que indica si la fuente está en cursiva. True si la fuente está en cursiva; en caso contrario, false.
name

Especifica un valor que representa el nombre de la fuente.
size

Especifica un valor que representa el tamaño de fuente en puntos.
strikeThrough

Especifica un valor que indica si la fuente tiene un tachado. True si la fuente tiene formato de texto con tachado; en caso contrario, false.
subscript

Especifica un valor que indica si la fuente es un subíndice. True si la fuente tiene formato de subíndice; en caso contrario, false.
superscript

Especifica un valor que indica si la fuente es un superíndice. True si la fuente tiene formato de superíndice; en caso contrario, false.
underline

Especifica un valor que indica el tipo de subrayado de la fuente. 'None' si la fuente no está subrayada.

Métodos

load(options)

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

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

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

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

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto Font es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.FontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 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.
untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

Detalles de las propiedades

bold

Especifica un valor que indica si la fuente está en negrita. True si la fuente tiene formato de negrita; en caso contrario, false.

bold: boolean;

Valor de propiedad

boolean

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

color

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

color: string;

Valor de propiedad

string

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

context

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Word.RequestContext

doubleStrikeThrough

Especifica un valor que indica si la fuente tiene un tachado doble. True si la fuente tiene formato de texto con doble tachado; en caso contrario, false.

doubleStrikeThrough: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

hidden

Nota

Esta API se ofrece a los desarrolladores como versión preliminar y puede cambiar en función de los comentarios que recibamos. No utilice esta API en un entorno de producción.

Especifica un valor que indica 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

boolean

Comentarios

[ Conjunto de API: WordApi BETA (SOLO VERSIÓN PRELIMINAR) ]

highlightColor

Especifica el color de resaltado. Para establecerlo, 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 estar en el formato "#RRGGBB", una cadena vacía para colores de resaltado mixtos o null sin color de resaltado. Nota: Solo los colores de resaltado predeterminados están disponibles en Office para Escritorio de Windows. Se trata de "Yellow", "Lime", "Turquoise", "Pink", "Blue", "Red", "DarkBlue", "Teal", "Green", "Purple", "DarkRed", "Olive", "Gray", "LightGray" y "Black". Cuando el complemento se ejecuta en Office para Windows Desktop, cualquier otro color se convierte al color más cercano cuando se aplica a la fuente.

highlightColor: string;

Valor de propiedad

string

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

italic

Especifica un valor que indica si la fuente está en cursiva. True si la fuente está en cursiva; en caso contrario, false.

italic: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

name

Especifica un valor que representa el nombre de la fuente.

name: string;

Valor de propiedad

string

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

size

Especifica un valor que representa el tamaño de fuente en puntos.

size: number;

Valor de propiedad

number

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

strikeThrough

Especifica un valor que indica si la fuente tiene un tachado. True si la fuente tiene formato de texto con tachado; en caso contrario, false.

strikeThrough: boolean;

Valor de propiedad

boolean

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

subscript

Especifica un valor que indica si la fuente es un subíndice. True si la fuente tiene formato de subíndice; en caso contrario, false.

subscript: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

superscript

Especifica un valor que indica si la fuente es un superíndice. True si la fuente tiene formato de superíndice; en caso contrario, false.

superscript: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: WordApi 1.1 ]

underline

Especifica un valor que indica 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

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

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

Detalles del método

load(options)

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

options
Word.Interfaces.FontLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Word.Font

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Word.Font

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

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

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Word.Font

set(properties, options)

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

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

Parámetros

properties
Word.Interfaces.FontUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options
OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Word.Font): void;

Parámetros

properties
Word.Font

Devoluciones

void

toJSON()

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el Word original. El objeto Font es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Word.Interfaces.FontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Word.Interfaces.FontData;

Devoluciones

Word.Interfaces.FontData

track()

Realiza un seguimiento del objeto de ajuste automático según cambios adyacentes en el documento. Esta llamada es una abreviatura para context.trackedObjects.add(thisObject). Si usa este objeto entre .sync llamadas y fuera de la ejecución secuencial de un lote ".run" y obtiene 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 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

Word.Font

untrack()

Libere la memoria asociada a este objeto, si se ha realizado un seguimiento de él anteriormente. Esta llamada es abreviada para 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. Tendrá que llamar context.sync() a antes de que la versión de memoria surta efecto.

untrack(): Word.Font;

Devoluciones

Word.Font