← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/mono-addins/docs/Mono.Addins/RuntimeAddin.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/mono-addins/docs/Mono.Addins/RuntimeAddin.xml
 
1
<Type Name="RuntimeAddin" FullName="Mono.Addins.RuntimeAddin">
 
2
  <TypeSignature Language="C#" Value="public class RuntimeAddin" />
 
3
  <AssemblyInfo>
 
4
    <AssemblyName>Mono.Addins</AssemblyName>
 
5
    <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
6
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>System.Object</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Docs>
 
13
    <summary>Run-time representation of an add-in.</summary>
 
14
    <remarks>This class provides access to add-in resources and types at run-time.</remarks>
 
15
  </Docs>
 
16
  <Members>
 
17
    <Member MemberName="CreateInstance">
 
18
      <MemberSignature Language="C#" Value="public object CreateInstance (string typeName);" />
 
19
      <MemberType>Method</MemberType>
 
20
      <ReturnValue>
 
21
        <ReturnType>System.Object</ReturnType>
 
22
      </ReturnValue>
 
23
      <Parameters>
 
24
        <Parameter Name="typeName" Type="System.String" />
 
25
      </Parameters>
 
26
      <Docs>
 
27
        <param name="typeName">Name of the type.</param>
 
28
        <summary>Creates an instance of a type.</summary>
 
29
        <returns>A new instance of the type.</returns>
 
30
        <remarks>
 
31
          <para>
 
32
The type will be looked up in the assemblies that implement the add-in, and recursivelly in all add-ins on which it depends.
 
33
</para>
 
34
 
 
35
This method throw a <see cref="T:System.InvalidOperationException" /> if the type can't be found.
 
36
 
 
37
<para>
 
38
The specified type must have a default constructor.
 
39
</para></remarks>
 
40
      </Docs>
 
41
      <AssemblyInfo>
 
42
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
43
      </AssemblyInfo>
 
44
    </Member>
 
45
    <Member MemberName="CreateInstance">
 
46
      <MemberSignature Language="C#" Value="public object CreateInstance (string typeName, bool throwIfNotFound);" />
 
47
      <MemberType>Method</MemberType>
 
48
      <ReturnValue>
 
49
        <ReturnType>System.Object</ReturnType>
 
50
      </ReturnValue>
 
51
      <Parameters>
 
52
        <Parameter Name="typeName" Type="System.String" />
 
53
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
54
      </Parameters>
 
55
      <Docs>
 
56
        <param name="typeName">Name of the type.</param>
 
57
        <param name="throwIfNotFound">Indicates whether the method should throw an exception if the type can't be found.</param>
 
58
        <summary>Creates an instance of a type.</summary>
 
59
        <returns>A new instance of the type.</returns>
 
60
        <remarks>
 
61
          <para>
 
62
The type will be looked up in the assemblies that implement the add-in, and recursivelly in all add-ins on which it depends.
 
63
</para>
 
64
          <para>
 
65
If the type can't be found, this method throw a <see cref="T:System.InvalidOperationException" /> if 'throwIfNotFound' is 'true', or 'null' otherwise.</para>
 
66
          <para>
 
67
The specified type must have a default constructor.
 
68
</para>
 
69
        </remarks>
 
70
      </Docs>
 
71
      <AssemblyInfo>
 
72
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
73
      </AssemblyInfo>
 
74
    </Member>
 
75
    <Member MemberName="GetFilePath">
 
76
      <MemberSignature Language="C#" Value="public string GetFilePath (string fileName);" />
 
77
      <MemberType>Method</MemberType>
 
78
      <ReturnValue>
 
79
        <ReturnType>System.String</ReturnType>
 
80
      </ReturnValue>
 
81
      <Parameters>
 
82
        <Parameter Name="fileName" Type="System.String" />
 
83
      </Parameters>
 
84
      <Docs>
 
85
        <param name="fileName">To be added.</param>
 
86
        <summary>To be added.</summary>
 
87
        <returns>To be added.</returns>
 
88
        <remarks>To be added.</remarks>
 
89
      </Docs>
 
90
      <AssemblyInfo>
 
91
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
92
      </AssemblyInfo>
 
93
    </Member>
 
94
    <Member MemberName="GetFilePath">
 
95
      <MemberSignature Language="C#" Value="public string GetFilePath (string[] filePath);" />
 
96
      <MemberType>Method</MemberType>
 
97
      <AssemblyInfo>
 
98
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
99
      </AssemblyInfo>
 
100
      <ReturnValue>
 
101
        <ReturnType>System.String</ReturnType>
 
102
      </ReturnValue>
 
