plantilla Velneo v2Excel

Copyright Velneo 2007

ndice
1
2

Parmetros....................................................................................................................................... 3
Funciones......................................................................................................................................... 4
2.1
Excel.............................................................................................................................................. 4
2.1.1
EXCEL-INICIAR........................................................................................................................ 4
2.1.2
EXCEL-CERRAR...................................................................................................................... 4
2.1.3
EXCEL-CERRAR-TODAS ........................................................................................................ 4
2.1.4
EXCEL-VERSION..................................................................................................................... 4
2.2
Libro............................................................................................................................................... 5
2.2.1
EXCEL-LIBRO-NUEVO ............................................................................................................ 5
2.2.2
EXCEL-LIBRO-GUARDAR....................................................................................................... 5
2.2.3
EXCEL-LIBRO-IMPRIMIR ........................................................................................................ 5
2.2.4
EXCEL-LIBRO-CERRAR.......................................................................................................... 5
2.2.5
EXCEL-LIBRO-NUMERO......................................................................................................... 5
2.2.6
EXCEL-LIBRO-OBTENER-NOMBRE ...................................................................................... 5
2.2.7
EXCEL-LIBRO-OBTENER-POSICION..................................................................................... 5
2.2.8
EXCEL-LIBRO-NUMERO-HOJAS............................................................................................ 6
2.3
Hoja ............................................................................................................................................... 6
2.3.1
EXCEL-HOJA-NUEVA.............................................................................................................. 6
2.3.2
EXCEL-HOJA-GUARDAR ........................................................................................................ 6
2.3.3
EXCEL-HOJA-IMPRIMIR ......................................................................................................... 6
2.3.4
EXCEL-HOJA-CERRAR........................................................................................................... 6
2.3.5
EXCEL-HOJA-ASIGNAR NOMBRE ......................................................................................... 6
2.3.6
EXCEL-HOJA-OBTENER-NOMBRE........................................................................................ 7
2.3.7
EXCEL-HOJA-OBTENER-POSICION...................................................................................... 7
2.3.8
EXCEL-HOJA-CELDAS-USADAS............................................................................................ 7
2.4
Grfico ........................................................................................................................................... 7
2.4.1
EXCEL-GRAFICO-NUEVO ...................................................................................................... 7
2.4.2
EXCEL-GRAFICO-IMPRIMIR................................................................................................... 7
2.4.3
EXCEL-GRAFICO-EXPORTAR ............................................................................................... 7
2.4.4
EXCEL-GRAFICO-CERRAR .................................................................................................... 8
2.4.5
EXCEL-GRAFICO-TIPO........................................................................................................... 8
2.4.6
EXCEL-GRAFICO-POSICION-TAMAO ................................................................................. 8
2.4.7
EXCEL-GRAFICO-POSICION-TAMAO ................................................................................. 8
2.5
Celda ............................................................................................................................................. 8
2.5.1
EXCEL-CELDA-ASIGNAR-VALOR-POR-POSICION .............................................................. 8
2.5.2
EXCEL-CELDA-OBTENER-VALOR-POR-POSICION ............................................................. 8
2.5.3
EXCEL-CELDA-ASIGNAR-VALOR-POR-NOMBRE ................................................................ 8
2.5.4
EXCEL-CELDA-OBTENER-VALOR-POR-NOMBRE............................................................... 9
2.5.5
EXCEL-CELDA-ALINEACION-H .............................................................................................. 9
2.5.6
EXCEL-CELDA-ALINEACION-V .............................................................................................. 9
2.5.7
EXCEL-CELDA-ALTO-FILA ..................................................................................................... 9
2.5.8
EXCEL-CELDA-ANCHO-COLUMNA ....................................................................................... 9
2.5.9
EXCEL-CELDA-COLOR........................................................................................................... 9
2.5.10
EXCEL-CELDA-ESTILO ...................................................................................................... 9
2.5.11
EXCEL-CELDA-TIPO-LETRA............................................................................................ 10
2.5.12
EXCEL-CELDA-TIPO-LETRA-COLOR.............................................................................. 10
2.5.13
EXCEL-CELDA-TIPO-LETRA-TAMAO ........................................................................... 10
2.5.14
EXCEL-CELDA-FORMATO-NUMERICO .......................................................................... 10

Pg 2

Parmetros

