Declaración use

Esta sección describe la declaración de uso, seguida de los detalles sobre cómo escribir la declaración:

Información general

La declaración use le permite hacer referencia fácilmente a áreas de datos y funciones en componentes que se generan por separado. Un programa, por ejemplo, puede emitir una declaración use que permita una referencia fácil a una tabla de datos, biblioteca o grupo de formularios, pero solamente si esos componentes son visibles para el componente de programa. Para conocer detalles sobre la visibilidad, consulte Referencias a componentes.

En la mayoría de casos, puede hacer referencia a áreas de datos y funciones de otro componente independientemente de si hay una declaración use en vigor. Por ejemplo, si está escribiendo un programa y no tiene una declaración use para un componente de biblioteca denominado myLib, puede acceder a la variable de biblioteca denominada myVar como se indica a continuación:
  myLib.myVar
Si incluye el nombre de biblioteca en una declaración use, no obstante, puede hacer referencia a la variable como se indica a continuación:
  myVar

La forma abreviada anterior de la referencia solamente es válida si el símbolo myVar es exclusivo para cada variable y elemento de estructura que sea global para el programa. (Si el símbolo no es exclusivo, se producirá un error.) Además, el símbolo myVar hace referencia a un elemento de la biblioteca solamente si una variable o parámetro locales no tiene el mismo nombre. (Un área de datos local tiene preferencia sobre un área de datos global del programa con el mismo nombre.)

Una declaración use es necesaria en estas situaciones:
  • Un programa o biblioteca que utilice alguno de los formularios de un componente formGroup dado debe tener una declaración use para ese componente FormGroup
  • Un componente FormGroup debe tener una declaración use para un formulario que sea necesario para el programa o biblioteca pero que no está incluido en el componente FormGroup
  • Si ha declarado una función en el nivel superior de un archivo fuente EGL en lugar de físicamente dentro de un contenedor (un programa, un PageHandler o una biblioteca), esa función puede invocar funciones de biblioteca sólo si se da la situación siguiente:
    • El contenedor incluye una sentencia use que hace referencia a la biblioteca
    • En la función invocante, la propiedad containerContextDependent se establece en yes

Cada nombre especificado en la declaración use puede estar calificado por un nombre de paquete, un nombre de biblioteca o ambos.

En un componente de biblioteca o programa

Cada declaración use de un programa o biblioteca debe ser externa a cualquier función. La sintaxis para la declaración es la siguiente:


Diagrama de sintaxis para una declaración use en un componente de biblioteca o programa
nombreComponenteTablaDatos
El nombre de un componente dataTable que es visible al programa o biblioteca.

No es necesaria una referencia en una declaración use para un componente dataTable al que se hace referencia en la propiedad del programa msgTablePrefix.

No puede alterar temporalmente las propiedades de un componente dataTable en la declaración use.

Para obtener una visión general de los componentes dataTable, consulte Componente DataTable.

nombreComponenteBiblioteca
El nombre de un componente de biblioteca que es visible al programa o biblioteca.

No puede alterar temporalmente las propiedades de un componente de biblioteca en la declaración use.

Para obtener una visión general de componentes, consulte las secciones Componente de biblioteca de tipo basicLibrary y Componente de biblioteca de tipo nativeLibrary.

nombreComponenteGrupoFormularios
El nombre de un componente FormGroup que es visible al programa o biblioteca. Para obtener una visión general de los grupos de formularios, consulte Componente FormGroup.

Un programa que utilice alguno de los formularios de un componente FormGroup dado debe tener una declaración use para ese componente FormGroup.

No se producen alteraciones temporales para las propiedades de nivel de formulario. Si se especifica una propiedad como validationBypassKeys en un formulario, por ejemplo, el valor que haya en el formulario estará en vigor durante la ejecución. Si, no obstante, no se especifica una propiedad de nivel de formulario en el formulario, la situación será la siguiente:
  • El entorno de ejecución de EGL utiliza el valor de la declaración de uso del programa
  • Si no se ha especificado un valor en la declaración de uso del programa, el entorno de ejecución de EGL utiliza el valor (si hay alguno) del grupo de formularios

Las propiedades siguientes le permiten cambiar comportamientos cuando un programa específico accede a un grupo de formularios.

helpGroup = no, helpGroup = yes
Especifica si debe utilizarse el componente FormGroup como un grupo de ayuda. El valor por omisión es no.
validationBypassKeys = [valorTeclaSalto]
Identifica una pulsación del usuario que provoca que el entorno de ejecución de EGL se salte las validaciones de campos de entrada. Esta propiedad es de utilidad para reservar una pulsación que finalice el programa rápidamente. Cada opción de valorTeclaSalto es como se indica a continuación:
pfn
El nombre de una tecla F o PF, incluido un número entre 1 y 24.
Nota: Las teclas de función de un teclado de PC suelen ser teclas f tales como f1, pero EGL utiliza la terminología de IBM pf de forma que, por ejemplo, f1 se denomina pf1.

Si especifica varias claves, separe una de la siguiente mediante una coma.

helpKey = "valorTeclaAyuda"
Identifica una pulsación de tecla del usuario que provoca que el entorno de ejecución EGL presente un formulario de ayuda al usuario. La opción valorTeclaAyuda es como se indica a continuación:
pfn
El nombre de una tecla F o PF, incluido un número entre 1 y 24.
Nota: Las teclas de función de un teclado de PC suelen ser teclas f tales como f1, pero EGL utiliza la terminología de IBM pf de forma que, por ejemplo, f1 se denomina pf1.
pfKeyEquate = yes, pfKeyEquate = no
Especifica si la pulsación que se registra cuando el usuario pulsa una tecla de función con un número alto (de PF13 a PF24) es la misma que la pulsación registrada cuando el usuario pulsa una tecla de función inferior a 12. El valor por omisión es yes. Encontrará los detalles en pfKeyEquate.

En un componente FormGroup

En un componente FormGroup, una declaración use hace referencia a un formulario especificado fuera del grupo de formularios. Esta clase de declaración permite que múltiples grupos de formularios compartan el mismo formulario.

La sintaxis para una declaración use en un componente FormGroup es la siguiente:


Diagrama de sintaxis para una declaración use en un componente FormGroup
nombreComponenteFormulario
El nombre de un componente de formulario que es visible al grupo de formularios. Para obtener una visión general de los formularios, consulte Componente Formulario.

No puede alterar temporalmente las propiedades de un componente de formulario en la declaración use de un componente FormGroup.

En un componente pageHandler

Cada declaración use de un componente pageHandler debe ser externa a cualquier función. La sintaxis para la declaración es la siguiente:


Diagrama de sintaxis para una declaración use en un componente pageHandler
nombreComponenteTablaDatos
El nombre de un componente dataTable que es visible al componente pageHandler.

No puede alterar temporalmente las propiedades de un componente dataTable en la declaración use.

Para obtener una visión general de los componentes dataTable, consulte Componente DataTable.

nombreComponenteBiblioteca
El nombre de un componente de biblioteca que es visible al componente pageHandler.

No puede alterar temporalmente las propiedades de un componente de biblioteca en la declaración use.

Para obtener una visión general de los componentes de biblioteca, consulte Componente biblioteca.

Consulta relacionada
pfKeyEquate

Comentarios
(C) Copyright IBM Corporation 2000, 2005. Reservados todos los derechos.