-
Notifications
You must be signed in to change notification settings - Fork 8
/
SharepointListAdapterObject.xml
46 lines (46 loc) · 4.7 KB
/
SharepointListAdapterObject.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
<Type Name="SharepointListAdapterObject" FullName="Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapterObject">
<TypeSignature Language="C#" Value="public interface SharepointListAdapterObject : Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapter" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract SharepointListAdapterObject implements class Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapter" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapterObject" />
<TypeSignature Language="VB.NET" Value="Public Interface SharepointListAdapterObject
Implements SharepointListAdapter" />
<TypeSignature Language="C++ CLI" Value="public interface class SharepointListAdapterObject : Microsoft::Office::Interop::InfoPath::SemiTrust::SharepointListAdapter" />
<TypeSignature Language="F#" Value="type SharepointListAdapterObject = interface
 interface SharepointListAdapter" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapter</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.CoClass(typeof(Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapterObjectWrapper))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("096cd69a-0786-11d1-95fa-0080c78ee3bb")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a connection to a SharePoint list or document library.</summary>
<remarks>
<para>This type is a wrapper for a coclass that is required by managed code for COM interoperability. Use this type to access the members of the COM interface implemented by this coclass. For information about the COM interface, including a link to descriptions of its members, see<see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapter" />.</para>
<para>Using the members of the <b>SharepointListAdapter</b> interface provides compatibility with InfoPath 2003. To use new members that were added to the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.SharepointListAdapter2" /> object model in Microsoft InfoPath 2010, you must cast the object returned by the object to the <b>SharepointListAdapter2</b> type. For more information, see How to: Use Object Model Members That Are Not Compatible with InfoPath 2003.</para>
<para>The <b>SharePointListAdapter</b> object represents the InfoPath data adapter for retrieving data from a SharePoint list or document library.</para>
<para>For a secondary data source, the <b>SharePointListAdapter</b> object is accessible through the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.DataObject.QueryAdapter" /> property of <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.DataSourceObject" /> object. Data adapter objects are accessible through the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust._XDocument2.DataAdapters" /> property of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.XDocument" /> object.</para>
<para />
</remarks>
<example>
<code><span class="label">SharepointListAdapter</span> SPList = ((<span class="label">SharepointListAdapter</span>)thisXDocument.DataAdapters[“SharePoint list”]);
thisXDocument.UI.Alert(SPList.SiteUrl);
SPList.Query();</code>
<para>In the following example, a reference to the <b>SharePointListAdapter</b> object is accessed through the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.DataObject.QueryAdapter" /> property of a data adapter object by passing the name of the data adapter object to the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.DataAdapters.Item(System.Object)" /> property of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.DataAdaptersCollection" /> collection:</para>
<code><span class="label">SharepointListAdapter</span> adapter;
adapter = (<span class="label">SharepointListAdapter</span>) thisXDocument.DataAdapters["Announcements"];</code>
<para>After the reference has been set, you can use the methods of the <b>SharePointListAdapter</b> object as shown in the following example, which re-queries the SharePoint list or library to update the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.DataObject.DOM" /> property of the data adapter object:</para>
<code>adapter.Query();</code>
</example>
</Docs>
<Members />
</Type>