Excel.ShapeFont class
Representa los atributos de fuente, como el nombre de fuente, el tamaño de fuente y el color, para el objeto de TextRange una forma.
- Extends
Comentarios
Propiedades
| bold | Representa el estado de negrita de la fuente. Devuelve |
| color | Representación del código de color HTML del color de texto (por ejemplo, "#FF0000" representa rojo). Devuelve |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| italic | Indica el estado de cursiva de la fuente. Devuelve |
| name | Representa el nombre de fuente (por ejemplo, "Calibri"). Si el texto es un script complejo o un idioma asiático oriental, este es el nombre de fuente correspondiente; de lo contrario, es el nombre de la fuente latina. |
| size | Representa el tamaño de fuente en puntos (por ejemplo, 11). Devuelve |
| strikethrough | Especifica el estado de tachado de la fuente. Un |
| subscript | Especifica el estado del subíndice de la fuente. Devuelve |
| superscript | Especifica el estado de superíndice de la fuente. Devuelve |
| tint |
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 |
| underline | Tipo de subrayado aplicado a la fuente. Devuelve |
Métodos
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| 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 |
Detalles de las propiedades
bold
Representa el estado de negrita de la fuente. Devuelve null si TextRange incluye fragmentos de texto en negrita y no en negrita.
bold: boolean;Valor de propiedad
boolean
Comentarios
color
Representación del código de color HTML del color de texto (por ejemplo, "#FF0000" representa rojo). Devuelve null si incluye TextRange fragmentos de texto con colores diferentes.
color: string;Valor de propiedad
string
Comentarios
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
italic
Indica el estado de cursiva de la fuente. Devuelve null si incluye TextRange fragmentos de texto cursiva y no cursiva.
italic: boolean;Valor de propiedad
boolean
Comentarios
name
Representa el nombre de fuente (por ejemplo, "Calibri"). Si el texto es un script complejo o un idioma asiático oriental, este es el nombre de fuente correspondiente; de lo contrario, es el nombre de la fuente latina.
name: string;Valor de propiedad
string
Comentarios
size
Representa el tamaño de fuente en puntos (por ejemplo, 11). Devuelve null si incluye TextRange fragmentos de texto con tamaños de fuente diferentes.
size: number;Valor de propiedad
number
Comentarios
strikethrough
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 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 BETA (SOLO VERSIÓN PRELIMINAR) ]
subscript
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 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 BETA (SOLO VERSIÓN PRELIMINAR) ]
superscript
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 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 BETA (SOLO VERSIÓN PRELIMINAR) ]
tintAndShade
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 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 BETA (SOLO VERSIÓN PRELIMINAR) ]
underline
Tipo de subrayado aplicado a la fuente. Devuelve null si incluye TextRange fragmentos de texto con estilos de subrayado diferentes. Vea Excel.ShapeFontUnderlineStyle para más información.
underline: Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble";Valor de propiedad
Excel.ShapeFontUnderlineStyle | "None" | "Single" | "Double" | "Heavy" | "Dotted" | "DottedHeavy" | "Dash" | "DashHeavy" | "DashLong" | "DashLongHeavy" | "DotDash" | "DotDashHeavy" | "DotDotDash" | "DotDotDashHeavy" | "Wavy" | "WavyHeavy" | "WavyDouble"
Comentarios
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.ShapeFontLoadOptions): Excel.ShapeFont;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
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.ShapeFont;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
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.ShapeFont;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
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.ShapeFontUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.ShapeFontUpdateData
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.ShapeFont): void;Parámetros
- properties
- Excel.ShapeFont
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 original Excel.ShapeFont es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ShapeFontData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.ShapeFontData;