The NJX:XCIWPACCESS2 control is used to open, activate and close content pages in the workplace, to open pages as pop-up windows, or to open pages in a frame.
This control provides a functional API to the workplace. It does not have design time properties nor does it raise events.
The following topics are covered below:
The XML code for the example looks as follows:
<natpage xmlns:njx="http://www.softwareag.com/njx/njxMapConverter"> <njx:xciwpaccess2> </njx:xciwpaccess2> </natpage>
1 XCIWPACCESS2 (1:*) 2 CMDADDPAGETOWORKPLACE 3 ADD_ACTIVITYID (U) DYNAMIC 3 ADD_ACTIVITYURL (U) DYNAMIC 3 ADD_NAME (U) DYNAMIC 3 ADD_TEXTID (U) DYNAMIC 3 ADD_TYPE (U) DYNAMIC 2 CMDCLOSECONTENTPAGE (U) DYNAMIC 2 CMDINVOKEMETHODINCONTENTPAGE 3 METHOD (U) DYNAMIC 2 CMDOPENPAGEINTARGET 3 OPEN_ACTIVITYURL (U) DYNAMIC 3 OPEN_TARGET (U) DYNAMIC 3 OPEN_TYPE (U) DYNAMIC 2 CMDOPENPOPUP 3 POPUP_ACTIVITYURL (U) DYNAMIC 3 POPUP_HEIGHT (I4) 3 POPUP_LEFT (I4) 3 POPUP_TITLE (U) DYNAMIC 3 POPUP_TITLEID (U) DYNAMIC 3 POPUP_TOP (I4) 3 POPUP_TYPE (U) DYNAMIC 3 POPUP_WIDTH (I4) 2 CMDSHOWPAGEINWORKPLACE 3 SHOW_ACTIVITYID (U) DYNAMIC 3 SHOW_ACTIVITYURL (U) DYNAMIC 3 SHOW_NAME (U) DYNAMIC 3 SHOW_TEXTID (U) DYNAMIC 3 SHOW_TYPE (U) DYNAMIC
Each occurrence in the array XCIWPACCESS2
describes a
command that is to be sent to the workplace API. Several commands can be sent
in a sequence. For each command, a corresponding substructure must be
filled.
- Open a page in the "Content" frame
The following structure elements belong to
CMDADDPAGETOWORKPLACE
:
Element Meaning ADD_ACTIVITYURL
The URL to be loaded. ADD_ACTIVITYID
Use this element if you want to start different pages with the same name. ADD_NAME
The name to be displayed in the "Active Functions" frame. ADD_TEXTID
Multi language dependent text that is displayed inside the control. The ADD_TEXTID
is translated into a corresponding string at runtime.ADD_TYPE
"cis": Open an Application Designer page.
"html": Open an HTML page.
- Open a page in a pop-up window
The following structure elements belong to
CMDOPENPOPUP
:
Element Meaning POPUP_ACTIVITYURL
The URL to be loaded. You can append parameters to the URL. POPUP_TITLE
Title of the pop-up window. POPUP_TITLEID
Multi language dependent text that is displayed inside the control. The POPUP_TITLEID
is translated into a corresponding string at runtime.POPUP_TYPE
"cis": Open an Application Designer page.
"html": Open an HTML page.
POPUP_LEFT
Set the relative position of the pop-up in pixels. POPUP_TOP
Set the relative position of the pop-up in pixels. POPUP_WIDTH
Set the dimension of the pop-up in pixels. POPUP_HEIGHT
Set the dimension of the pop-up in pixels. - Open a page in a target frame other than the "Content" frame
The following structure elements belong to
CMDOPENPAGEINTARGET
:
Element Meaning OPEN_ACTIVITYURL
The URL to be loaded. You can append parameters to the URL. OPEN_TARGET
Name of the target frame in which the page is to be opened. During workplace definition, you assign a target ID to each frame you define. OPEN_TYPE
"cis": Open an Application Designer page.
"html": Open an HTML page.
- Activate an already open page in the "Content" frame
The following structure elements belong to
CMDSHOWPAGEINWORKPLACE
:
Element Meaning SHOW_ACTIVITYURL
The URL to be loaded. You can append parameters to the URL. SHOW_ACTIVITYID
Use this element if you want to start different pages with the same name. SHOW_NAME
Name of the page in the "Active Functions" frame. SHOW_TEXTID
Multi language dependent text that is displayed inside the control. The SHOW_TEXTID
is translated into a corresponding string at runtime.SHOW_TYPE
"cis": Activate an Application Designer page.
"html": Activate an HTML page.
- Close the currently active page in the "Content" frame
Assign the value "closeit" to
CMDCLOSECONTENTPAGE
.- Close all pages in the "Content" frame
Assign the value "all" to
CMDCLOSECONTENTPAGE
.Or assign the value "allpopup" to
CMDCLOSECONTENTPAGE
. In this case, a yes/no pop-up will appear, asking whether you really want to close all content pages.- Invoke a method (raise an event) in the currently active page in the "Content" frame
The following structure element belongs to
CMDINVOKEMETHODINCONTENTPAGE
:
Element Meaning METHOD
Name of the method/event.