Web Add-in Extensibility Developer Guide > UFT Test Object Schema > Elements > Argument Element

Argument Element

Description

The argument definitions for the operation.

Attributes

Name Type Use Default Description
DefaultValue string optional   The default value for this argument.
Direction string optional In Specifies whether this argument is an input argument or an output argument.

Possible values:

In - Input argument

Out - Output argument

InOut - Input and output argument

DynamicListOfValues boolean optional false Indicates whether a dynamic list of possible values is displayed for this argument in the Editor when using the statement completion feature. This attribute is currently relevant only for Web Add-in Extensibility.

If this attribute is set to true, an extensibility method must be implemented to return the possible values from the supported object. In addition, the application being tested must be open to the relevant object when the test is edited, for the list of values to be displayed. 

Note: The type of the argument, specified in the VariantType attribute of the Argument\Type element, must match the type of the possible values.

IsMandatory boolean required   Specifies whether the argument is mandatory.

Note: If you define optional arguments, they must come after all of the operation's mandatory arguments.

Possible values:

True - Mandatory

False - Optional

Name RestrictedString required   The argument name.

For naming rules, see the RestrictedString simple type.

Diagram

Argument Element (Required, 1 element allowed) Sequence (Required, 1 element allowed) Type Element (Required, 1 element allowed)
AdditionalInfo Element (Optional, up to 1 element(s) allowed)


Children

Used By

Source

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="Argument">
    <xs:annotation>
        <xs:documentation>The argument definitions for the operation.</xs:documentation>
    </xs:annotation>
    <xs:complexType>
        <xs:sequence>
            <xs:element ref="Type" />
            <xs:element ref="AdditionalInfo" minOccurs="0" />
        </xs:sequence>
        <xs:attribute name="Name" type="RestrictedString" use="required">
            <xs:annotation>
                <xs:documentation>The argument name.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="IsMandatory" type="xs:boolean" use="required">
            <xs:annotation>
                <xs:documentation>Specifies whether the argument is mandatory.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="DynamicListOfValues" type="xs:boolean" use="optional" default="false">
            <xs:annotation>
                <xs:documentation>Specifies whether a dynamic list of possible values for this argument is displayed in UFT when the test is created or edited.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="DefaultValue" type="xs:string" use="optional">
            <xs:annotation>
                <xs:documentation>The default value for this argument.</xs:documentation>
            </xs:annotation>
        </xs:attribute>
        <xs:attribute name="Direction" default="In">
            <xs:annotation>
                <xs:documentation>Specifies whether this argument is an input argument or an output argument.</xs:documentation>
            </xs:annotation>
            <xs:simpleType>
                <xs:restriction base="xs:string">
                    <xs:enumeration value="In" />
                    <xs:enumeration value="Out" />
                    <xs:enumeration value="InOut" />
                </xs:restriction>
            </xs:simpleType>
        </xs:attribute>
    </xs:complexType>
</xs:element>