Excel.RangeFormat class
Objeto de formato que encapsula la fuente, el relleno, los bordes, la alineación y otras propiedades del intervalo.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
Propiedades
| auto |
Especifica si el texto se aplica sangría automáticamente cuando la alineación del texto se establece en la misma distribución. |
| borders | Colección de objetos de borde que se aplica al rango global seleccionado. |
| column |
Especifica el ancho de todas las columnas del intervalo. Si los anchos de columna no son uniformes, |
| context | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| fill | Devuelve el objeto de relleno definido en el intervalo global. |
| font | Devuelve el objeto de fuente definido en el rango global. |
| horizontal |
Representa la alineación horizontal del objeto especificado. Vea |
| indent |
Un número entero entre 0 y 250 que indica el nivel de sangría. |
| protection | Devuelve el objeto de protección de formato de un rango. |
| reading |
El orden de lectura para el intervalo. |
| row |
Alto de todas las filas del intervalo. Si los altos de fila no son uniformes, |
| shrink |
Especifica si el texto se reduce automáticamente para ajustarse al ancho de columna disponible. |
| text |
Orientación del texto de todas las celdas dentro del rango. La orientación del texto debe ser un entero de -90 a 90 o 180 para texto orientado verticalmente. Si la orientación dentro de un intervalo no es uniforme, |
| use |
Determina si el alto de fila del |
| use |
Especifica si el ancho de columna del |
| vertical |
Representa la alineación vertical del objeto especificado. Vea |
| wrap |
Especifica si Excel ajusta el texto del objeto. Un |
Métodos
| adjust |
Ajusta la sangría del formato de intervalo. El valor de sangría oscila entre 0 y 250 y se mide en caracteres. |
| autofit |
Cambia el ancho de las columnas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas). |
| autofit |
Cambia el alto de las filas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas). |
| 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
autoIndent
Especifica si el texto se aplica sangría automáticamente cuando la alineación del texto se establece en la misma distribución.
autoIndent: boolean;Valor de propiedad
boolean
Comentarios
borders
Colección de objetos de borde que se aplica al rango global seleccionado.
readonly borders: Excel.RangeBorderCollection;Valor de propiedad
Comentarios
columnWidth
Especifica el ancho de todas las columnas del intervalo. Si los anchos de columna no son uniformes, null se devolverá.
columnWidth: number;Valor de propiedad
number
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
fill
Devuelve el objeto de relleno definido en el intervalo global.
readonly fill: Excel.RangeFill;Valor de propiedad
Comentarios
font
Devuelve el objeto de fuente definido en el rango global.
readonly font: Excel.RangeFont;Valor de propiedad
Comentarios
horizontalAlignment
Representa la alineación horizontal del objeto especificado. Vea Excel.HorizontalAlignment para más información.
horizontalAlignment: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";Valor de propiedad
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Comentarios
indentLevel
Un número entero entre 0 y 250 que indica el nivel de sangría.
indentLevel: number;Valor de propiedad
number
Comentarios
protection
Devuelve el objeto de protección de formato de un rango.
readonly protection: Excel.FormatProtection;Valor de propiedad
Comentarios
readingOrder
El orden de lectura para el intervalo.
readingOrder: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Valor de propiedad
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Comentarios
rowHeight
Alto de todas las filas del intervalo. Si los altos de fila no son uniformes, null se devolverá.
rowHeight: number;Valor de propiedad
number
Comentarios
shrinkToFit
Especifica si el texto se reduce automáticamente para ajustarse al ancho de columna disponible.
shrinkToFit: boolean;Valor de propiedad
boolean
Comentarios
textOrientation
Orientación del texto de todas las celdas dentro del rango. La orientación del texto debe ser un entero de -90 a 90 o 180 para texto orientado verticalmente. Si la orientación dentro de un intervalo no es uniforme, null se devolverá.
textOrientation: number;Valor de propiedad
number
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-text-orientation.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B2:E2");
// Set textOrientation to either an integer between -90 and 90
// or to 180 for vertically-oriented text.
range.format.textOrientation = 90;
await context.sync();
});
useStandardHeight
Determina si el alto de fila del Range objeto es igual al alto estándar de la hoja. Devuelve true si el alto de fila del Range objeto es igual al alto estándar de la hoja. Devuelve null si el intervalo contiene más de una fila y las filas no tienen el mismo alto. Devuelve false lo contrario. Nota: Esta propiedad solo está pensada para establecerse en true. Establecerlo en false no tiene ningún efecto.
useStandardHeight: boolean;Valor de propiedad
boolean
Comentarios
useStandardWidth
Especifica si el ancho de columna del Range objeto es igual al ancho estándar de la hoja. Devuelve true si el ancho de columna del Range objeto es igual al ancho estándar de la hoja. Devuelve null si el intervalo contiene más de una columna y las columnas no tienen el mismo alto. Devuelve false lo contrario. Nota: Esta propiedad solo está pensada para establecerse en true. Establecerlo en false no tiene ningún efecto.
useStandardWidth: boolean;Valor de propiedad
boolean
Comentarios
verticalAlignment
Representa la alineación vertical del objeto especificado. Vea Excel.VerticalAlignment para más información.
verticalAlignment: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Valor de propiedad
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Comentarios
wrapText
Especifica si Excel ajusta el texto del objeto. Un null valor indica que todo el intervalo no tiene una configuración de ajuste uniforme
wrapText: boolean;Valor de propiedad
boolean
Comentarios
Detalles del método
adjustIndent(amount)
Ajusta la sangría del formato de intervalo. El valor de sangría oscila entre 0 y 250 y se mide en caracteres.
adjustIndent(amount: number): void;Parámetros
- amount
-
number
Número de espacios de caracteres por el que se ajusta la sangría actual. Este valor debe estar entre -250 y 250. Nota: Si la cantidad elevaría el nivel de sangría por encima de 250, el nivel de sangría se mantiene con 250. De forma similar, si la cantidad reduciría el nivel de sangría por debajo de 0, el nivel de sangría permanece 0.
Devoluciones
void
Comentarios
autofitColumns()
Cambia el ancho de las columnas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas).
autofitColumns(): void;Devoluciones
void
Comentarios
autofitRows()
Cambia el alto de las filas del rango actual para obtener el ajuste perfecto (según los datos actuales de las columnas).
autofitRows(): void;Devoluciones
void
Comentarios
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.RangeFormatLoadOptions): Excel.RangeFormat;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.RangeFormat;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
Ejemplos
// Select all of the range's format properties.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "F:G";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load(["format/*", "format/fill", "format/borders", "format/font"]);
await context.sync();
console.log(range.format.wrapText);
console.log(range.format.fill.color);
console.log(range.format.font.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.RangeFormat;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.RangeFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.RangeFormatUpdateData
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.RangeFormat): void;Parámetros
- properties
- Excel.RangeFormat
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.RangeFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.RangeFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.
toJSON(): Excel.Interfaces.RangeFormatData;