2.2.3.1 XML
The XML element specifies a Web Part connection as follows:
-
<s:schema elementFormDefault="qualified" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:s1="http://microsoft.com/wsdl/types/"> <s:import namespace="http://microsoft.com/wsdl/types/" /> <s:element name="XML"> <s:complexType> <s:sequence> <s:element name="ConnDesign"> <s:complexType> <s:sequence> <s:element name="ConnectionInfo"> <s:complexType> <s:sequence> <s:element name="WebPart" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:sequence> <s:element name="InterfaceGroups" minOccurs="1" maxOccurs="1"> <s:complexType> <s:sequence> <s:element name="InterfaceGroup" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:sequence> <s:element name="Interfaces"> <s:complexType> <s:sequence> <s:element name="Interface"> <s:complexType> <s:choice minOccurs="0" maxOccurs="1"> <s:element name="InitEventArgs" type="InitEventArgsType"/> <s:element name="Properties" type="PropertiesType" /> </s:choice> <s:attribute name="IsASP" type="s:string" /> <s:attribute name="Match" type="s:string" /> <s:attribute name="InterfaceName" type="s:string" /> <s:attribute name="Type" type="s:string" /> <s:attribute name="MenuLabel" type="s:string" /> <s:attribute name="Description" type="s:string" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> </s:sequence> <s:attribute name="GroupName" type="s:string" use="required" /> <s:attribute name="GroupMenuLabel" type="s:string" use="required" /> <s:attribute name="IsASP" type="s:string" use="required" /> <s:attribute name="Description" type="s:string" use="required" /> <s:attribute name="RunAt" type="runAtType" use="required" /> <s:attribute name="MaxConnections" use="required"> <s:simpleType> <s:restriction base="s:integer"> <s:enumeration value="-1" /> <s:enumeration value="1" /> </s:restriction> </s:simpleType> </s:attribute> <s:attribute name="AllowCrossPageConnections" type="s:string" use="required" /> <s:attribute name="ConnectionType" type="ConnectionTypeType" use="required" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> </s:sequence> <s:attribute name="ID" type="s:string" /> <s:attribute name="WebPartID" type="s1:guid" /> <s:attribute name="ConnectionID" type="s1:guid" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> <s:element name="Compatibility"> <s:complexType> <s:sequence> <s:element name="sWebPart" minOccurs="0" maxOccurs="1"> <s:complexType> <s:sequence> <s:element name="sInterfaces"> <s:complexType> <s:sequence> <s:element name="int" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:choice minOccurs="0" maxOccurs="1"> <s:element name="InitEventArgs" type="InitEventArgsType"/> <s:element name="Properties" type="PropertiesType" /> </s:choice> <s:attribute name="IsASP" type="s:string" /> <s:attribute name="id" type="s:string" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> <s:element name="sg" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:sequence> <s:element name="tParts"> <s:complexType> <s:sequence> <s:element name="tWebPart" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:sequence> <s:element name="tg" minOccurs="0" maxOccurs="unbounded"> <s:complexType> <s:sequence> <s:element name="tInterface"> <s:complexType> <s:sequence> <s:choice minOccurs="0" maxOccurs="1"> <s:element name="InitEventArgs" type="InitEventArgsType"/> <s:element name="Properties" type="PropertiesType" /> </s:choice> <s:element name="mi" minOccurs="1" maxOccurs="1"> <s:complexType> <s:sequence /> <s:attribute name="xInfo" type="s:string" /> <s:attribute name="id" type="s:string" /> <s:attribute name="isXFormUINeeded" type="s:string" /> </s:complexType> </s:element> <s:element name="xForm" minOccurs="0" maxOccurs="1"> <s:complexType> <s:sequence /> <s:attribute name="type" type="s:string" /> </s:complexType> </s:element> </s:sequence> <s:attribute name="IsASP" type="s:string" /> <s:attribute name="id" type="s:string" /> </s:complexType> </s:element> </s:sequence> <s:attribute name="id" type="s:string" /> <s:attribute name="gLabel" type="s:string" /> <s:attribute name="des" type="s:string" /> <s:attribute name="isMaxedOut" type="s:string" /> <s:attribute name="runAt" type="runAtType"> </s:attribute> <s:attribute name="ConnectionType" type="ConnectionTypeType"> </s:attribute> <s:attribute name="IsASP" type="s:string" /> <s:attribute name="isConn" type="s:string" /> </s:complexType> </s:element> </s:sequence> <s:attribute name="ID" type="s:string" use="required" /> <s:attribute name="WebPartID" type="s:string" use="optional" /> <s:attribute name="ConnectionID" type="s:string" use="optional" /> <s:attribute name="pinnedTo" type="runAtType" /> <s:attribute name="title" type="s:string" use="required" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> </s:sequence> <s:attribute name="des" type="s:string" use="required" /> <s:attribute name="isMaxedOut" type="s:string" /> <s:attribute name="id" type="s:string" use="required" /> <s:attribute name="ConnectionType" type="ConnectionTypeType" use="required" /> <s:attribute name="IsASP" type="s:string" /> <s:attribute name="runAt" type="runAtType" use="required" /> <s:attribute name="gLabel" type="s:string" use="required" /> </s:complexType> </s:element> </s:sequence> <s:attribute name="ID" type="s:string" use="required" /> <s:attribute name="pinnedTo" type="runAtType" use="optional" /> <s:attribute name="WebPartID" type="s:string" use="optional" /> <s:attribute name="ConnectionID" type="s:string" use="optional" /> <s:attribute name="title" type="s:string" /> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> </s:sequence> </s:complexType> </s:element> </s:sequence> <s:attribute name="id" use="optional"> <s:simpleType> <s:restriction base="s:string"> <s:enumeration value="MSOConn_Compatibility" /> </s:restriction> </s:simpleType> </s:attribute> </s:complexType> </s:element> </s:schema>
XML: The root node of the Web Part Connection Information Schema.
XML.id: Specifies that this is used for Web Part connection information.
XML.ConnDesign: The container for ConnectionInfo and Compatibility child elements.
XML.ConnDesign.ConnectionInfo: The container for WebPart nodes that can potentially participate in the Web Part connection.
XML.ConnDesign.ConnectionInfo.WebPart: Specifies a single Web Part and all information regarding the Web Part connection interfaces that it supports.
XML.ConnDesign.ConnectionInfo.WebPart.ID: The control name that identifies this element in the page in which it is located.
XML.ConnDesign.ConnectionInfo.WebPart.WebPartID: A GUID that uniquely identifies this element in the page in which it is located.
XML.ConnDesign.ConnectionInfo.WebPart.ConnectionID: A GUID that identifies the Web Part that this element references. It is unique in the scope of both same-page Web Part connections and cross-page Web Part connections.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups: A container for all Web Part connection interface groups supported by the parent WebPart element.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup: Specifies a single interface group that the ancestor WebPart element supports. An interface group contains either zero or one interface. An interface refers to one manner in which the ancestor WebPart element can connect to another Web Part.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.GroupName: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.GroupMenuLabel: A localized string that is a user-recognizable short name for the interface group.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.IsASP: Specifies whether this element can have a descendent element of type InitEventArgs or type PropertiesType.<1> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
This InterfaceGroup element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
This InterfaceGroup element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Description: A localized description of the interface group.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.RunAt: Specifies whether the Web Part connection can run on the server that is rendering the page, on the client receiving the rendered page, or on either.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.MaxConnections: Specifies the maximum number of Web Part connections supported by this interface group. A value of -1 indicates that there is no limit.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.AllowCrossPageConnections: Specifies whether this interface group supports cross-page Web Part connections.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.ConnectionType: Specifies whether this interface group is a provider or a consumer of data in a Web Part connection.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces: The container for the Interface members of the parent single InterfaceGroup.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface: Specifies a single Web Part connection interface that is a member of the ancestor Web Part connection interface group that is implemented by the ancestor Web Part. If IsASP is set to "True", it can have a Properties child element. If IsASP is set to "False", it can have an InitEventArgs child element.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.IsASP: Specifies whether this element can have a descendent element of type InitEventArgs or type PropertiesType.<2> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
This Interface element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
This Interface element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.Match: The server MUST return this set to True.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.InterfaceName: Identifies an instance of using a Web Part connection interface on a Web Part. If the moniker is undefined in the object type of the Web Part, the server MUST retrieve this value from the definition of the type of the Web Part connection.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.Type: The name of the object type in the object-oriented system that names the interface that the Web Part connection implements.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.MenuLabel: A localized string that is a user-recognizable short name for the Web Part connection interface.
XML.ConnDesign.ConnectionInfo.WebPart.InterfaceGroups.InterfaceGroup.Interfaces.Interface.Description: A localized description of the interface.
XML.ConnDesign.Compatibility: The container for the sWebPart element.
XML.ConnDesign.Compatibility.sWebPart: Specifies the Web Part connection details for a single Web Part that can form a Web Part connection with one of the descendant tWebPart elements.
XML.ConnDesign.Compatibility.sWebPart.ID: A control name that uniquely identifies the sWebPart in the page in which it is located.
XML.ConnDesign.Compatibility.sWebPart.WebPartID: A GUID that uniquely identifies this element in the page in which it is located.
XML.ConnDesign.Compatibility.sWebPart.ConnectionID: A GUID that identifies the Web Part that this element references. It is unique in the scope of both same-page Web Part connections and cross-page Web Part connections.
XML.ConnDesign.Compatibility.sWebPart.title: A string that is the friendly name for the Web Part.
XML.ConnDesign.Compatibility.sWebPart.pinnedTo: Specifies whether this Web Part processes its connections on the client or on the server, given the current state of the authoring of the page.
XML.ConnDesign.Compatibility.sWebPart.sInterfaces: A container for the int elements that specify the interfaces available on the Web Part referred to by the ancestor sWebPart.
XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int: Specifies a single interface that is available for a Web Part connection on the Web Part referred to by the ancestor sWebPart.
XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int.IsASP: Specifies whether the int element can have a descendent element of type InitEventArgs or type PropertiesType.<3> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
The int element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
The int element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int.id: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg: Specifies a Web Part connection interface group on the Web Part referenced by the parent sWebPart element. This element contains the possible combinations of Web Part connections between the referenced Web Part and other Web Parts in the target scope of the Web Part connection interface group that is specified by this element.
XML.ConnDesign.Compatibility.sWebPart.sg.des: A localized description of the interface group.
XML.ConnDesign.Compatibility.sWebPart.sg.isMaxedOut: Indicates whether the connection has exceeded its maximum number of allowed connections.
XML.ConnDesign.Compatibility.sWebPart.sg.id: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg.ConnectionType: Specifies whether this interface group is a provider or a consumer of data in a Web Part connection.
XML.ConnDesign.Compatibility.sWebPart.sg.IsASP: Specifies whether the XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int element with the same id as this element and a common sWebPart ancestor with this element is permitted to have a descendent element of type InitEventArgs or type PropertiesType.<4> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
The related XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
The related XML.ConnDesign.Compatibility.sWebPart.sInterfaces.int element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.Compatibility.sWebPart.sg.runAt: Specifies whether the connection can run on the server that is rendering the page, the client receiving the rendered page, or on either.
XML.ConnDesign.Compatibility.sWebPart.sg.gLabel: A localized string that is a user-recognizable short name for the interface group.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts: A container for the tWebPart elements that are Web Parts that implement a Web Part connection to which the Web Part connection interface group of the sg element can connect.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart: Specifies a single Web Part that supports one interface connection group with which Web Part connection interface group of the ancestor sg can form a Web Part connection.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.ID: A control name that uniquely identifies the tWebPart in the page in which it is located.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.WebPartID: A GUID that uniquely identifies this element in the page in which it is located.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.ConnectionID: A GUID that identifies the Web Part that this element references. It is unique in the scope of both same-page Web Part connections and cross-page Web Part connections.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.pinnedTo: Specifies whether this Web Part processes its connections on the client or on the server, given the current state of the authoring of the page.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.title: A string that is the friendly name for the Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg: Specifies a single connection interface group that is supported by the parent tWebPart. An interface refers to one manner in which the ancestor tWebPart can participate in Web Part connections.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.isConn: Set to True when the Web Part has at least one Web Part connection. Otherwise, set to False.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.des: A localized description of the interface group.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.isMaxedOut: Specifies whether the connection has exceeded its maximum number of allowed Web Part connections.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.id: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.ConnectionType: Specifies whether this interface group is a provider or a consumer of data in a Web Part connection.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.IsASP: Specifies whether the tg element can have a descendent element of type InitEventArgs or type PropertiesType.<5> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
The tg element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
The tg element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.runAt: Specifies whether the connection can run on the server that is rendering the page, on the client receiving the page, or on either.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.gLabel: A localized string that is a user-recognizable short name for the interface group.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.tInterface: Specifies a single connection interface that is part of the parent tg connection interface group. If IsASP is set to True, it can have a Properties child element. If IsASP is set to False, it can have an InitEventArgs child element.
XML.ConnDesign.Compatibility.sWebPart. sg.tParts.tWebPart.tg.tInterface.IsASP: Specifies whether the tInterface element can have a descendent element of type InitEventArgs or type PropertiesType.<6> If absent, the client MUST interpret this as being set to FALSE.
|
Value |
Description |
|---|---|
|
True |
The tInterface element MUST NOT have a descendant of type InitEventArgs. |
|
False (omitted) |
The tInterface element MUST NOT have a descendant of type PropertiesType. |
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.tInterface.id: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.mi: Specifies a single interface that matches the Web Part connection interface of the ancestor sg element. This element contains information necessary to author a transformation between the provider and the consumer, if required.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.mi.xInfo: Specifies implementation-specific<7> details about authoring a transformation between the provider and the consumer.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.mi.id: Identifies an instance of using a Web Part connection interface on a Web Part.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.mi.isXFormUINeeded: Specifies whether special UI is needed to specify the transformation of data from one provider interface to a nominally incompatible consumer interface.
XML.ConnDesign.Compatibility.sWebPart.sg.tParts.tWebPart.tg.xForm.type: Specifies implementation-specific<8> name for an object that can transform data for a provider interface into data required by a different consumer interface.