VP Run offscreen area

VP Run offscreen area ( parameters : Object) : Mixed

Parámetros	Tipo		Descripción
parameters	Object	->	Objeto que contiene los atributos del área fuera de pantalla
Result	Mixed	<-	propiedad .result del objeto .onEvent, o Null si no devuelve ningún valor

Descripción

El comando VP Run offscreen area crea un área fuera de pantalla en la memoria que puede ser utilizada para procesar comandos y funciones del área 4D View Pro.

En el objeto parameters, pase una de las siguientes propiedades opcionales. Estas propiedades estarán disponibles a través del comando This dentro del método onEvent y harán referencia a la instancia:

Propiedad	Tipo	Descripción
area	text	El nombre del área fuera de la pantalla. Si se omite o es null, se asigna un nombre genérico (por ejemplo, "OffscreenArea1").
onEvent	objet (fórmula)	Un método retro llamada que se lanzará cuando el área fuera de la pantalla esté lista. It can be either: an onEvent function of a class, or a Formula object By default, the callback method is called on the On VP Ready, On Load, On Unload, On End URL Loading, On URL Loading Error, On VP Range Changed, or On Timer events. The callback method can be used to access the 4D View Pro form object variable.
autoQuit	boolean	True (default value) if the command must stop the formula execution when the On End URL Loading or On URL Loading Error events occur. If false, you must use the CANCEL or ACCEPT commands in the onEvent callback method.
timeout	number	Tiempo máximo (expresado en segundos) antes de que el área se cierre automáticamente si no se genera ningún evento. Si se fija en 0, no se aplica ninguna limitación. Valor por defecto: 60
result	mixto	Resultado del procesamiento (si hay)
<customProperty>	mixto	Todo atributo personalizado que esté disponible en el método de retrollamada onEvent.

La siguiente propiedad es añadida automáticamente por el comando si es necesario:

Propiedad	Tipo	Descripción
timeoutReached	boolean	Añadido con el valor true si se ha excedido el tiempo de espera

El área fuera de pantalla solo está disponible durante la ejecución del comando VP Run offscreen area. Se destruirá automáticamente una vez finalizada la ejecución.

Los siguientes comandos se pueden utilizar en el método de retrollamada:

• ACCEPT
• CANCEL
• SET TIMER
• WA Evaluate JavaScript
• WA EXECUTE JAVASCRIPT FUNCTION

Ejemplo 1

Quiere crear un área 4D View Pro fuera de la pantalla y obtener el valor de una celda:

// cs.OffscreenArea class declaration 
Class constructor ($path : Text)
 This.filePath:=$path
 
// This function will be called on each event of the offscreen area 
Function onEvent()
 Case of
  :(FORM Event.code=On VP Ready)
      VP IMPORT DOCUMENT(This.area;This.filePath)
       This.result:=VP Get value(VP Cell(This.area;6;22))
 
       ALERT("The G23 cell contains the value: "+String(This.result))
 End case

El método de retrollamada OffscreenArea:

$o:=cs.OffscreenArea.new()
$result:=VP Run offscreen area($o)

Ejemplo 2

Quiere cargar un documento grande fuera de la pantalla, esperar a que todos los cálculos se completen y exportarlo como PDF:

//cs.OffscreenArea class declaration
Class constructor($pdfPath : Text)
 This.pdfPath:=$pdfPath
 This.autoQuit:=False
 This.isWaiting:=False
 
Function onEvent()
 Case of
     :(FORM Event.code=On VP Ready)
 // Document import
   VP IMPORT DOCUMENT(This.area;$largeDocument4VP)
         This.isWaiting:=True
 
 // Start a timer to verify if all calculations are finished.
 // If during this period the "On VP Range Changed" is thrown, the timer will be restarted
 // The time must be defined according to the computer configuration.
   SET TIMER(60)
 
  :(FORM Event.code=On VP Range Changed)
 // End of calculation detected. Restarts the timer
         If(This.isWaiting)
           SET TIMER(60)
         End if
 
  :(FORM Event.code=On Timer)
 // To be sure to not restart the timer if you call others 4D View command after this point
         This.isWaiting:=False
 


 // Stop the timer
   SET TIMER(0)
 
 // Start the PDF export
        VP EXPORT DOCUMENT(This.area;This.pdfPath;New object("formula";Formula(ACCEPT)))
 
     :(FORM Event.code=On URL Loading Error)

         CANCEL 
 End case

El método de retrollamada OffscreenArea:

$o:=cs.OffscreenArea.new()
 
$result:=VP Run offscreen area($o)

Ver también

Blog post: End of document loading