-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
ContractAdapter.xml
176 lines (165 loc) · 11.2 KB
/
ContractAdapter.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
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
<Type Name="ContractAdapter" FullName="System.AddIn.Pipeline.ContractAdapter">
<TypeSignature Language="C#" Value="public static class ContractAdapter" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ContractAdapter extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.AddIn.Pipeline.ContractAdapter" />
<TypeSignature Language="VB.NET" Value="Public Class ContractAdapter" />
<TypeSignature Language="F#" Value="type ContractAdapter = class" />
<TypeSignature Language="C++ CLI" Value="public ref class ContractAdapter abstract sealed" />
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Provides methods for sharing and readapting add-ins.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
You can use this class to share an add-in with another host that does not have the same pipeline to that add-in (particularly, another host that does not have the same host view of the add-in).
If you need to adapt an activated add-in from its host view to the contract, use the <xref:System.AddIn.Pipeline.ContractAdapter.ViewToContractAdapter%2A> method.
If you have an instance of the contract and need to convert it to the host view, use the <xref:System.AddIn.Pipeline.ContractAdapter.ContractToViewAdapter%2A> method.
]]></format>
</remarks>
</Docs>
<Members>
<MemberGroup MemberName="ContractToViewAdapter<TView>">
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Obtains a host view of an add-in if a suitable host-side adapter is found at a specified location.</summary>
</Docs>
</MemberGroup>
<Member MemberName="ContractToViewAdapter<TView>">
<MemberSignature Language="C#" Value="public static TView ContractToViewAdapter<TView> (System.AddIn.Pipeline.ContractHandle contract, System.AddIn.Hosting.PipelineStoreLocation location);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TView ContractToViewAdapter<TView>(class System.AddIn.Pipeline.ContractHandle contract, valuetype System.AddIn.Hosting.PipelineStoreLocation location) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Pipeline.ContractAdapter.ContractToViewAdapter``1(System.AddIn.Pipeline.ContractHandle,System.AddIn.Hosting.PipelineStoreLocation)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function ContractToViewAdapter(Of TView) (contract As ContractHandle, location As PipelineStoreLocation) As TView" />
<MemberSignature Language="F#" Value="static member ContractToViewAdapter : System.AddIn.Pipeline.ContractHandle * System.AddIn.Hosting.PipelineStoreLocation -> 'View" Usage="System.AddIn.Pipeline.ContractAdapter.ContractToViewAdapter (contract, location)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TView>
 static TView ContractToViewAdapter(System::AddIn::Pipeline::ContractHandle ^ contract, System::AddIn::Hosting::PipelineStoreLocation location);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>TView</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TView" />
</TypeParameters>
<Parameters>
<Parameter Name="contract" Type="System.AddIn.Pipeline.ContractHandle" />
<Parameter Name="location" Type="System.AddIn.Hosting.PipelineStoreLocation" />
</Parameters>
<Docs>
<typeparam name="TView">The type that defines the host view of the add-in.</typeparam>
<param name="contract">A handle to the contract used by the add-in to be shared.</param>
<param name="location">The host's application base.</param>
<summary>Obtains a host view of an add-in if a suitable host-side adapter is found at a location specified by a value from the <see cref="T:System.AddIn.Hosting.PipelineStoreLocation" /> enumeration.</summary>
<returns>The host view of the add-in that is shared.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
In this scenario, an entity has an instance of a contract and wants to adapt it to a particular view. Use this method to query the system to find and instantiate an adapter to convert into that view.
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="location" /> is invalid.</exception>
</Docs>
</Member>
<Member MemberName="ContractToViewAdapter<TView>">
<MemberSignature Language="C#" Value="public static TView ContractToViewAdapter<TView> (System.AddIn.Pipeline.ContractHandle contract, string pipelineRoot);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig !!TView ContractToViewAdapter<TView>(class System.AddIn.Pipeline.ContractHandle contract, string pipelineRoot) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Pipeline.ContractAdapter.ContractToViewAdapter``1(System.AddIn.Pipeline.ContractHandle,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function ContractToViewAdapter(Of TView) (contract As ContractHandle, pipelineRoot As String) As TView" />
<MemberSignature Language="F#" Value="static member ContractToViewAdapter : System.AddIn.Pipeline.ContractHandle * string -> 'View" Usage="System.AddIn.Pipeline.ContractAdapter.ContractToViewAdapter (contract, pipelineRoot)" />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename TView>
 static TView ContractToViewAdapter(System::AddIn::Pipeline::ContractHandle ^ contract, System::String ^ pipelineRoot);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Security.SecuritySafeCritical]</AttributeName>
<AttributeName Language="F#">[<System.Security.SecuritySafeCritical>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>TView</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TView" />
</TypeParameters>
<Parameters>
<Parameter Name="contract" Type="System.AddIn.Pipeline.ContractHandle" />
<Parameter Name="pipelineRoot" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TView">The type that defines the host view of the add-in.</typeparam>
<param name="contract">A handle to the contract used by the add-in to be shared.</param>
<param name="pipelineRoot">A path to the add-in store.</param>
<summary>Obtains a host view of an add-in if a suitable host-side adapter is found at a location specified by a path.</summary>
<returns>The host view of the add-in that is shared.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
In this scenario, an entity has an instance of a contract and wants to adapt it to a particular view. Use this method to query the system to find and instantiate an adapter to convert into that view.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="ViewToContractAdapter">
<MemberSignature Language="C#" Value="public static System.AddIn.Pipeline.ContractHandle ViewToContractAdapter (object view);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.AddIn.Pipeline.ContractHandle ViewToContractAdapter(object view) cil managed" />
<MemberSignature Language="DocId" Value="M:System.AddIn.Pipeline.ContractAdapter.ViewToContractAdapter(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Shared Function ViewToContractAdapter (view As Object) As ContractHandle" />
<MemberSignature Language="F#" Value="static member ViewToContractAdapter : obj -> System.AddIn.Pipeline.ContractHandle" Usage="System.AddIn.Pipeline.ContractAdapter.ViewToContractAdapter view" />
<MemberSignature Language="C++ CLI" Value="public:
 static System::AddIn::Pipeline::ContractHandle ^ ViewToContractAdapter(System::Object ^ view);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.AddIn</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.AddIn.Pipeline.ContractHandle</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="view" Type="System.Object" />
</Parameters>
<Docs>
<param name="view">The host view of an add-in activated by the system from the current application domain.</param>
<summary>Gets the handle to the contract for a provided host view of an add-in.</summary>
<returns>A handle to the contract.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
In this scenario, the source entity (a host) has an add-in that wants to be shared by a destination entity (another host).
Use this method to obtain the handle to the contract that was instantiated for the source entity by the add-in system.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="view" /> is <see langword="null" />.</exception>
</Docs>
</Member>
</Members>
</Type>