Excel.Worksheet class

Representa el AutoFilter objeto de la hoja de cálculo.

readonly autoFilter: Excel.AutoFilter;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Devuelve una colección de gráficos que forman parte de la hoja de cálculo.

readonly charts: Excel.ChartCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Devuelve una colección de todos los objetos Comments en la hoja de cálculo.

readonly comments: Excel.CommentCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

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

Obtiene una colección de propiedades personalizadas de nivel de hoja de cálculo.

readonly customProperties: Excel.WorksheetCustomPropertyCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.12]

Determina si Excel debe volver a calcular la hoja de cálculo cuando sea necesario. True si Excel vuelve a calcular la hoja de cálculo cuando es necesario. False si Excel no actualiza la hoja.

enableCalculation: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Obtiene un objeto que se puede usar para manipular paneles inmovilizados en la hoja de cálculo.

readonly freezePanes: Excel.WorksheetFreezePanes;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Obtiene la colección de saltos de página horizontales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.

readonly horizontalPageBreaks: Excel.PageBreakCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Devuelve un valor que identifica de forma única la hoja de cálculo de un libro determinado. El valor del identificador permanece igual, incluso cuando se cambia el nombre de la hoja de cálculo o cuando esta se mueve.

readonly id: string;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Nombre para mostrar de la hoja de cálculo. El nombre debe tener menos de 32 caracteres.

name: string;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Colección de nombres en el ámbito de la hoja de cálculo actual.

readonly names: Excel.NamedItemCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.4]

Devuelve una colección de todos los objetos de notas de la hoja de cálculo.

readonly notes: Excel.NoteCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.18]

Obtiene el objeto de la PageLayout hoja de cálculo.

readonly pageLayout: Excel.PageLayout;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Colección de tablas dinámicas que forman parte de la hoja de cálculo.

readonly pivotTables: Excel.PivotTableCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.3]

Posición de base cero de la hoja de cálculo dentro del libro.

position: number;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Devuelve el objeto de protección de hoja de una hoja de cálculo.

readonly protection: Excel.WorksheetProtection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.2]

Devuelve la colección de todos los objetos Shape en la hoja de cálculo.

readonly shapes: Excel.ShapeCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Especifica si los iconos de tipo de datos están visibles en la hoja de cálculo. De forma predeterminada, los iconos de tipo de datos están visibles.

showDataTypeIcons: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.19]

Especifica si las líneas de cuadrícula son visibles para el usuario.

showGridlines: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.8]

Especifica si los títulos son visibles para el usuario.

showHeadings: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.8]

Devuelve una colección de segmentaciones de datos que forman parte de la hoja de cálculo.

readonly slicers: Excel.SlicerCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

Devuelve el ancho estándar (predeterminado) de todas las filas de la hoja de cálculo, en puntos.

readonly standardHeight: number;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Especifica el ancho estándar (predeterminado) de todas las columnas de la hoja de cálculo. Una unidad de ancho de columna equivale al ancho de un carácter con el estilo Normal. En las fuentes proporcionales se utiliza el ancho del carácter 0 (cero).

standardWidth: number;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

El color de tabulación de la hoja de cálculo. Al recuperar el color de la pestaña, si la hoja de cálculo es invisible, el valor será null. Si la hoja de cálculo está visible, pero el color de tabulación se establece en automático, se devolverá una cadena vacía. En caso contrario, la propiedad se establecerá en un color, en el formato #RRGGBB (por ejemplo, "FFA500"). Al configurar el color, use una cadena vacía para establecer un color "automático" o, en caso contrario, un color real.

tabColor: string;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Devuelve un valor que representa esta hoja de cálculo y que Open Office XML puede leer. Se trata de un valor entero, que es diferente de worksheet.id (que devuelve un identificador único global) y worksheet.name (que devuelve un valor como "Hoja1").

readonly tabId: number;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.14]

Colección de tablas que forman parte de la hoja de cálculo.

readonly tables: Excel.TableCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Obtiene la colección de saltos de página verticales de la hoja de cálculo. Esta colección solo contiene saltos de página manuales.

