Referencia de la clase WriteWorkbookAdapter

Adaptador dedicado a la escritura en libros de trabajo. Más...

Diagrama de herencia de WriteWorkbookAdapter

Métodos públicos
	__New (workbook, targetSheet?)
	Crea un adaptor para la escritura en una de las hojas de cálculo de un libro de trabajo específico.
	AppendTable (objArray, expectedHeaders :=[])
	Crea o anexa una tabla, sean solo filas o solo columnas en la hoja de cálculo objetivo.
	FillBlankFieldsOnRow (row, obj)
	Rellena los espacios blancos de una fila.
	DeleteRow (row, expectedObj?, expectedHeaders :=[])
	Elimina la fila solicitada.
	DeleteTable (expectedHeaders :=[])
	Elimina todo el rango objetivo.
Métodos públicos heredados de WorkbookWrapper
	__New (workbook, targetSheet?)
	Crea un envoltorio para la administración de un libro de trabajo específico y una de sus hojas de cálculo.
	IsAvailable ()
	Comprueba si el libro de trabajo objetivo está abierto y accesible.
	IsWorkbookLocked ()
	Comprueba si el libro de cálculo objetivo está bloqueado.
	IsSheetLocked ()
	Comprueba si la hoja de cálculo objetivo está bloqueada.
	GetRowCount ()
	Obtiene el número de filas utilizadas en el rango objetivo.
	GetColumnCount ()
	Obtiene el número de columnas utilizadas en el rango objetivo.
	IsTargetSheetEmpty ()
	Comprueba si la hoja de cálculo objetivo está vacía.
	IsTargetWorkbook (workbook)
	Comprueba si un libro de trabajo coincide con el libro objetivo.
	HighlightRow (row)
	Señala con un color amarillo la fila indicada y restablece la anterior.
	ValidateHeaders (expectedHeaders, &missingHeaders :=unset)
	Normaliza las cabeceras de la tabla objetivo y las valida respecto a la colección facilitada.
	FindString (str, lookAt :=2, matchCase :=false)
	Busca una cadena en el rango objetivo y devuelve el número de fila relativa a la primera coincidencia en el rango utilizado.

Métodos privados
	_CreateTable (objArray)
	Crea una tabla a partir de la colección de objetos indicada.

Otros miembros heredados
Atributos públicos heredados de WorkbookWrapper
	Name => this._name
	{String} Nombre del libro de trabajo objetivo.
	TargetSheetName => this._targetSheetName
	{String} Nombre de la hoja de cálculo objetivo.
Métodos protegidos heredados de WorkbookWrapper
	_LockWorkbook (lock)
	Bloquea el libro de trabajo objetivo impidiendo la manipulación del número de hojas.
	_LockSheet (lock)
	Bloquea la hoja de cálculo objetivo impidiendo la modificación y la selección de sus celdas.
	_DeleteEmptyRows ()
	_GetTargetRange ()
	Obtiene el rango de la primera tabla si existiera, o el rango continuo utilizado.
	_WrapTargetRangeInTable (hasHeaders :=0)
	Envuelve el rango objetivo en una tabla si no existe ninguna.
	_GetRowSafeArray (row)
	Obtiene el contenido de una fila del rango objetivo como un SafeArray COM.
	_NormalizeTableHeaders ()
	Normaliza las cabeceras de la tabla objetivo conforme a __NormalizeHeader.
	_SpeedupIO (i)
Métodos protegidos estáticos heredados de WorkbookWrapper
static	_NormalizeObjProps (obj)
	Normaliza los nombres de las propiedades del objeto indicado conforme a __NormalizeHeader.
static	_CreateInteropArray (size1, size2)
	Crea un SafeArray bidimensional (VT_VARIANT) con índices de base 1 como los que devuelve Interop, que se supone utiliza una versión descontinuada del SafeArray.
Atributos protegidos heredados de WorkbookWrapper
_name	:= unset
_workbook	:= unset
_targetSheet	:= unset
_targetSheetName	:= unset

Descripción detallada

Adaptador dedicado a la escritura en libros de trabajo.

Autor

bitasuperactive

Fecha

25/12/2025

Versión

0.9.1-Beta

Atención

Dependencias:

