Share via

3.1.4.1.2.2 GetFormResponse

  • Article

This structure contains the return value for the GetForm operation. This structure is defined as follows:

 <s:element name="GetFormResponse">

   <s:complexType>

     <s:sequence>

       <s:element name="GetFormResult" minOccurs="0">

         <s:complexType>

           <s:sequence>

             <s:element name="Form">

               <s:complexType>

                 <s:attribute name="Type" use="required">

                   <s:simpleType>

                     <s:restriction base="s:string">

                       <s:enumeration value="DisplayForm" />

                       <s:enumeration value="EditForm" />

                       <s:enumeration value="NewForm" />

                       <s:enumeration value="NewFormDialog" />

                       <s:enumeration value="SolutionForm" />

                     </s:restriction>

                   </s:simpleType>

                 </s:attribute>

                 <s:attribute name="Name"

                     type="s:string"/>

                 <s:attribute name="Url"

                     type="s:string" use="required"/>

                 <s:attribute name="Default">

                  <s:simpleType>

                    <s:restriction base="s:string">

                      <s:pattern value="[Tt][Rr][Uu][Ee]|[Ff][Aa][Ll][Ss][Ee]"/>

                    </s:restriction>

                  </s:simpleType>

                </s:attribute>

                 <s:attribute name="FormID"

                     type="s:string"/>

                 <s:attribute name="Template"

                     type="s:string"/>

                 <s:attribute name="WebPartZoneID"

                     type="s:string"/>

                 <s:attribute name="SetupPath"

                     type="s:string"/>

               </s:complexType>

             </s:element>

           </s:sequence>

         </s:complexType>

       </s:element>

     </s:sequence>

   </s:complexType>

 </s:element>

GetFormResult: A structure that holds the data returned from the WSDL operation.

Form: A complex type that holds the information of a form.

Type: A string indicating the general type of form as specified in [MS-WSSCAML] section 2.3.1.5.

Name: The unique identifier of the form.

Url: The server relative URL of the page hosting the form.

Default: A Boolean value as specified in [MS-WSSCAML] section 2.1.12. Specifies whether the form is the default form of the list. It is an optional attribute that appears only if previously set in the XML schema of the form definition.

FormId: A string that contains a non-negative integer. This SHOULD<2> be unique for each form in the back-end database server. It is an optional attribute that appears only if previously set in the XML schema of the form definition.

Template: The form template name. It is an optional attribute that appears only if previously set in the XML schema of the form definition.

WebPartZoneID: Identifier of the Web Part zone that contains the form. It is an optional attribute that appears only if previously set in the XML schema of the form definition.

SetupPath: Source path to the uncustomized document of the form. It is an optional attribute that appears only if previously set in the XML schema of the form definition.