readonly verticalPageBreaks: Excel.PageBreakCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Visibilidad de la hoja de cálculo.

visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1 para visibilidad de lectura; 1.2 para configurarla.]

Activa la hoja de cálculo en la interfaz de usuario de Excel.

activate(): void;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

Calcula todas las celdas de una hoja de cálculo.

calculate(markAllDirty: boolean): void;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.6]

Copia una hoja de cálculo y la coloca en la posición especificada.

copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parámetros

Devoluciones

La hoja de cálculo recién creada.

Comentarios

[Conjunto de API: ExcelApi 1.7]

Copia una hoja de cálculo y la coloca en la posición especificada.

copy(positionType?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet): Excel.Worksheet;

Parámetros

Devoluciones

La hoja de cálculo recién creada.

Comentarios

[Conjunto de API: ExcelApi 1.7]

Elimina la hoja de cálculo del libro. Tenga en cuenta que si la visibilidad de la hoja de cálculo se establece en "VeryHidden", se producirá un error en la operación de eliminación con una InvalidOperation excepción. Primero debe cambiar su visibilidad a oculta o visible antes de eliminarla.

delete(): void;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

Encuentra todas las apariciones de la cadena especificada en función de los criterios especificados y las devuelve como un RangeAreas objeto, que comprende uno o varios rangos rectangulares. No se devuelve el contenido de hojas de cálculo ocultas.

findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parámetros

Devoluciones

Un RangeAreas objeto que comprende uno o varios rangos rectangulares y que coincide con los criterios de búsqueda. Si ninguna celda cumple este criterio, se producirá un ItemNotFound error.

Comentarios

[Conjunto de API: ExcelApi 1.9]

Encuentra todas las apariciones de la cadena especificada en función de los criterios especificados y las devuelve como un RangeAreas objeto, que comprende uno o varios rangos rectangulares. No se devuelve el contenido de hojas de cálculo ocultas.

findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;

Parámetros

Devoluciones

Un RangeAreas objeto que comprende uno o varios rangos rectangulares y que coincide con los criterios de búsqueda. Si no hay coincidencias, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

Comentarios

[Conjunto de API: ExcelApi 1.9]

Obtiene el Range objeto que contiene la celda única en función de los números de fila y columna. La celda puede estar fuera de los límites de su rango primario siempre que se mantenga dentro de la cuadrícula de la hoja de cálculo.

getCell(row: number, column: number): Excel.Range;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

Obtiene la hoja de cálculo que sigue a esta. Si no hay hojas de cálculo después de esta, este método producirá un error.

getNext(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.5]

Obtiene la hoja de cálculo que sigue a esta. Si no hay hojas de cálculo después de esta, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.5]

Obtiene la hoja de cálculo que precede a ésta. Si no hay hojas de cálculo anteriores, este método producirá un error.

getPrevious(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.5]

Obtiene la hoja de cálculo que precede a ésta. Si no hay hojas de cálculo anteriores, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.5]

Obtiene el Range objeto, que representa un único bloque rectangular de celdas, especificado por la dirección o el nombre.

getRange(address?: string): Excel.Range;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

Obtiene el Range objeto que empieza por un índice de fila y un índice de columna determinados, y que abarca un cierto número de filas y columnas.

getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.7]

Obtiene el RangeAreas objeto, que representa uno o más bloques de rangos rectangulares, especificado por la dirección o el nombre.

getRanges(address?: string): Excel.RangeAreas;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.9]

El rango usado es el rango más pequeño que abarque todas las celdas que tengan asignado un valor o un formato. Si toda la hoja de cálculo está en blanco, esta función devolverá la celda superior izquierda (es decir, no producirá un error).

getUsedRange(valuesOnly?: boolean): Excel.Range;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

El rango usado es el rango más pequeño que abarque todas las celdas que tengan asignado un valor o un formato. Si toda la hoja de cálculo está en blanco, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.4]

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.WorksheetLoadOptions): Excel.Worksheet;

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

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

