Comment on page
VApp
Este clase representa a la aplicación. Dispone de funciones para ver información de sus proyectos, acceso a variables globales, constantes, utilidades de base de datos, disco, etc.
Se trata de un objeto de esta clase.
Todos los scripts están conectados a un objeto global y único que representa a la aplicación cuyo nombre es theApp. Este objeto está disponible en ejecución de scripts en Velneo vClient, pero también en extensiones en Velneo vDevelop, aunque no aquellas funciones que tienen sentido únicamente en ejecución (Ver documentación de VExtension).
Hay que tener en cuenta que la aplicación da acceso al proyecto principal con el que se ha arrancado la aplicación y todos sus objetos heredados lo que permite el acceso y uso de cualquier objeto de la aplicación desde cualquier script.
void printReportToPrinter( VRegisterList list, String idRefReport, String printerName, [Boolean bHighRes=false])
Emite un pitido a través del altavoz del sistema.
Devuelve en minúsculas el hash de una cadena en función del parámetro.
Parámetros:
Devuelve el nombre del ejecutable en curso como vClient, vDataClient, vAdmin, vDevelop, vClient (Agente), vServer, vModApache.
Muestra una ventana de notificación sin bloqueo de la interfaz.
Parámetros:
- szMensaje: cadena con el texto a presentar en la notificación. Icono del mensaje
- icon type message: permite mostrar un objeto VImage que se mostrará a la izquierda del texto de la notificación; por ejemplo, un icono de advertencia, peligro, información. Este parámetro es opcional.
- icon close: permite personalizar el icono de cierre que se usa por defecto para las notificaciones. Para ello usaremos un objeto VImage. Este parámetro es opcional.
- secondsDuration: permite configurar el tiempo que la notificación permanecerá en pantalla antes de cerrarse automáticamente. Si no se especifica durará 7 segundos, que es el tiempo por defecto. Si se pone un 0, la notificación debe ser cerrada por el usuario. Este parámetro es opcional.
Procesa los eventos que haya en la cola de la aplicación, excluyendo los de entrada de usuario (teclado, ratón...). Debe usarse donde se consuma mucho tiempo o bucles largos para que se refresque el interfaz. Solo actúa en procesos en primer plano ya que es en estos donde estamos ocupando el hilo principal que es el que atiende la cola de eventos. En los demás no hace nada.
Retorna la cadena que pasamos como parámetro sin etiquetas html. El código html debe estar bien conformado para que retorne contenido.
Parámetros:
- szHtml: cadena de texto que contiene el código Html correctamente conformado del que queremos extraer el texto sin etiquetas html.
El proceso queda detenido en este punto durante el tiempo especificado en el parámetro.
Parámetros:
- miliSegs: número de milisegundos de espera, por ejemplo: 1000 = 1 segundo.
Si la usamos en un proceso ejecutado en 4º plano, esta función devolverá el proyecto donde esté declarado el proceso, tenga proyectos o no por encima, el motivo de esto es que
cuando se ejecuta el proceso el servidor crea un enganche temporal para gestionarlo, en ese momento, conoce el proyecto donde está el objeto y lo que hereda, pero no conoce todo lo que tiene por encima.
Esta función es de uso exclusivo en las extensiones de Velneo vDevelop (clase vExtension).Devuelve un objeto VProjectInfo con la información del proyecto cuyo tipo e index dentro de la solución hayamos pasado como parámetro.
Parámetros:
- index: index dentro de la solución.
Parámetros:
- szAlias: alias del proyecto.
Devuelve el valor de una variable global de tipo booleano.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo fecha.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo tiempo, fecha y hora.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo numérico, con decimales.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo numérico, entero.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo alfabética.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve el valor de una variable global de tipo hora.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
Devuelve true si la variable global está vacía. Las numéricas se asumen vacías con el valor 0.
Parámetros:
- szIdRefVar: idRef de la variable "ALIASPROYECTO/IDVARIABLE".
Asigna el valor a la variable global de tipo alfabética.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- szValue: valor alfabético.
Asigna el valor a la variable global de tipo numérica.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- nValue: valor numérico.
Asigna el valor a la variable global de tipo booleano.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- bValue: valor booleano.
Asigna el valor a la variable global de tipo tiempo, fecha y hora.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- dtValue: valor de tipo tiempo, fecha y hora.
Asigna el valor a la variable global de tipo fecha.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- dValue: valor de tipo fecha.
Asigna el valor a la variable global de tipo hora.
Parámetros:
- szIdRefVar: identificador de referencia de la variable global.
- tValue: valor de tipo hora.
Devuelva el contenido de una constante.
Parámetros:
- szIdRefConstante: idRef del objeto constante "ALIAS_PROYECTO/ID_OBJETO".
Devuelve el contenido de una constante en el idioma y país especificado en los parámetros. El país es un parámetro opcional, si no se especifica asume el más genérico de los existentes para ese idioma.
Parámetros:
- szIdRefConstante: idRef del objeto constante "ALIAS_PROYECTO/ID_OBJETO".
- país: código numérico del país, por ejemplo: UnitedKingdom = 224. Este es un parámetro opcional. Ver enum de países.
Esta función permite compactar datos (dat/idx) y/o cotenedor (cnd/cni) de una o varias tablas.
Parámetros:
- idRefTabla: identificador de referencia de la tabla a compactar. Si se deja en vacío se compactarán todas las tablas de todos los proyectos cargados.
- Umbral mínimo: valor numérico entero y positivo (entre 0 y 100).
Vacía la tabla que le pasamos por parámetro, es decir, borra todo su contenido (datos, índices y contenedor).
Esta función no transacciona y no debe estar incluida en ninguna transacción, o no haber comenzado ésta hasta que se haya usado la función. En cuanto comienza transacción ya no se puede usar.
Parámetros:
- idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA" a vaciar.
Regenera un índice complejo. Si indicamos true en el 2º parámetro se mostrará la barra de progreso.
Parámetros:
- idRefIdxComplejo: idRef del índice complejo "ALIAS_PROYECTO/ID_INDICE_COMPLEJO".
- bProgressDialog: true para indicar que sea visible la barra de progreso.
Hace una regeneración del área de datos de la tabla seleccionada en el primer parámetro, de su contenedor y también la regeneración de los índices de tabla y contenedor. Si indicamos true en el 2º parámetro se mostrará la barra de progreso. Esta función lanzada sobre tablas en memoria siempre devuelve false.
Parámetros:
- idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA".
- bProgressDialog: true para indicar que sea visible la barra de progreso.
Regenera los índices de tabla indicada en el primer parámetro y su contenedor. Si indicamos true en el 2º parámetro se mostrará la barra de progreso.
Parámetros:
- idRefTabla: idRef de la tabla "ALIAS_PROYECTO/ID_TABLA".
- bProgressDialog: true para indicar que sea visible la barra de progreso.
Devuelve el directorio de la aplicación en el que está siendo ejecutado el script.
Devuelve la senda de la aplicación en el que está siendo ejecutado el script.
Elimina del path los separadores "/" o "" redundantes y los unifica a "/".
Devuelve el path del directorio en curso, por defecto donde se ejecuta vClient.
Parámetros:
- index: número ordinal correspondiente al dispositivo de disco.
Devuelve el número de dispositivos de disco del sistema.
Devuelve un array de cadenas con las sendas estándar del sistema para la localización que indicamos como parámetro.
Devuelve un array ya que puede haber más de una senda para un mismo path.
Parámetros:
Los valores posibles son:
Windows
========
DesktopPath "C:/Users/<USER>/Desktop"
DocumentsPath "C:/Users/<USER>/Documents"
FontsPath "C:/Windows/Fonts" (not writable)
ApplicationsPath "C:/Users/<USER>/AppData/Roaming/Microsoft/Windows/Start Menu/Programs"
MusicPath "C:/Users/<USER>/Music"
MoviesPath "C:/Users/<USER>/Videos"
PicturesPath "C:/Users/<USER>/Pictures"
TempPath "C:/Users/<USER>AppData/Local/Temp"
HomePath "C:/Users/"
DataPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/", "", "/data"
CachePath "C:/Users/<USER>/AppData/Local/<USER>/cache"
GenericDataPath "C:/Users/<USER>/AppData/Local", "C:/ProgramData", "", "/data"
RuntimePath "C:/Users/"
ConfigPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/"
GenericConfigPath "C:/Users/<USER>/AppData/Local", "C:/ProgramData"
DownloadPath "C:/Users/<USER>/Documents"
GenericCachePath "C:/Users/<USER>/AppData/Local/cache"
AppDataPath "C:/Users/<USER>/AppData/Roaming/", "C:/ProgramData/", "", "/data"
AppLocalDataPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/", "", "/data"
AppConfigPath "C:/Users/<USER>/AppData/Local/", "C:/ProgramData/"
OS X
========
DesktopPath "~/Desktop"
DocumentsPath "~/Documents"
FontsPath "/System/Library/Fonts" (not writable)
ApplicationsPath "/Applications" (not writable)
MusicPath "~/Music"
MoviesPath "~/Movies"
PicturesPath "~/Pictures"
TempPath Generado aleatoriamente por el sistema operativo
HomePath "~"
DataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
CachePath "~/Library/Caches/", "/Library/Caches/"
GenericDataPath "~/Library/Application Support", "/Library/Application Support"
RuntimePath "~/Library/Application Support"
ConfigPath "~/Library/Preferences"
GenericConfigPath "~/Library/Preferences"
DownloadPath "~/Downloads"
GenericCachePath "~/Library/Caches", "/Library/Caches"
AppDataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
AppLocalDataPath "~/Library/Application Support/", "/Library/Application Support/". "/../Resources"
AppConfigPath "~/Library/Preferences/"
Linux
========
DesktopPath "~/Desktop"
DocumentsPath "~/Documents"
FontsPath "~/.fonts"
ApplicationsPath "~/.local/share/applications", "/usr/local/share/applications", "/usr/share/applications"
MusicPath "~/Music"
MoviesPath "~/Videos"
PicturesPath "~/Pictures"
TempPath "/tmp"
HomePath "~"
DataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
CachePath "~/.cache/"
GenericDataPath "~/.local/share", "/usr/local/share", "/usr/share"
RuntimePath "/run/user/"
ConfigPath "~/.config", "/etc/xdg"
GenericConfigPath "~/.config", "/etc/xdg"
DownloadPath "~/Downloads"
GenericCachePath "~/.cache"
AppDataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
AppLocalDataPath "~/.local/share/", "/usr/local/share/", "/usr/share/"
AppConfigPath "~/.config/", "/etc/xdg/"
Android
========
DesktopPath "/files"
DocumentsPath "/Documents", "/<USER>/Documents"
FontsPath "/system/fonts" (no se puede escribir)
ApplicationsPath No soportado (el directorio no se puede leer)
MusicPath "/Music", "/<USER>/Music"
MoviesPath "/Movies", "/<USER>/Movies"
PicturesPath "/Pictures", "/<USER>/Pictures"
TempPath "/cache"
HomePath "/files"
DataPath "/files", "/<USER>/files"
CachePath "/cache", "/<USER>/cache"
GenericDataPath ""
RuntimePath "/cache"
ConfigPath "/files/settings"
GenericConfigPath "/files/settings" (no hay settings compartidos)
DownloadPath "/Downloads", "/<USER>/Downloads"
GenericCachePath "/cache" (no hay cache compartida)
AppDataPath "/files", "/<USER>/files"
AppConfigPath "/files/settings"
AppLocalDataPath "/files", "/<USER>/files"
iOS
========
DesktopPath "/Documents/Desktop"
DocumentsPath "/Documents"
FontsPath "/Library/Fonts"
ApplicationsPath No soportado
MusicPath "/Documents/Music"
MoviesPath "/Documents/Movies"
PicturesPath "/Documents/Pictures", "assets-library://"
TempPath "/tmp"
HomePath "" (not writable)
DataPath "/Library/Application Support"
CachePath "/Library/Caches"
GenericDataPath "/Documents"
RuntimePath No soportado
ConfigPath "/Library/Preferences"
GenericConfigPath "/Library/Preferences"
DownloadPath "/Documents/Downloads"
GenericCachePath "/Library/Caches"
AppDataPath "/Library/Application Support"
AppConfigPath "/Library/Preferences/"
AppLocalDataPath "/Library/Application Support"
Devuelve el path del directorio home, por defecto el del usuario.
Carga los dispositivos de disco del sistema. Devuelve true si finaliza correctamente.
Devuelve el path del directorio raíz, por ejemplo "C:/".
Cambia el path en curso. Devuelve true si el cambio finaliza correctamente.
Parámetros:
- path: nueva senda.
Devuelve el path de del directorio temporal.
Copia un fichero. Devuelve true si la copia finaliza correctamente.
Parámetros:
- szFileName: senda de origen del fichero con el nombre antiguo.
- szNewName: senda de destino del fichero con el nuevo nombre.
Devuelve true si el fichero existe y está legible.
Parámetros:
- szFileName: senda del fichero.
Crea un enlace simbólico, acceso directo o shortcut, a un fichero o directorio.
Parámetros:
- szFileName: senda del fichero.
- szLinkName: nombre del acceso directo o shorcut.
Elimina un fichero del disco. Devuelve true si finaliza correctamente.
Parámetros:
- szFileName: senda del fichero.
Renombra un fichero del disco. Devuelve true si finaliza correctamente.
Parámetros:
- szFileName: senda del fichero a renombrar.
- szNewName: senda del fichero con el nuevo nombre.
Devuelve el código ISO (3166) del país en curso.
Devuelve el nombre del país en curso, en inglés.