Excel.RangeFont class

  • Referencia
Paquete:
excel

Este objeto representa los atributos de fuente (nombre de fuente, tamaño de fuente, color, etc.) de un objeto.

Extends
OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Propiedades

bold

Representa el estado en negrita de la fuente.
color

Representación del código de color HTML del color de texto (por ejemplo, #FF0000 representa Rojo).
context

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

Especifica el estado en cursiva de la fuente.
name

Nombre de fuente (por ejemplo, "Calibri"). La longitud del nombre no debe tener más de 31 caracteres.
size

Tamaño de fuente.
strikethrough

Especifica el estado de tachado de la fuente. Un null valor indica que todo el intervalo no tiene una configuración uniforme de tachado.
subscript

Especifica el estado del subíndice de la fuente. Devuelve true si todas las fuentes del intervalo son subíndices. Devuelve false si todas las fuentes del intervalo son superíndices o normales (ni superíndice ni subíndice). Devuelve null lo contrario.
superscript

Especifica el estado de superíndice de la fuente. Devuelve true si todas las fuentes del intervalo son superíndices. Devuelve false si todas las fuentes del intervalo son subíndices o normales (ni superíndice ni subíndice). Devuelve null lo contrario.
tintAndShade

Especifica un doble que aclara u oscurece un color para la fuente de rango. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que todo el intervalo no tiene una configuración de fuente tintAndShade uniforme.
underline

Tipo de subrayado aplicado a la fuente. Vea Excel.RangeUnderlineStyle para más información.

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 objeto Excel.RangeFont original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeFontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

Detalles de las propiedades

bold

Representa el estado en negrita de la fuente.

bold: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

color

Representación del código de color HTML del color de texto (por ejemplo, #FF0000 representa Rojo).

color: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

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

Excel.RequestContext

italic

Especifica el estado en cursiva de la fuente.

italic: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

name

Nombre de fuente (por ejemplo, "Calibri"). La longitud del nombre no debe tener más de 31 caracteres.

name: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

Ejemplos

// Change the font of the selected range to "Impact".
await Excel.run(async (context) => {
  const selection = context.workbook.getSelectedRange();
  selection.format.font.name = "Impact";
  await context.sync();
});

size

Tamaño de fuente.

size: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

strikethrough

Especifica el estado de tachado de la fuente. Un null valor indica que todo el intervalo no tiene una configuración uniforme de tachado.

strikethrough: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

subscript

Especifica el estado del subíndice de la fuente. Devuelve true si todas las fuentes del intervalo son subíndices. Devuelve false si todas las fuentes del intervalo son superíndices o normales (ni superíndice ni subíndice). Devuelve null lo contrario.

subscript: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

superscript

Especifica el estado de superíndice de la fuente. Devuelve true si todas las fuentes del intervalo son superíndices. Devuelve false si todas las fuentes del intervalo son subíndices o normales (ni superíndice ni subíndice). Devuelve null lo contrario.

superscript: boolean;

Valor de propiedad

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

tintAndShade

Especifica un doble que aclara u oscurece un color para la fuente de rango. El valor está entre -1 (más oscuro) y 1 (más brillante), con 0 para el color original. Un null valor indica que todo el intervalo no tiene una configuración de fuente tintAndShade uniforme.

tintAndShade: number;

Valor de propiedad

number

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

underline

Tipo de subrayado aplicado a la fuente. Vea Excel.RangeUnderlineStyle para más información.

underline: Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant";

Valor de propiedad

Excel.RangeUnderlineStyle | "None" | "Single" | "Double" | "SingleAccountant" | "DoubleAccountant"

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

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?: Excel.Interfaces.RangeFontLoadOptions): Excel.RangeFont;

Parámetros

options
Excel.Interfaces.RangeFontLoadOptions

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

Devoluciones

Excel.RangeFont

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[]): Excel.RangeFont;

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

Excel.RangeFont

Ejemplos

await Excel.run(async (context) => { 
    const sheetName = "Sheet1";
    const rangeAddress = "F:G";
    const worksheet = context.workbook.worksheets.getItem(sheetName);
    const range = worksheet.getRange(rangeAddress);
    const rangeFont = range.format.font;
    rangeFont.load('name');
    await context.sync();
    console.log(rangeFont.name);
});

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;
        }): Excel.RangeFont;

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

Excel.RangeFont

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.RangeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

properties
Excel.Interfaces.RangeFontUpdateData

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: Excel.RangeFont): void;

Parámetros

properties
Excel.RangeFont

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 objeto Excel.RangeFont original es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeFontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.RangeFontData;

Devoluciones

Excel.Interfaces.RangeFontData