Parámetros

Devoluciones

Busca y reemplaza la cadena especificada, según los criterios especificados dentro de la hoja de cálculo actual.

replaceAll(text: string, replacement: string, criteria: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Parámetros

Devoluciones

El número de reemplazos realizados.

Comentarios

[Conjunto de API: ExcelApi 1.9]

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

Parámetros

Devoluciones

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

set(properties: Excel.Worksheet): void;

Parámetros

Devoluciones

Muestra los grupos de filas o columnas por sus niveles de esquema. Esquematiza grupos y resume una lista de datos en la hoja de cálculo. Los rowLevels parámetros y columnLevels especifican cuántos niveles del contorno se mostrarán. El rango de argumentos aceptable está entre 0 y 8. Un valor de 0 no cambia la pantalla actual. Un valor mayor que el número actual de niveles muestra todos los niveles.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.10]

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 Excel.Worksheet es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.WorksheetData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.

toJSON(): Excel.Interfaces.WorksheetData;

Devoluciones

Ocurre cuando se activa la hoja de cálculo.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorksheetActivatedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7]

Ocurre cuando se calcula la hoja de cálculo.

readonly onCalculated: OfficeExtension.EventHandlers<Excel.WorksheetCalculatedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.8]

Se produce cuando los datos cambian en una hoja de cálculo específica.

readonly onChanged: OfficeExtension.EventHandlers<Excel.WorksheetChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7]

Se produce cuando se han ordenado una o más columnas. Esto sucede como resultado de una operación de ordenación de izquierda a derecha.

readonly onColumnSorted: OfficeExtension.EventHandlers<Excel.WorksheetColumnSortedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.10]

Ocurre cuando la hoja de cálculo está desactivada.

readonly onDeactivated: OfficeExtension.EventHandlers<Excel.WorksheetDeactivatedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7]

Se produce cuando se cambia el formato una hoja de cálculo concreta.

readonly onFormatChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormatChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.9]

Se produce cuando se cambian una o varias fórmulas en esta hoja de cálculo. Este evento es para cuando cambia la propia fórmula, no el valor de datos resultante del cálculo de la fórmula.

Este evento solo se activa cuando la celda ya contiene una fórmula. Es posible que el nuevo valor de celda no incluya una fórmula. Este evento no se desencadena cuando se escribe una fórmula en una celda que anteriormente no contenía una fórmula.

readonly onFormulaChanged: OfficeExtension.EventHandlers<Excel.WorksheetFormulaChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.13]

Ocurre cuando se cambia el nombre de la hoja de cálculo.

readonly onNameChanged: OfficeExtension.EventHandlers<Excel.WorksheetNameChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.17]

Se produce cuando se cambia el estado de protección de la hoja de cálculo.

readonly onProtectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetProtectionChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.14]

Se produce cuando el estado oculto de una o más filas ha cambiado en una hoja de cálculo específica.

readonly onRowHiddenChanged: OfficeExtension.EventHandlers<Excel.WorksheetRowHiddenChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.11]

Se produce cuando se han ordenado una o más filas. Esto sucede cuando se produce una operación de ordenación de arriba a abajo.

readonly onRowSorted: OfficeExtension.EventHandlers<Excel.WorksheetRowSortedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.10]

Se produce cuando cambia la selección en una hoja de cálculo específica.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.WorksheetSelectionChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.7]

Se produce cuando se produce una acción con clic con el botón izquierdo o pulsado en la hoja de cálculo. Este evento no se activará al hacer clic en los siguientes casos:

• El usuario arrastra el mouse para la selección múltiple.

• El usuario selecciona una celda en el modo en que se seleccionan los argumentos de la celda para las referencias de fórmula.

readonly onSingleClicked: OfficeExtension.EventHandlers<Excel.WorksheetSingleClickedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.10]

Se produce cuando se cambia la visibilidad de la hoja de cálculo.

readonly onVisibilityChanged: OfficeExtension.EventHandlers<Excel.WorksheetVisibilityChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.17]