bPrevisualizacion: valor 0 (se imprime en el dispositivo). Valor 1 (se genera

una vista previa).
bTieneLeyenda: valor 0 (no mostrar leyenda). Valor 1 (mostrar leyenda).
bVisible: establece si el libro va a ser visible (valor 1) o invisible (valor 0).
nAltoFila : alto de la fila en la que se encuentra la columna.
nAnchoColumna : ancho de la columna en la que se encuentra la celda.
nColor : nmero indexado del color.
nColor: color de fondo de la celda.
nColumna: columna de la celda.
nCopias: nmero de copias a imprimir.
nChart: identificador del grfico.
nDibujarPor: Orientacin del origen de datos para el grfico. Valor 1 (filas).
Valor 2 (columnas).
nEstilo : estilo de la celda ("normal", "negrita", "cursiva", "negrita cursiva").
nFila: fila de la celda.
nHAp: manejador de la instancia abierta.
nHoja: posicin de la hoja.
nLibro: posicin del libro.
nPatron: nmero de patrn del color de fondo de la celda.
nTamao: tamao en puntos del tipo de letra de la celda.
nTipo: tipo de grafico: rea: 1, rea 3D: -4098, Barras: 2, Barras 3D: -4099,
Burbuja: 15, Columnas 3D: -4100, Donut: -4120, Lneas: 4, Lneas 3D: 4101, Radar: -4151, Superficie 3D: -4103, Tarta: 5, Tarta 3D: -4102.
nXFin: posicin X esquina inferior derecha del grfico.
nXIni: posicin X esquina superior izquierda del grfico.
nYFin: posicin Y esquina inferior derecha del grfico.
nYIni: posicin Y esquina superior izquierda del grfico.
szClave: clave de uso del producto especfica para cada desarrollador.
szCoordenada: coordenada o nombre de la celda.
szFormatoNumerico : modifica el formato numrico de la celda.
szImpresora: impresora en la que se realizar la impresin.
szLibro: nombre del libro.
szLibro: senda y nombre del libro a abrir.
szRangoFin: posicin abajo-derecha de los datos.
szRangoIni: posicin arriba-izquierda de los datos.

Pg 3

 szSenda: senda donde se guarda el libro.

szTipoLetra : tipo de letra de la celda.
szTitulo: ttulo del grfico.
szTituloEjeX: ttulo del eje X.
szTituloEjeY: ttulo del eje Y.
szValor: valor de la celda.

Funciones

2.1 Excel
2.1.1

EXCEL-INICIAR

Descripcin: inicia Excel.

Parmetros:
szClave , szLibro, bVisible

Valores que devuelve:

Valor -2: La clave de licencia introducida no es vlida.
Valor -1: No ha sido posible abrir el archivo.
Valor 0 o mayor: Identificador o manejador de la instancia abierta.

Importante: Si ejecutamos en 2 plano (Multitarea) o 3 plano (Servidor),

en el mismo objeto proceso que se abre la hoja Excel ha de cerrarse
(EXCEL-CERRAR()), ya que si no la instancia quedar abierta. La librera
debe estar en la misma carpeta que el ejecutor (vRunner, iRunner.exe o
vMotor.exe).

2.1.2

EXCEL-CERRAR

Descripcin: cierra Excel.

Parmetros:
nHAp.

Importante: Si ejecutamos en 2 plano (Multitarea) o 3 plano (Servidor),

en el mismo objeto proceso que se abre la hoja Excel (EXCEL-ABRIR() )ha
de cerrarse, ya que si no la instancia quedar abierta.

2.1.3

EXCEL-CERRAR-TODAS

Descripcin: cierra todas las hojas Excel que se encuentren abiertas en el

hilo.

Parmetros: no tiene.

Importante: Si ejecutamos en 2 plano (Multitarea) o 3 plano (Servidor),

en el mismo objeto proceso que se abre la hoja Excel (EXCEL-ABRIR() )ha
de cerrarse, ya que si no la instancia quedar abierta.

2.1.4

EXCEL-VERSION

Descripcin: obtiene la versin de Excel.

Parmetros: no tiene.

Pg 4

2.2 Libro
2.2.1

EXCEL-LIBRO-NUEVO

Descripcin: crea un nuevo libro.

Parmetros:
nHAp.

Valores que devuelve:

Valor >=0: Posicin del libro creado.
Valor -1: Error, el nuevo libro no se ha podido crear.
2.2.2

EXCEL-LIBRO-GUARDAR

Descripcin: guarda el libro.

Parmetros:
nHAp, nLibro, szSenda.

Valores que devuelve:

Valor 0: No se ha podido guardar el libro.
Valor 1: El libro se ha guardado correctamente.
2.2.3

EXCEL-LIBRO-IMPRIMIR

Descripcin: imprime el libro.

Parmetros:
nHAp, nLibro, nCopias, bPrevisualizacion, szImpresora.

