Histórico da Página

Sintaxis

AxInclui( <cAlias>, <nReg>, <nOpc>, <aAcho>, <cFunc>, <aCpos>, <cTudoOk>, <lF3>, <cTransact>, <aButtons>, <aParam>, <aAuto>, <lVirtual>, <lMaximized>)

Propósito

Permite que el usuario incluya las informaciones de un archivo de datos por medio de una interfaz, de acuerdo con la necesidad de la aplicación.

Argumentos

< cAlias >

Archivo de datos en el que se incluirán las informaciones. Este archivo está registrado en el diccionario de tablas del Protheus (SX2).

< nReg >

Número del registro (recno) posicionado en el alias activo.

< nOpc >

Número de la línea del array aRotina que define el tipo de edición (Inclusión, Modificación, Borrado y Visualización). La función AxInclui() se ejecutará cuando el usuario seleccione la opción Incluir.

< aAcho >

Array con el nombre de los campos que se mostrarán en la interfaz (pantalla). Los campos específicos de usuario siempre se mostrarán si no existe en el parámetro un elemento con la expresión “NOUSER”.

< cFunc >

Función que cargará las variables que serán utilizadas por el objeto Enchoice. En este caso, el parámetro lVirtual está definido internamente por la función AxFunction() y ejecutado como verdadero (.T.).

< aCpos >

Array con el nombre de los campos que se podrán editar.

< cTudoOk >

Función de validación de las informaciones confirmadas por el usuario, las mismas que quedarán grabadas. No se debe pasar como bloque de código, pero sí se puede pasar como una lista de expresiones, siempre y cuando la última acción devuelva un valor lógico. Ejemplo:

“( Func1(), Func2(), ..., FuncX(), .T. )”

< lF3 >

Indica si la interfaz se está creando en una consulta F3 para utilizar variables de memoria.

< cTransact >

Función que se ejecutará dentro de la transacción de la AxFunction().

< aButtons >

Botones adicionales que se incluirán en la barra de herramientas estándar (EnchoiceBar). Las informaciones de cada botón se deben pasar en el siguiente formato:

aArray[n][1]  à  Imagen del botón.

aArray[n][2]  à  Bloque de código que contiene la acción que el botón ejecutará.

aArray[n][3]  à  Título del botón.

< aParam >

Funciones que se ejecutarán en puntos de la AxFunction() definidos previamente, según la siguiente descripción:

aParam[1]  à  Bloque de código que se procesará antes de mostrar las informaciones en la pantalla.

aParam[2]  à  Bloque de código para procesar durante la validación de la confirmación de las informaciones

aParam[3]  à  Bloque de código que se ejecutará dentro de la transacción de la AxFunction()

aParam[4]  à  Bloque de código que se ejecutará fuera de la transacción de la AxFunction()

< aAuto >

Indica que la inclusión se realizará de forma automática por medio de la propia función, sin la necesidad de mostrar la pantalla de interfaz y con base en los datos enviados en este parámetro.

Este array se monta en el formato utilizado por la función estándar MsExecAuto(). Si se informa este array, la pantalla de interfaz no se mostrará y se ejecutará la función EnchAuto().

El array se debe montar en el siguiente formato:

aAuto[n][1]  à  Nombre del campo

aAuto[n][2]  à  Contenido del campo

aAuto[n][3]  à  Validación que se utilizará en sustitución a las validaciones definidas en el diccionario de datos SX3.

< lVirtual >

Indica si la interfaz utilizará variables de memoria o los campos del propio archivo de datos en la edición.

< lMaximized >

Indica si se maximizará la ventana o no.

Utilización

Este componente visual se utiliza con mucha frecuencia en la interfaz de las aplicaciones para que el usuario digite las informaciones.

Ejemplos

nOpcA := AxInclui( cAlias, nReg, 1,,"U_A110LeReg()",,,,,aButtons,,,.T.)