103
      <Parameters>
 
104
        <Parameter Name="filePath" Type="System.String[]">
 
105
          <Attributes>
 
106
            <Attribute>
 
107
              <AttributeName>System.ParamArray</AttributeName>
 
108
            </Attribute>
 
109
          </Attributes>
 
110
        </Parameter>
 
111
      </Parameters>
 
112
      <Docs>
 
113
        <param name="filePath">To be added.</param>
 
114
        <summary>To be added.</summary>
 
115
        <returns>To be added.</returns>
 
116
        <remarks>To be added.</remarks>
 
117
      </Docs>
 
118
    </Member>
 
119
    <Member MemberName="GetResource">
 
120
      <MemberSignature Language="C#" Value="public System.IO.Stream GetResource (string resourceName);" />
 
121
      <MemberType>Method</MemberType>
 
122
      <ReturnValue>
 
123
        <ReturnType>System.IO.Stream</ReturnType>
 
124
      </ReturnValue>
 
125
      <Parameters>
 
126
        <Parameter Name="resourceName" Type="System.String" />
 
127
      </Parameters>
 
128
      <Docs>
 
129
        <param name="resourceName">To be added.</param>
 
130
        <summary>To be added.</summary>
 
131
        <returns>To be added.</returns>
 
132
        <remarks>To be added.</remarks>
 
133
      </Docs>
 
134
      <AssemblyInfo>
 
135
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
136
      </AssemblyInfo>
 
137
    </Member>
 
138
    <Member MemberName="GetResource">
 
139
      <MemberSignature Language="C#" Value="public System.IO.Stream GetResource (string resourceName, bool throwIfNotFound);" />
 
140
      <MemberType>Method</MemberType>
 
141
      <AssemblyInfo>
 
142
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
143
      </AssemblyInfo>
 
144
      <ReturnValue>
 
145
        <ReturnType>System.IO.Stream</ReturnType>
 
146
      </ReturnValue>
 
147
      <Parameters>
 
148
        <Parameter Name="resourceName" Type="System.String" />
 
149
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
150
      </Parameters>
 
151
      <Docs>
 
152
        <param name="resourceName">To be added.</param>
 
153
        <param name="throwIfNotFound">To be added.</param>
 
154
        <summary>To be added.</summary>
 
155
        <returns>To be added.</returns>
 
156
        <remarks>To be added.</remarks>
 
157
      </Docs>
 
158
    </Member>
 
159
    <Member MemberName="GetResourceObject">
 
160
      <MemberSignature Language="C#" Value="public object GetResourceObject (string name);" />
 
161
      <MemberType>Method</MemberType>
 
162
      <AssemblyInfo>
 
163
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
164
      </AssemblyInfo>
 
165
      <ReturnValue>
 
166
        <ReturnType>System.Object</ReturnType>
 
167
      </ReturnValue>
 
168
      <Parameters>
 
169
        <Parameter Name="name" Type="System.String" />
 
170
      </Parameters>
 
171
      <Docs>
 
172
        <param name="name">To be added.</param>
 
173
        <summary>To be added.</summary>
 
174
        <returns>To be added.</returns>
 
175
        <remarks>To be added.</remarks>
 
176
      </Docs>
 
177
    </Member>
 
178
    <Member MemberName="GetResourceObject">
 
179
      <MemberSignature Language="C#" Value="public object GetResourceObject (string name, bool throwIfNotFound);" />
 
180
      <MemberType>Method</MemberType>
 
181
      <AssemblyInfo>
 
182
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
183
      </AssemblyInfo>
 
184
      <ReturnValue>
 
185
        <ReturnType>System.Object</ReturnType>
 
186
      </ReturnValue>
 
187
      <Parameters>
 
188
        <Parameter Name="name" Type="System.String" />
 
189
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
190
      </Parameters>
 
191
      <Docs>
 
192
        <param name="name">To be added.</param>
 
193
        <param name="throwIfNotFound">To be added.</param>
 
194
        <summary>To be added.</summary>
 
195
        <returns>To be added.</returns>
 
196
        <remarks>To be added.</remarks>
 
197
      </Docs>
 
198
    </Member>
 
199
    <Member MemberName="GetResourceObject">
 
200
      <MemberSignature Language="C#" Value="public object GetResourceObject (string name, bool throwIfNotFound, System.Globalization.CultureInfo culture);" />
 
201
      <MemberType>Method</MemberType>
 
202
      <AssemblyInfo>
 
203
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
204
      </AssemblyInfo>
 
205
      <ReturnValue>
 
206
        <ReturnType>System.Object</ReturnType>
 