• WorkbookWrapper.ahk
• Utils.ahk

Ver también

https://github.com/bitasuperactive/ahk2-excel-library/blob/master/ExcelLibrary/ExcelBridge/WriteWorkbookAdapter.ahk

Documentación de funciones miembro

__New()

WriteWorkbookAdapter::__New ( workbook , targetSheet?  )

inline

Crea un adaptor para la escritura en una de las hojas de cálculo de un libro de trabajo específico.

• Envuelve los datos preexistentes en una tabla para facilitar su delimitación.
• Elimina las filas vacías para facilitar la escritura.

Parámetros

{Microsoft.Office.Interop.Excel.Workbook}	workbook Libro de trabajo objetivo.
{Microsoft.Office.Interop.Excel.Worksheet}	targetSheet (Opcional) Hoja de cálculo objetivo. Por defecto, será la hoja de cálculo activa en el libro objetivo.

Excepciones

{TargetError}	(0x80010108) Si el libro de trabajo objetivo se encuentra cerrado.
{Error}	(0x80010001) Si Microsoft Excel rechaza la conexión a su interfaz.
{ValueError}	Si existe más de tabla definida en la hoja de cálculo objetivo.

_CreateTable()

WriteWorkbookAdapter::_CreateTable ( objArray )

inlineprivate

Crea una tabla a partir de la colección de objetos indicada.

Atención

Si utilizas la clase nativa Object para encapsular los datos a introducir, se impondrá un orden alfabético para la inserción de las columnas. Se recomienda utilizar OrObject.

Parámetros

{Array<Object>}

objArray Colección de objetos literales.

AppendTable()

WriteWorkbookAdapter::AppendTable ( objArray , expectedHeaders : = [] )

inline

Crea o anexa una tabla, sean solo filas o solo columnas en la hoja de cálculo objetivo.

Atención

Si utilizas la clase nativa Object para encapsular los datos a introducir, se impondrá un orden alfabético para la inserción de las columnas.

Nota

Se recomienda utilizar OrObject.

Parámetros

{Array<Object>}	objArray Colección de objetos literales.
{Array<String>}	expectedHeaders (Opcional) Colección de los nombres para las cabeceras requeridas.

Excepciones

{UnsetError}

Si la tabla no tiene alguna de las cabeceras esperadas.

Nota

Rendimiento: Escribe +2.000 datos en <1s.

DeleteRow()

WriteWorkbookAdapter::DeleteRow ( row , expectedObj? , expectedHeaders : = [] )

inline

Elimina la fila solicitada.

Parámetros

{Integer}	row Índice de la fila objetivo.
{Object}	expectedObj (Opcional) Objeto de validación para la fila objetivo. Tanto las cabeceras de la tabla como su contenido debe coincidir con las propiedades y valores del objeto.
{Array<String>}	expectedHeaders (Opcional) Colección de los nombres para las cabeceras requeridas. Útil si solo se requiere validar las cabeceras y no los datos.

Excepciones

{TargetError}	Si la fila a eliminar no coincide con el objeto de validación.
{UnsetError}	Si la tabla no tiene alguna de las cabeceras esperadas.

DeleteTable()

WriteWorkbookAdapter::DeleteTable ( expectedHeaders : = [] )

inline

Elimina todo el rango objetivo.

Parámetros

{Array<String>}

expectedHeaders (Opcional) Colección de los nombres para las cabeceras requeridas.

Excepciones

{UnsetError}

Si la tabla no tiene alguna de las cabeceras esperadas.

FillBlankFieldsOnRow()

WriteWorkbookAdapter::FillBlankFieldsOnRow ( row , obj  )

inline

Rellena los espacios blancos de una fila.

Nota

Las propiedades del objeto a introducir serán utilizadas para validar las cabeceras de la tabla.

Parámetros

{Integer}	row Índice de la fila objetivo.
{Object}	obj Objeto fuente de los datos a utilizar.

Excepciones

{TargetError}	Si la tabla no tiene las mismas cabeceras que propiedades tiene el objeto.
{UnsetError}	Si la tabla no tiene alguna de las cabeceras esperadas.
{ValueError}	Si la fila objetivo está fuera del rango utilizado.