Cosmos. Novedades y mejoras de la versión 4.2

Nuevos métodos

Clase ActiveX

GetObject
Este método se utiliza para obtener un objeto ActiveX, hijo del control ActiveX actual, cuyo nombre se pasa como parámetro. Esto hace que no sea necesario declarar y crear un objeto ActiveX por cada nivel que tenga el objeto ActiveX padre. No funciona para objetos indexados.

Sintaxis:

GetObject(activexname as Char) return Activex

Parámetros:

Activexname: Indica el nombre del Actives.

Retorna: Objeto ActiveX.

Clase SimpleControl

IsColumnVisible
Devuelve TRUE si la columna especificada de una lista de columnas es visible.

Sintaxis:

IsColumnVisible(column as Smallint) return Boolean

Parámetros:

Column: Indica la posición de la columna dentro de la lista.

Retorna:

TRUE si la columna indicada como parámetro es visible.
FALSE si no lo es.

SetColumnVisible
Muestra u oculta la columna especificada de una lista de columnas.

Sintaxis:

SetColumnVisible(column as Integer, visible as boolean)

Parámetros:

Column: Indica la posición de la columna que queremos ocultar o mostrar.

Visible: Sus valores son TRUE o FALSE, dependiendo de si lo que se desea es visualizar u ocultar la columna.

GetType
Devuelve un string indicando el tipo de un control:

WINDOW	BUTTON	RADIO	CHECK	DROPLIST
DROPEDIT	EDIT	TEXT	BOX	LINE
PORC	TAB	BUTTONLIST	MBLIST	BOXLIST
BAR	PANEL	LINES	USER	MENU
MBGRID	SPLIT	SPIN	SLIDER	BANDGROUP
ACTIVEX	MDICLIENT	CALENDAR	BITMAP

Sintaxis:

GetType () return Char

Retorna: Nombre del control.

ShowAllColumns
Muestra todas las columnas de una lista de columnas.

Sintaxis:

ShowAllColumns()

GetCurrentItem
Devuelve el ítem de la columna en curso. Para controles tipo lista de columnas y listas de botones y cajas.

Sintaxis:

GetCurrentItem() return Smallint

Retorna: El elemento en curso.

SetOrderBy
Permite ordenar una lista de columnas por varias columnas de forma ascendente o descendente. Se especifica tal y como se haría en la cláusula ORDER BY de una sentencia SQL utilizando el número de las columnas. (Por ejemplo: “1 desc,3,5 desc”).

Sintaxis:

SetOrderBy(orderby as char)

Parámetros:

Orderby: Ordenación que queremos realizar.

GetOrderBy
Devuelve una cadena con el orden definido en una lista de columnas. (Por ejemplo: “1 desc,3,5 desc”).

Sintaxis:

GetOderBy() return Char

Retorna: La ordenación utilizada en el método SetOrderBy.

GetColumnLabel
Devuelve el título de una columna de un control lista de columnas.

Sintaxis:

GetColumnLabel(column as Smallint) return Char

Parámetros:

Column: Índice de la columna de la que se quiere mostrar el título.

Retorna: Título de la columna.

GetColumnName
Devuelve el nombre de una columna de un control lista de columnas de tipo SQL.

Sintaxis:

GetColumnName(column as Smallint) return Char

Parámetros:

Column: Índice de la columna de la que se quiere mostrar el nombre.

Retorna: Nombre de la columna.

AddColumnFilter
Añade un filtro a una lista de columnas por la columna, operador y valor especificados. El filtro se añade a los que pudiera haber con anterioridad.

Sintaxis:

AddColumnFilter(column as Integer, operador as Char,
values as Char, refresh as Boolean default TRUE)

Parámetros:

Column: Índice de la columna.

Operador: Operador que se va a utilizar en el filtro.

Los operadores validos para las listas tipo SQL son: =, <, <=, >, >=, <>, matches, like.

Los operadores válidos para las listas tipo string son: =, <, <=, >, >=, <>.

Hay que tener en cuenta que los operadores serán validados por el gestor de base de datos al que estemos accediendo.

Values: Indica los valores por los que queremos filtrar.

Refresh: TRUE si queremos que refresque la lista y FALSE si no queremos que lo haga.

ResetColumnFilter
“Resetea” los filtros de la columna especificada de una lista de columnas.

Sintaxis:

ResetColumnFilter(column as Smallint)

Parámetros:

Column: Índice de la columna.