207
      </ReturnValue>
 
208
      <Parameters>
 
209
        <Parameter Name="name" Type="System.String" />
 
210
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
211
        <Parameter Name="culture" Type="System.Globalization.CultureInfo" />
 
212
      </Parameters>
 
213
      <Docs>
 
214
        <param name="name">To be added.</param>
 
215
        <param name="throwIfNotFound">To be added.</param>
 
216
        <param name="culture">To be added.</param>
 
217
        <summary>To be added.</summary>
 
218
        <returns>To be added.</returns>
 
219
        <remarks>To be added.</remarks>
 
220
      </Docs>
 
221
    </Member>
 
222
    <Member MemberName="GetResourceString">
 
223
      <MemberSignature Language="C#" Value="public string GetResourceString (string name);" />
 
224
      <MemberType>Method</MemberType>
 
225
      <AssemblyInfo>
 
226
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
227
      </AssemblyInfo>
 
228
      <ReturnValue>
 
229
        <ReturnType>System.String</ReturnType>
 
230
      </ReturnValue>
 
231
      <Parameters>
 
232
        <Parameter Name="name" Type="System.String" />
 
233
      </Parameters>
 
234
      <Docs>
 
235
        <param name="name">To be added.</param>
 
236
        <summary>To be added.</summary>
 
237
        <returns>To be added.</returns>
 
238
        <remarks>To be added.</remarks>
 
239
      </Docs>
 
240
    </Member>
 
241
    <Member MemberName="GetResourceString">
 
242
      <MemberSignature Language="C#" Value="public string GetResourceString (string name, bool throwIfNotFound);" />
 
243
      <MemberType>Method</MemberType>
 
244
      <AssemblyInfo>
 
245
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
246
      </AssemblyInfo>
 
247
      <ReturnValue>
 
248
        <ReturnType>System.String</ReturnType>
 
249
      </ReturnValue>
 
250
      <Parameters>
 
251
        <Parameter Name="name" Type="System.String" />
 
252
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
253
      </Parameters>
 
254
      <Docs>
 
255
        <param name="name">To be added.</param>
 
256
        <param name="throwIfNotFound">To be added.</param>
 
257
        <summary>To be added.</summary>
 
258
        <returns>To be added.</returns>
 
259
        <remarks>To be added.</remarks>
 
260
      </Docs>
 
261
    </Member>
 
262
    <Member MemberName="GetResourceString">
 
263
      <MemberSignature Language="C#" Value="public string GetResourceString (string name, bool throwIfNotFound, System.Globalization.CultureInfo culture);" />
 
264
      <MemberType>Method</MemberType>
 
265
      <AssemblyInfo>
 
266
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
267
      </AssemblyInfo>
 
268
      <ReturnValue>
 
269
        <ReturnType>System.String</ReturnType>
 
270
      </ReturnValue>
 
271
      <Parameters>
 
272
        <Parameter Name="name" Type="System.String" />
 
273
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
274
        <Parameter Name="culture" Type="System.Globalization.CultureInfo" />
 
275
      </Parameters>
 
276
      <Docs>
 
277
        <param name="name">To be added.</param>
 
278
        <param name="throwIfNotFound">To be added.</param>
 
279
        <param name="culture">To be added.</param>
 
280
        <summary>To be added.</summary>
 
281
        <returns>To be added.</returns>
 
282
        <remarks>To be added.</remarks>
 
283
      </Docs>
 
284
    </Member>
 
285
    <Member MemberName="GetType">
 
286
      <MemberSignature Language="C#" Value="public Type GetType (string typeName);" />
 
287
      <MemberType>Method</MemberType>
 
288
      <ReturnValue>
 
289
        <ReturnType>System.Type</ReturnType>
 
290
      </ReturnValue>
 
291
      <Parameters>
 
292
        <Parameter Name="typeName" Type="System.String" />
 
293
      </Parameters>
 
294
      <Docs>
 
295
        <param name="typeName">Name of the type.</param>
 
296
        <summary>To be added.</summary>
 
297
        <returns>The type.</returns>
 
298
        <remarks>
 
299
          <para>
 
300
The type will be looked up in the assemblies that implement the add-in, and recursivelly in all add-ins on which it depends.
 
301
</para>
 
302
 
 
303
This method throw a <see cref="T:System.InvalidOperationException" /> if the type can't be found.</remarks>
 
304
      </Docs>
 
305
      <AssemblyInfo>
 
306
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
307
      </AssemblyInfo>
 
308
    </Member>
 
309
    <Member MemberName="GetType">
 
