_XDocument2.SetDataVariable method (Int32, String)

  • Article

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

Namespace:  Microsoft.Office.Interop.InfoPath.SemiTrust
Assembly:  Microsoft.Office.Interop.InfoPath.SemiTrust (in Microsoft.Office.Interop.InfoPath.SemiTrust.dll)

Syntax

'Declaration
Sub SetDataVariable ( _
    lVariableNumber As Integer, _
    bstrVariableValue As String _
)
'Usage
Dim instance As _XDocument2
Dim lVariableNumber As Integer
Dim bstrVariableValue As String

instance.SetDataVariable(lVariableNumber, _
    bstrVariableValue)

void SetDataVariable(
    int lVariableNumber,
    string bstrVariableValue
)

Parameters

  • lVariableNumber
    Type: System.Int32

    The number of the variable.

  • bstrVariableValue
    Type: System.String

    The value of the variable.

Implements

_XDocument.SetDataVariable(Int32, String)

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 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.

Examples

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

thisXDocument.SetDataVariable(1, "View 2");

See also

Reference

_XDocument2 interface

_XDocument2 members

SetDataVariable overload

Microsoft.Office.Interop.InfoPath.SemiTrust namespace