Valores que devuelve:

Valor 0: No se ha podido imprimir el libro.
Valor 1: El libro se ha impreso correctamente.
2.2.4

EXCEL-LIBRO-CERRAR

Descripcin: cerrar el libro.

Parmetros:
nHAp, nLibro.

Valores que devuelve:

Valor 0: No se ha podido cerrar el libro.
Valor 1: El libro se ha cerrado correctamente.
2.2.5

EXCEL-LIBRO-NUMERO

Descripcin: calcula el nmero de libros.

Parmetros:
nHAp.

Valores que devuelve:

Valor >= 0: nmero de libros.
Valor -1: error, no se ha podido calcular.
2.2.6

EXCEL-LIBRO-OBTENER-NOMBRE

Descripcin: obtiene el nombre del libro.

Parmetros:
nHAp, nLibro.
2.2.7

EXCEL-LIBRO-OBTENER-POSICION

Descripcin: obtiene la posicin del libro.

Parmetros:
nHAp, szLibro.

Pg 5


Valores que devuelve:
Valor >= 0: posicin del libro.
Valor -1: error, no se ha podido obtener.
2.2.8

EXCEL-LIBRO-NUMERO-HOJAS

Descripcin: calcula el nmero de hojas del libro.

Parmetros:
nHAp, nLibro.

Valores que devuelve:

Valor >= 0: nmero de hojas del libro.
Valor -1: error, no se ha podido calcular.

2.3 Hoja
2.3.1

EXCEL-HOJA-NUEVA

Descripcin: crea una nueva hoja.

Parmetros:
nHAp, nLibro.

Valores que devuelve:

Valor >= 0: posicin de la hoja.
Valor -1: error, no se ha podido crear.
2.3.2

EXCEL-HOJA-GUARDAR

Descripcin: guarda la hoja.

Parmetros:
nHAp, nLibro, nHoja.

Valores que devuelve:

Valor 0: No se ha podido guardar la hoja.
Valor 1: La hoja se ha cerrado correctamente.
2.3.3

EXCEL-HOJA-IMPRIMIR

Descripcin: imprime la hoja.

Parmetros:
nHAp, nLibro, nHoja, nCopias, bPrevisualizacion, szImpresora.

Valores que devuelve:

Valor 0: No se ha podido imprimir la hoja.
Valor 1: La hoja se ha impreso correctamente.
2.3.4

EXCEL-HOJA-CERRAR

Descripcin: cierra la hoja.

Parmetros:
nHAp, nLibro, nHoja.

Valores que devuelve:

Valor 0: No se ha podido cerrar la hoja.
Valor 1: La hoja se ha cerrado correctamente.
2.3.5

EXCEL-HOJA-ASIGNAR NOMBRE

Descripcin: renombra una hoja.

Parmetros:
nHAp, nLibro, nHoja, szNombre.

Valores que devuelve:

Valor 0: No ha sido posible renombrar la hoja.

Pg 6

Valor 1: Hoja renombrada.

2.3.6

EXCEL-HOJA-OBTENER-NOMBRE

Descripcin: obtiene el nombre de la hoja.

Parmetros:
HAp, nLibro, nHoja.
2.3.7

EXCEL-HOJA-OBTENER-POSICION

Descripcin: obtiene la posicin de la hoja.

Parmetros:
HAp, nLibro, szNombreHoja.

Valores que devuelve:

Valor >= 0: posicin de la hoja.
Valor -1: error, no se ha podido obtener.
2.3.8

EXCEL-HOJA-CELDAS-USADAS

Descripcin: calcula del nmero de celdas usadas en la hoja.

Parmetros:
HAp, nLibro, nHoja.

Valores que devuelve:

Valor >= 0: nmero de celdas.
Valor -1: error, no se ha podido calcular.

2.4 Grfico
2.4.1

EXCEL-GRAFICO-NUEVO

Descripcin: crea un nuevo grfico.

Parmetros:
nHAp, nLibro, nHoja, nXIni, nYIni, nXFin, nYFin, nTipoGrafico, szRangoIni,
szRangoFin, szTitulo, szTituloEjeX, szTituloEjeY.

Valores que devuelve:

Valor >= 0: posicin del grfico
Valor -1: error, no se ha podido crear.
2.4.2

EXCEL-GRAFICO-IMPRIMIR

Descripcin: imprimir el grfico.

Parmetros:
nHAp, nLibro, nHoja, nGrafico, bPrevisualizacion, szImpresora.

Valores que devuelve:

Valor 0: No se ha podido imprimir el grfico.
Valor 1: Se ha impreso correctamente.
2.4.3