310
      <MemberSignature Language="C#" Value="public Type GetType (string typeName, bool throwIfNotFound);" />
 
311
      <MemberType>Method</MemberType>
 
312
      <ReturnValue>
 
313
        <ReturnType>System.Type</ReturnType>
 
314
      </ReturnValue>
 
315
      <Parameters>
 
316
        <Parameter Name="typeName" Type="System.String" />
 
317
        <Parameter Name="throwIfNotFound" Type="System.Boolean" />
 
318
      </Parameters>
 
319
      <Docs>
 
320
        <param name="typeName">Name of the type.</param>
 
321
        <param name="throwIfNotFound">Indicates whether the method should throw an exception if the type can't be found.</param>
 
322
        <summary>To be added.</summary>
 
323
        <returns>The type.</returns>
 
324
        <remarks>
 
325
          <para>
 
326
The type will be looked up in the assemblies that implement the add-in, and recursivelly in all add-ins on which it depends.
 
327
</para>
 
328
 
 
329
If the type can't be found, this method throw a <see cref="T:System.InvalidOperationException" /> if 'throwIfNotFound' is 'true', or 'null' otherwise.</remarks>
 
330
      </Docs>
 
331
      <AssemblyInfo>
 
332
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
333
      </AssemblyInfo>
 
334
    </Member>
 
335
    <Member MemberName="Id">
 
336
      <MemberSignature Language="C#" Value="public string Id { get; }" />
 
337
      <MemberType>Property</MemberType>
 
338
      <ReturnValue>
 
339
        <ReturnType>System.String</ReturnType>
 
340
      </ReturnValue>
 
341
      <Docs>
 
342
        <summary>Identifier of the add-in.</summary>
 
343
        <value>Identifier of the add-in.</value>
 
344
        <remarks />
 
345
      </Docs>
 
346
      <AssemblyInfo>
 
347
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
348
      </AssemblyInfo>
 
349
    </Member>
 
350
    <Member MemberName="Localizer">
 
351
      <MemberSignature Language="C#" Value="public Mono.Addins.AddinLocalizer Localizer { get; }" />
 
352
      <MemberType>Property</MemberType>
 
353
      <AssemblyInfo>
 
354
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
355
      </AssemblyInfo>
 
356
      <ReturnValue>
 
357
        <ReturnType>Mono.Addins.AddinLocalizer</ReturnType>
 
358
      </ReturnValue>
 
359
      <Docs>
 
360
        <summary>To be added.</summary>
 
361
        <value>To be added.</value>
 
362
        <remarks>To be added.</remarks>
 
363
      </Docs>
 
364
    </Member>
 
365
    <Member MemberName="PrivateDataPath">
 
366
      <MemberSignature Language="C#" Value="public string PrivateDataPath { get; }" />
 
367
      <MemberType>Property</MemberType>
 
368
      <AssemblyInfo>
 
369
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
370
      </AssemblyInfo>
 
371
      <ReturnValue>
 
372
        <ReturnType>System.String</ReturnType>
 
373
      </ReturnValue>
 
374
      <Docs>
 
375
        <summary>To be added.</summary>
 
376
        <value>To be added.</value>
 
377
        <remarks>To be added.</remarks>
 
378
      </Docs>
 
379
    </Member>
 
380
    <Member MemberName="ToString">
 
381
      <MemberSignature Language="C#" Value="public override string ToString ();" />
 
382
      <MemberType>Method</MemberType>
 
383
      <AssemblyInfo>
 
384
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
385
      </AssemblyInfo>
 
386
      <ReturnValue>
 
387
        <ReturnType>System.String</ReturnType>
 
388
      </ReturnValue>
 
389
      <Parameters />
 
390
      <Docs>
 
391
        <summary>To be added.</summary>
 
392
        <returns>To be added.</returns>
 
393
        <remarks>To be added.</remarks>
 
394
      </Docs>
 
395
    </Member>
 
396
    <Member MemberName="Version">
 
397
      <MemberSignature Language="C#" Value="public string Version { get; }" />
 
398
      <MemberType>Property</MemberType>
 
399
      <ReturnValue>
 
400
        <ReturnType>System.String</ReturnType>
 
401
      </ReturnValue>
 
402
      <Docs>
 
403
        <summary>Version of the add-in.</summary>
 
404
        <value>Version of the add-in.</value>
 
405
        <remarks />
 
406
      </Docs>
 
407
      <AssemblyInfo>
 
408
        <AssemblyVersion>0.4.0.0</AssemblyVersion>
 
409
      </AssemblyInfo>
 
410
    </Member>
 
411
  </Members>
 
412
</Type>