Panel Browser ActiveX Reference

<< Click to Display Table of Contents >>

Manual > Monitoring system construction guide > System installation and operation > System configuration and operation (runtime execution) > Client runtime execution > Other client execution methods > Incorporate Panel Browser into VB and execute > Function explanation >

Panel Browser ActiveX Reference

Panel Browser ActiveX Reference

Panel Browser ActiveX provides the following interfaces:

 

ActiveX Methods

 

Method name

explanation

OpenFile

Opens the Panel Browser client configuration file (xml file).

CallPanelMethod

Calls a user-defined function defined in Panel Browser.

 

 

 

 

ActiveX Events

 

Event name

explanation

PanelEvent

This is an event that Panel Browser uses to notify external applications such as VB. If you call the FirePanelEvent method on the root of Panel Browser from within a script, this event will occur on the VB side.

 

 

 

 

 

 

OpenFile Method
 

Opens the Panel Browser client configuration file (xml file).

syntax

OpenFile(

         FileName

         )

 

Parameters

 

FileName

 

Type:

character

 

File name

 

Return Value

 

 

Type:

Boolean

 

FALSE - Failure. TRUE - Success.

 

hmtoggle_plus1Example

To open an xml file from within a VB program, do the following. After loading an xml file, you can also open a different xml file.

 

VB.NET

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
AxFAPanelBrowser1.OpenFile("C:\work\sample01.xml")
End Sub

 

 

hint

The xml file to be opened can also be specified using a relative path.

 

example)

OpenFile("..\sample01.xml")

 

 

 

 

 

CallPanelMethod Method
 

Calls a user-defined function defined in Panel Browser. You can specify as many parameters as you need (up to 10).

syntax

CallPanelMethod(

         Name,

         [, p1, p2, p3, p4, p5, p6, p7, p8, p9, p10]

         )

 

Parameters

 

Name

 

Type:

character

 

User-defined function name

 

p1 ~ p10

 

Type:

character

 

User-defined function parameters 1 to 10

 

Return Value

 

 

Type:

User-defined function return types

 

Return value of user-defined function

 

hmtoggle_plus1Example

Let's try using CallPanelMethod to access global variables in Panel Browser.

 

Panel Browser

//Browser side////////////////////////////////////////////////////////////
//Define the following functions in the root object
var a, b;
function SetVariable(name, value)
{
switch(name)
{
case "a":
a = value;
break;
case "b":
b = value;
break;
}
}

function GetVariable(name)
{
switch(name)
{
case "a":
return a;
case "b":
return b; 
}
}

 
VB.NET

'Set Variable'
Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
    AxFAPanelBrowser.CallPanelMethod("::SetVariable", "a", TextBox1.Text, "", "", "", "", "", "", "", "")
End Sub

'Get Variable'
Private Sub Button2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button2.Click
    TextBox2.Text = CStr(AxFAPanelBrowser.CallPanelMethod("::GetVariable", "a", "", "", "", "", "", "", "", "", ""))
End Sub

 

 

hint

The xml file to be opened can also be specified using a relative path.

 

example)

OpenFile("..\sample01.xml")

 

 

 

 

 

PanelEvent Event
 

This is an event that Panel Browser uses to notify external applications such as VB. When you call the FirePanelEvent method of the Panel Browser root from within a script, this PanelEvent event occurs.

syntax

XXX_PanelEvent(

         ByVal sender As System.Object,

         ByVal e As [Library name].[Event handler name]

         )

 

* "xxx" is the object name of the ActiveX control.

Parameters

 

e.eventName

 

Type:

character

 

Event name

 

e.p1

 

Type:

character

 

Parameter 1

 

e.p2

 

Type:

character

 

Parameter 2

 

 

hmtoggle_plus1Example

When a button in Panel Browser is pressed, the button is notified to VB as a PanelEvent event. The text string of the pressed Button control itself is passed to VB as a parameter of that event.

On the VB side, the PanelEvent is detected and the string received as a parameter is displayed in the edit control.
 
ope_0060

 

Panel Browser

event OnMouseUp(button)
{
    ::FirePanelEvent(this.Text, 0, 0);
}

 
VB.NET

Private Sub AxFAPanelBrowser1_PanelEvent(ByVal sender As System.Object,_
                                         ByVal e As AxFAPANELBROWSERACTIVEXLib6._DFAPanelBrowserEvents_PanelEventEvent) _
    Handles AxFAPanelBrowser1.PanelEvent
    PanelEventText.Text = e.eventName
End Sub

 

 

attention

Calling CallPanelMethod from within a PanelEvent event is not supported. If you do so, an application error will occur.