Share via

3.1.4.10.2.2 GetCustomControlListResponse

  • Article

The GetCustomControlListResponse element MUST be returned by the server. This element is defined as follows:

 <s:element name="GetCustomControlListResponse" xmlns:s="http://www.w3.org/2001/XMLSchema">
    <s:complexType>
       <s:sequence>
          <s:element name="GetCustomControlListResult" minOccurs="1" maxOccurs="1">
             <s:complexType>
                <s:sequence>
                   <s:element name="ControlsList" minOccurs="1" maxOccurs="1">
                      <s:complexType>
                         <s:sequence>
                            <s:element name="Assembly" minOccurs="0" maxOccurs="unbounded">
                               <s:complexType>
                                  <s:sequence>
                                     <s:element name="Control" minOccurs="1" maxOccurs="unbounded">
                                        <s:complexType>
                                           <s:attribute name="Name" type="s:string" use="required"/>
                                           <s:attribute name="Title" type="s:string" use="required"/>
                                           <s:attribute name="Description" type="s:string" use="required"/>
                                           <s:attribute name="Template" type="s:string" use="required"/>
                                        </s:complexType>
                                     </s:element>
                                  </s:sequence>
                                  <s:attribute name="Name" type="s:string" use="required"/>
                                  <s:attribute name="Namespace" type="s:string" use="required"/>
                                  <s:attribute name="TagPrefix" type="s:string" use="optional"/>
                               </s:complexType>
                            </s:element>
                         </s:sequence>
                      </s:complexType>
                   </s:element>
                </s:sequence>
             </s:complexType>
          </s:element>
       </s:sequence>
    </s:complexType>
 </s:element>

GetCustomControlListResult: This element MUST contain a list of controls available on the server.

ControlsList: This element MUST contain one Assembly element for each binary file containing controls that is installed on the server. If the technology supports organizing controls into namespaces and a binary file contains controls in more than one namespace, there MUST be one Assembly element for each binary file and namespace pairing. In this case, there are multiple Assembly elements with the same Name attribute, but different Namespace attributes.

ControlsList.Assembly: Each instance of this element specifies one namespace in one binary file installed on the server that contains controls.<82>

ControlsList.Assembly.Name: A server implementation-specific<83> string that uniquely identifies the binary file containing controls.

ControlsList.Assembly.Namespace: The namespace in the binary file that contains the controls.

ControlsList.Assembly.TagPrefix: An implementation-specific<84> string that specifies a tag prefix to be used for controls in this binary file. When used in conjunction with other portions of implementation-specific markup, it identifies the control to use in the object-oriented system of types in this binary file. It need not be unique.

ControlsList.Assembly.Control: Each instance of this element specifies one control on the server, contained in the binary file described by the parent Assembly element.<85>

ControlsList.Assembly.Control.Title: An implementation-specific<86> string that serves as the most prominent identification for the control.

ControlsList.Assembly.Control.Name: This attribute MUST contain the same string as ControlsList.Assembly.Control.Title.

ControlsList.Assembly.Control.Description: A textual description of the control. The client MAY<87> provide this additional information to users of the control to aid the user in selecting the proper control to use from a list.

ControlsList.Assembly.Control.Template: Implementation-specific<88> markup that can be used as a template for inserting new instances of this control.