Getting to scope variables in client side javascript (CSJS) on XPages

Question

I am setting a viewScope variable in a server side javascript (SSJS) button.

viewScope.put("branchName",doc.getItemValueString("BranchName"))

How can I access that variable on the client side?

score 14 · Accepted Answer · answered Mar 05 '12 at 15:12

If you need to access the viewScope variable from a client side script you can use the xp:scriptBlock tag to setup a number of global javascript variables.

<xp:scriptBlock id="scriptBlock1">
<xp:this.value><![CDATA[var myVar = #{javascript:viewScope.get("scopeVar")}]]></xp:this.value>
</xp:scriptBlock>

The main problem with this method is that the inner server side javascript is only computed when that element is initially rendered or when a partial refresh is performed on the element so there is no guarantee that the client side JS variable is set to the correct value.

score 8 · Answer 2 · answered Mar 05 '12 at 14:54

8

You can't access viewScope Variables directly, but you could bind it to a hidden field then access that value via csjs XSP.getElementById("#{id:inputHidden1}").value

There are other ways to access it also, using something like rpc or an ajax request.

answered Mar 05 '12 at 14:54

Toby Samples

2,168
14
15

By hidden that would be in CSS side and not in the XPage end. Otherwise it won't render out to the client. – Simon O'Doherty Mar 05 '12 at 15:16
1

Well it hides it via the hidden type of input tag in html so it renders like so. – Toby Samples Mar 05 '12 at 15:34

score 6 · Answer 3 · answered Mar 28 '12 at 10:19

6

use the below code:

var value = "#{javascript:viewScope.variablename}"

answered Mar 28 '12 at 10:19

NotesArt

383
9
20

score 5 · Answer 4 · answered Mar 07 '12 at 03:17

I would take a look at the JSON RPC included with the extension library. This component will allow you to define a SSJS function that may/may not accept arguments. Let's say you add the RPC with an ID of myRPC and a method called getViewScopeVar that accepts a single String argument and returns the value of the viewScope variable with the name that you include as the argument. You can then call that method like:

myRPC.getViewScopeVar("branchName")

This is the easiest most effective way to interact with server side elements from client side javascript. Plus it gives you the option of all the required methods being in one place as long as you place that RPC on a strategic custom control (i.e. like a layout custom control that every xpage is based off of).

score 0 · Answer 5 · answered Mar 06 '12 at 14:58

0

If you need frequent updates you can use the Ajax service from the extension library.

answered Mar 06 '12 at 14:58

stwissel

20,110
6
54
101

Getting to scope variables in client side javascript (CSJS) on XPages

5 Answers5

Linked