GetUserString Method (s)

Pageflex Document Action API

previous page next page
Pageflex Document Action API GetUserString Method (s)
Namespaces > Pageflex.Scripting > Application > GetUserString(String)
Gets the value of a user string defined in the current online editing session.
Syntax
C# Visual Basic Managed C++ 
public static string GetUserString (
	string s
)
Public Shared Function GetUserString ( _
	s As String _
) As String
public:
static String^ GetUserString (
	String^ s
)
Parameters
s (String)
The name of the user string to get the value of. Do not prefix this name with the ^ character.
Return Value
A String representing the value assigned to the user string name in the current online editing session.
Remarks
When using the Java online editing client, this method can only retrieve user strings set with the setString configuration action. If you want to retrieve a user string defined as a parameter in the HTML applet element, your online editing configuration file must first use setString to "re-set" the value. For example, if the user string is called "MyUserString" the online editing configuration file should contain this action: 
1<actionStep action="setString" param1="^MyUserString" param2="{^MyUserString}" />
Exceptions
Exception Condition
WrongApplicationContextException The current Context is not an online editing session.
UserStringNotFoundException No user string named name is defined in the current online editing session.
ArgumentNullException The value supplied for s was nullNothingnullptr.

Assembly: PFScript Version: 8.0.7.1407 (Module: PFScript)

previous page start next page