ResetFilters
“Resetea” todos los filtros de columnas de una lista de columnas.

Sintaxis:

ResetFilter()

SetColumnWidth
Permite modificar el ancho de una columna en píxeles de un control lista de columnas.

Sintaxis:

SetColumnWidth(column as Smallint, values as Smallint)

Parámetros:

Column: Índice de la columna.

Values: Tamaño en píxeles que se le quiere dar a la columna.

GetColumnWidth
Permite obtener el ancho de una columna de un control lista de columnas.

Sintaxis:

GetColumnWidth(column as Smallint) return Smallint

Parámetros:

Column: Índice de la columna.

Retorna: Ancho en píxeles de la columna que recibe como parámetro

SetColumnPosition
Permite modificar la posición de una columna de un control lista de columnas.

La posición de display de una columna no modifica el número de la columna, de modo que para acceder a cualquier información de una columna se debe utilizar el número de columna original.

Sintaxis:

SetColumnPosition (column as Smallint, values as Smallint)

Parámetros:

Column: Índice de la columna.

Values: Indica el índice de la columna donde se va a mostrar la columna.

GetColumnPosition
Permite obtener la posición de display de una columna de un control lista de columnas.

Sintaxis:

GetColumnPosition (column as Smallint) return Smallint

Parámetros:

Column: Índice de la columna.

Retorna: Posición en que se mostrará la columna.

GetColumnSum
Permite obtener el sumatorio de los valores de una columna de un control lista de columnas. [En las listas de tipo SQL se ejecuta internamente una Select Sum().] El valor de la suma lo devuelve en el parámetro pasado por referencia.. Sólo para controles lista de columnas.

Sintaxis:

GetColumnSum (column as Smallint, VAR sum as Object)
return Boolean

Parámetros:

Column: Índice de la columna. No permite expresiones.

Sum: Objeto en el que se obtiene el resultado de la suma.

Retorna:

TRUE siempre que no se produzca un error.
FALSE si se produce un error.
NULL si al objeto que se aplica es nulo.

IsNodeOpen
Recibe como parámetro el índice del nodo y devuelve si el nodo está abierto o no. Sólo para controles listas en árbol.

Sintaxis:

IsNodeOpen (index as Integer) return Boolean.

Parámetros:

Index: Índice del nodo.

Retorna:

TRUE si el nodo está abierto.
FALSE si está cerrado.
NULL en caso de error.

CollapseNode
Cierra el nodo especificado de una lista en árbol. Sólo para controles lista en árbol.

Sintaxis:

CollapseNode (index as Integer, recursive as Boolean
default FALSE) return Boolean

Parámetros:

Index: Índice del nodo que se quiere cerrar.

Recursive: TRUE si se quieren cerrar todos sus hijos recursivamente y FALSE en caso contrario.

Retorna:

TRUE en caso de haber cerrado el nodo.
FALSE si el nodo ya está cerrado.
NULL en caso de error.

ExpandNode
Abre el nodo especificado de una lista en árbol. Recibe como parámetro el índice del nodo que se quiere abrir y si se quiere que se abran todos sus hijos recursivamente o no. Sólo para controles lista en árbol.

Sintaxis:

ExpandNode (index as Integer, recursive as Boolean
default FALSE) return Boolean

Parámetros:

Index: índice del nodo que se quiere abrir.

Recursive: TRUE si se quieren abrir todos sus hijos recursivamente y FALSE en caso contrario.

Retorna:

TRUE si abre el nodo.
FALSE si el nodo ya estaba abierto.
NULL en caso de error.

SetTabPageIcon
Permite cambiar el icono de una página de un tab control en tiempo de ejecución. Sólo para controles tab.

Sintaxis:

SetTabPageIcon (page as Smallint, icon as Smallint) return Boolean

Parámetros:

page: Índice de la página sobre la que se quiere cambiar el icono.

Icon: Índice del icono.

Retorna: TRUE si la operación se ha realizado correctamente, FALSE en caso contrario.

Clase Form

SetMinTrackSize
Establece el tamaño mínimo de un Form.

Sintaxis:

SetMinTrackSize (xSize as Integer, ySize
as Integer) return Boolean

Parámetros:

xSize: Ancho de la ventana en píxeles.

ySize: Alto de la ventana en píxeles.

Retorna: TRUE si no hay error y FALSE si ha habido alguno.

SetMaxTrackSize
Establece el tamaño máximo de un Form.

Sintaxis:

SetMaxTrackSize (xSize as Integer, ySize
as Integer) return Boolean

Parámetros:

xSize: Ancho de la ventana en píxeles.

ySize: Alto de la ventana en píxeles.

Retorna: TRUE si no hay error y FALSE si ha habido alguno.

Clase SqlCursor

GetDataToFile
Guarda en el fichero indicado en “fileName” la columna de tipo BLOB o CLOB en una conexión ODBC contra la base de datos Oracle.

Sintaxis:

GetDataToFile (indCol as Smallint, fileName as Char)
return Boolean

Parámetros:

indCol: Posición de la columna dentro de la lista de columnas indicadas en la Select.

fileName: Nombre del fichero.

Retorna: TRUE si la operación se ha realizado correctamente, FALSE en caso de error.

Clase SqlServer

LoadFrom
Permite cargar una tabla desde un fichero “unl” a partir una línea determinada del fichero.

Es igual al método Load, pero con un parámetro más en el que se le puede indicar el número de línea del fichero “unl” desde el que se desea cargar.

Sintaxis:

LoadFrom (file as Char, table as Char, columnlist as Char
default NULL, delim as Char default NULL, quoted as Boolean
default NULL, oem as Boolean default FALSE,
line as interger) return integer

Parámetros:

file: Fichero ASCII desde el que se va realizar la carga de los datos. Ruta completa.

tabla: Nombre de la tabla sobre la que se va a realizar la carga.

Columnlist: Lista de columnas, separada por comas, de la tabla que se desean cargar.

Delim: Carácter utilizado como separador de campos en el fichero ASCII.

Quoted Indica si los campos de tipo Char en el fichero ASCII van entrecomillados o no. Si es NULL el valor que toma es el definido en la variable de entorno DBQUOTED. Si ésta no está definida su valor por defecto será FALSE (sin comillas).

Oem Si es TRUE carga el fichero con el conjunto de Caracteres OEM, y si es FALSE lo carga en ANSI.

Line: Línea desde la que se quiere iniciar la carga.

Retorna: Número de filas que se han cargado.

Clase Event

GetControl
Devuelve el objeto de la SimpleFormControl.

Sintaxis:

GetControl () return SimpleFormControl

Retorna: Un objeto de la clase SimpleFormControl.

Clase Module

SetHeaderContextMenu
Permite definir un menú de contexto para la cabecera de un tipo de control, como por ejemplo una lista de columnas. Se ejecutará al pulsar el botón derecho del ratón. El menú especificado permanecerá asignado durante la ejecución de la aplicación. Para desactivarlo habrá que ejecutar este método con el argumento menú a nulo.

Sintaxis:

SetHeaderContextMenu(controlType as Char, VAR aMenu as Menu)

Parámetros:

controlType: String con el tipo de control al que se va asociar el menú. Sus posibles valores son: “LIST” y “GRID”.

aMenu: Objeto menú.

SetContextMenu
Permite definir un menú de contexto para un tipo de control que se ejecutará al pulsar el botón derecho del ratón. El menú especificado permanecerá asignado durante la ejecución de la aplicación. Para desactivarlo habrá que ejecutar este método con el argumento menú a nulo.

Sintaxis:

SetContextMenu(controlType as Char, VAR aMenu as Menu)

Parámetros:

controlType: String con el tipo de control al que se va asociar el menú. Los posibles valores de este parámetro son:

BUTTON	RADIO	CHECK	DROPLIST	DROPEDIT
EDIT	TEXT	BOX	LINE	PERCENT
TAB	LIST	MENU	GRID	BOXGROUP
PANEL	LINES	USER	BAR	BUTTONGROUP
SPLIT	SPIN	SLIDER	ACTIVES	MDICLIENT
CALENDAR

aMenu: Objeto menú.

Clase FormTable

GetColumnSum
Permite obtener el sumatorio de la columna especificada para las filas de la lista en curso del FormTable. Se ejecuta internamente un Select Sum().

Sintaxis:

GetColumnSum(sqlExpresion as Char, VAR sum as Object)

Parámetros:

SqlExpresion: Columna o expresión SQL.

Sum: Variable por referencia donde se almacenará el valor de la suma.

Ejemplo:

articulos.GetColumnSum("pr_vent", Suma)

articulos.GetColumnSum("pr_vent - pr_cost", Suma)

GetWhere
Devuelve una cadena de caracteres con las actuales condiciones de búsqueda del FormTable.

Sintaxis:

GetWhere() return Char