_XDocument2.SetDataVariable(Int32, String) Method

Definition

Sets the value of a predefined variable stored as a processing instruction attribute in the form's underlying XML document.

public:
 void SetDataVariable(int lVariableNumber, System::String ^ bstrVariableValue);
public void SetDataVariable (int lVariableNumber, string bstrVariableValue);
abstract member SetDataVariable : int * string -> unit
Public Sub SetDataVariable (lVariableNumber As Integer, bstrVariableValue As String)

Parameters

lVariableNumber
Int32

The number of the variable.

bstrVariableValue
String

The value of the variable.

Implements

Examples

In the following example, the SetDataVariable method of the XDocument object is used to set the value of the first variable:

thisXDocument.<span class="label">SetDataVariable</span>(1, "View 2");

Remarks

If the variable being set is not a valid processing instruction attribute, the SetDataVariable method will return an error.

To get the value of a variable, use the GetDataVariable(Int32) method.

Note: only supports using the initialView variable, which is the variable used to specify the initial view displayed when a form is opened. The number of this variable is always 1, and its value must be the name of a view within the form.

Important: This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.

Applies to