EXCEL-GRAFICO-EXPORTAR

Descripcin: exporta un grfico.

Parmetros:
nHAp, nLibro, nHoja, nChart, szSenda.

Valores que devuelve:

Valor 0: No se ha podido exportar el grfico.
Valor 1: Se ha exportado correctamente.

Pg 7

2.4.4

EXCEL-GRAFICO-CERRAR

Descripcin: cierra el grfico activo.

Parmetros:
nHAp, nLibro, nHoja, nChart.

Valores que devuelve:

Valor 0: No se ha podido cerrar el grfico.
Valor 1: Se ha cerrado correctamente.
2.4.5

EXCEL-GRAFICO-TIPO

Descripcin: fija el tipo de grfico.

Parmetros:
nHAp, nLibro, nHoja, nChart, nTipo, bTieneLeyenda, nDibujarPor

Valores que devuelve:

Valor 0: Error.
Valor 1: Se ha asignado el tipo
2.4.6

EXCEL-GRAFICO-POSICION-TAMAO

Descripcin: fija la posicin y tamao del grfico.

Parmetros:
nHAp, nLibro, nHoja, nChart, nXIni, nYIni, nXFin, nYFin

Valores que devuelve:

Valor 0: No ha sido posible cambiar la posicin del grfico.
Valor 1: El grfico ha sido cambiado de posicin correctamente.
2.4.7

EXCEL-GRAFICO-POSICION-TAMAO

Descripcin: fija la posicin y tamao del grfico.

Parmetros:
nHAp, nLibro, nHoja, nChart, nXini, nYini, nXfin, nYfin

Valores que devuelve:

Valor 0: No ha sido posible cambiar la posicin del grfico.
Valor 1: El grfico ha sido cambiado de posicin correctamente.

2.5 Celda
2.5.1

EXCEL-CELDA-ASIGNAR-VALOR-POR-POSICION

Descripcin: asigna una celda por posicin.

Parmetros:
nHAp, nLibro, nHoja, nFila, nColumna, szValor

Valores que devuelve:

Valor 0: Error.
Valor 1: Se ha asignado el valor.
2.5.2

EXCEL-CELDA-OBTENER-VALOR-POR-POSICION

Descripcin: obtiene una celda por posicin.

Parmetros:
nHAp, nLibro, nHoja, nFila, nColumna
2.5.3

EXCEL-CELDA-ASIGNAR-VALOR-POR-NOMBRE

Descripcin: asigna una celda por nombre.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, szValor

Pg 8


Valores que devuelve:
Valor 0: Error.
Valor 1: Se ha asignado el valor.
2.5.4

EXCEL-CELDA-OBTENER-VALOR-POR-NOMBRE

Descripcin: obtiene una celda por nombre.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada
2.5.5

EXCEL-CELDA-ALINEACION-H

Descripcin: alinea horizontalmente.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, szTipoAlineacion

Valores que devuelve:

Valor 0: Error.
Valor 1: Alineacin realizada.
2.5.6

EXCEL-CELDA-ALINEACION-V

Descripcin: alinea verticalmente.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, szTipoAlineacion

Valores que devuelve:

Valor 0: Error.
Valor 1: Alineacin realizada.
2.5.7

EXCEL-CELDA-ALTO-FILA

Descripcin: modifica el alto de la fila para la fila.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nAltoFila

Valores que devuelve:

Valor 0: Error.
Valor 1: Alineacin realizada.
2.5.8

EXCEL-CELDA-ANCHO-COLUMNA

Descripcin: modifica el ancho de la columna de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nAnchoColumna

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.9

EXCEL-CELDA-COLOR

Descripcin: modifica el color de fondo de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nColor, nPatron

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.10

EXCEL-CELDA-ESTILO

Descripcin: modifica el estilo de la celda.

Pg 9


Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nEstilo

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.11

EXCEL-CELDA-TIPO-LETRA

Descripcin: modifica el tipo de letra de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, szTipoLetra

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.12

EXCEL-CELDA-TIPO-LETRA-COLOR

Descripcin: modifica el color del tipo de letra de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nColor

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.13

EXCEL-CELDA-TIPO-LETRA-TAMAO

Descripcin: modifica el tamao del tipo de letra de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, nTamao

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.
2.5.14

EXCEL-CELDA-FORMATO-NUMERICO

Descripcin: modifica el formato numrico de la celda.

Parmetros:
nHAp, nLibro, nHoja, szCoordenada, szFormatoNumerico

Valores que devuelve:

Valor 0: Error.
Valor 1: Modificacin realizada.

Pg 10