TriggerPBEvent PowerScript function

Description

Triggers the specified user event in the child window contained
in a PowerBuilder window ActiveX control.

Controls

Window ActiveX controls

Syntax

<span>activexcontrol</span>.<span>TriggerPBEvent</span> ( <span>name</span> {, <span>numarguments </span>{, <span>arguments</span> } } )

1	<span>activexcontrol</span>.<span>TriggerPBEvent</span> ( <span>name</span> {, <span>numarguments </span>{, <span>arguments</span> } } )

Argument	Description
activexcontrol	Identifier for the instance of the PowerBuilder window ActiveX control. When used in HTML, this is the NAME attribute of the object element. When used in other environments, this references the control that contains the PowerBuilder window ActiveX.
name	String specifying the name of the user event. This argument is passed by reference.
numarguments (optional)	Integer specifying the number of elements in the arguments array. The default is zero.
arguments (optional)	Variant array containing event arguments. In PowerBuilder, Variant maps to the Any datatype. This argument is passed by reference. If you specify this argument, you must also specify numarguments. If you do not specify this argument and the function contains arguments, populate the argument list by calling the SetArgElement function once for each argument. JavaScript cannot use this argument.

Return Values

Integer. Returns 1 if the function succeeds
and -1 if an error occurs.

Usage

Call this function to trigger a user event in the child window
contained in a PowerBuilder window ActiveX control.

To check the PowerBuilder function’s return value,
call the GetLastReturn function.

JavaScript cannot use the arguments argument.

Examples

This JavaScript example calls the TriggerPBEvent function:

function triggerEvent(f) {

1	function triggerEvent(f) {

      var retcd;

1	var retcd;

      var rc;

var rc;

      var numargs;

1	var numargs;

      var theEvent;

1	var theEvent;

      var theArg;

1	var theArg;

      retcd = 0;

1	retcd = 0;

      numargs = 1;

1	numargs = 1;

      theArg = f.textToPB.value;

1	theArg = f.textToPB.value;

      PBRX1.SetArgElement(1, theArg);

1	PBRX1.SetArgElement(1, theArg);

      theEvent = "ue_args";

1	theEvent = "ue_args";

      retcd = PBRX1.<span>TriggerPBEvent</span>(theEvent, numargs);

1	retcd = PBRX1.<span>TriggerPBEvent</span>(theEvent, numargs);

      rc = parseInt(PBRX1.GetLastReturn());

1	rc = parseInt(PBRX1.GetLastReturn());

      if (rc != 1) {

1	if (rc != 1) {

      alert("Error. Empty string.");

1	alert("Error. Empty string.");

}

}

      PBRX1.ResetArgElements();

1	PBRX1.ResetArgElements();

}

}

This VBScript example calls the TriggerPBEvent function:

Sub TrigEvent_OnClick()

1	Sub TrigEvent_OnClick()

      Dim retcd

Dim retcd

      Dim myForm

1	Dim myForm

      Dim args(1)

1	Dim args(1)

      Dim rc

Dim rc

      Dim numargs

1	Dim numargs

      Dim theEvent

1	Dim theEvent

      retcd = 0

retcd = 0

      numargs = 1

1	numargs = 1

      rc = 0

rc = 0

      theEvent = "ue_args"

1	theEvent = "ue_args"

      Set myForm = Document.buttonForm

1	Set myForm = Document.buttonForm

      args(0) = buttonForm.textToPB.value

1	args(0) = buttonForm.textToPB.value

      retcd = PBRX1.<span>TriggerPBEvent</span>(theEvent, &amp; <br>      numargs, args)

1	retcd = PBRX1.<span>TriggerPBEvent</span>(theEvent, & <br> numargs, args)

      rc = PBRX1.GetLastReturn()

1	rc = PBRX1.GetLastReturn()

      if rc &lt;&gt; 1 then

1	if rc <> 1 then

      msgbox "Error. Empty string."

1	msgbox "Error. Empty string."

      end if

end if

end sub

end sub

Connection Information

TriggerPBEvent – PB Docs 125