-
Notifications
You must be signed in to change notification settings - Fork 12
/
AddIn.xml
342 lines (342 loc) · 18.9 KB
/
AddIn.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
<Type Name="AddIn" FullName="Microsoft.Office.Interop.Word.AddIn">
<TypeSignature Language="C#" Value="public interface AddIn" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract AddIn" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.Word.AddIn" />
<TypeSignature Language="VB.NET" Value="Public Interface AddIn" />
<TypeSignature Language="C++ CLI" Value="public interface class AddIn" />
<TypeSignature Language="F#" Value="type AddIn = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("0002097E-0000-0000-C000-000000000046")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.TypeLibType(4288)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a single add-in, either installed or not installed.</summary>
<remarks>
<para>The <b>AddIn</b> object is a member of the <see cref="T:Microsoft.Office.Interop.Word.AddIns" /> collection. The <b>AddIns</b> collection contains all the add-ins available to Microsoft Word, regardless of whether or not they're currently loaded. The <b>AddIns</b> collection includes global templates or Word add-in libraries (WLLs) displayed in the Templates and Add-ins dialog box (Tools menu).</para>
<para>Use <b>AddIns</b>(<paramref name="index" />), where <paramref name="index" /> is the add-in name or index number, to return a single <b>AddIn</b> object. You must exactly match the spelling (but not necessarily the capitalization) of the name, as it's shown in the Templates and Add-Ins dialog box.</para>
<para>The index number represents the position of the add-in in the list of add-ins in the Templates and Add-ins dialog box.</para>
<para>Use the <see cref="M:Microsoft.Office.Interop.Word.AddIns.Add(System.String,System.Object@)" /> method to add an add-in to the list of available add-ins and (optionally) install it using the <paramref name="Install" /> argument.</para>
<para>To install an add-in shown in the list of available add-ins, use the <see cref="P:Microsoft.Office.Interop.Word.AddIn.Installed" /> property.</para>
<para>Use the <see cref="P:Microsoft.Office.Interop.Word.AddIn.Compiled" /> property to determine whether an <b>AddIn</b> object is a template or a WLL.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Application">
<MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.Application Application { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.Application Application" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Application" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Interop::Word::Application ^ Application { Microsoft::Office::Interop::Word::Application ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Application : Microsoft.Office.Interop.Word.Application" Usage="Microsoft.Office.Interop.Word.AddIn.Application" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1000)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1000)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Interop.Word.Application</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <see cref="T:Microsoft.Office.Interop.Word.Application" /> object that represents the creator of the specified object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Autoload">
<MemberSignature Language="C#" Value="public bool Autoload { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Autoload" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Autoload" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Autoload As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Autoload { bool get(); };" />
<MemberSignature Language="F#" Value="member this.Autoload : bool" Usage="Microsoft.Office.Interop.Word.AddIn.Autoload" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(6)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(6)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value indicating whether the specified add-in is automatically loaded when Microsoft Word is started.</summary>
<value>To be added.</value>
<remarks>
<para>Add-ins located in the Startup folder in the Word program folder are automatically loaded.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Compiled">
<MemberSignature Language="C#" Value="public bool Compiled { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Compiled" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Compiled" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Compiled As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Compiled { bool get(); };" />
<MemberSignature Language="F#" Value="member this.Compiled : bool" Usage="Microsoft.Office.Interop.Word.AddIn.Compiled" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(5)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(5)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value indicating whether the specified add-in is a Microsoft Word add-in library (WLL).</summary>
<value>To be added.</value>
<remarks>
<para>If the specified add-in is not a WLL, then it is a template.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Creator">
<MemberSignature Language="C#" Value="public int Creator { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Creator" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Creator { int get(); };" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Interop.Word.AddIn.Creator" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1001)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1001)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that indicates the application in which the specified object was created. </summary>
<value>To be added.</value>
<remarks>
<para>If the specified object was created in Microsoft Word, this property returns the hexadecimal number 4D535744, which represents the string "MSWD." This value can also be represented by the constant <b>wdCreatorCode</b>.</para>
<para>The <b>Creator</b> property was primarily designed to be used on the Macintosh, where each application has a four-character creator code. For example, Microsoft Word has the creator code MSWD. For additional information about this property, consult the language reference Help included with Microsoft Office Macintosh Edition.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Delete">
<MemberSignature Language="C#" Value="public void Delete ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Delete() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.Word.AddIn.Delete" />
<MemberSignature Language="VB.NET" Value="Public Sub Delete ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void Delete();" />
<MemberSignature Language="F#" Value="abstract member Delete : unit -> unit" Usage="addIn.Delete " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(101)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deletes the specified <see cref="T:Microsoft.Office.Interop.Word.AddIn" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Index">
<MemberSignature Language="C#" Value="public int Index { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Index" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Index" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Index As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Index { int get(); };" />
<MemberSignature Language="F#" Value="member this.Index : int" Usage="Microsoft.Office.Interop.Word.AddIn.Index" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that represents the position of an item in a <see cref="T:Microsoft.Office.Interop.Word.AddIns" /> collection.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Installed">
<MemberSignature Language="C#" Value="public bool Installed { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool Installed" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Installed" />
<MemberSignature Language="VB.NET" Value="Public Property Installed As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool Installed { bool get(); void set(bool value); };" />
<MemberSignature Language="F#" Value="member this.Installed : bool with get, set" Usage="Microsoft.Office.Interop.Word.AddIn.Installed" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>set: System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns or sets a value indicating <b>True</b> if the specified add-in is installed (loaded).</summary>
<value>To be added.</value>
<remarks>
<para>Add-ins that are loaded are selected in the Templates and Add-ins dialog box (Tools menu).</para>
<para>Uninstalled add-ins are included in the <see cref="T:Microsoft.Office.Interop.Word.AddIns" /> collection. To remove a template or WLL from the <b>AddIns</b> collection, apply the <see cref="M:Microsoft.Office.Interop.Word.AddIn.Delete" /> method to the <see cref="T:Microsoft.Office.Interop.Word.AddIn" /> object (the add-in name is removed from the Templates and Add-ins dialog box). To unload all templates and WLLs, apply the <see cref="M:Microsoft.Office.Interop.Word.AddIns.Unload(System.Boolean)" /> method to the <b>AddIns</b> collection.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string this { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Name" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Name As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ default { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Office.Interop.Word.AddIn.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(0)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that indicates the name of the specified <see cref="T:Microsoft.Office.Interop.Word.AddIn" /> object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C#" Value="public object Parent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Parent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Parent { System::Object ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Interop.Word.AddIn.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1002)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(1002)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that represents the parent object of the specified <see cref="T:Microsoft.Office.Interop.Word.AddIn" /> object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public string Path { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.AddIn.Path" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Path As String" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Path { System::String ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Path : string" Usage="Microsoft.Office.Interop.Word.AddIn.Path" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(3)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>get: System.Runtime.InteropServices.DispId(3)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a value that indicates the URL to the specified <see cref="T:Microsoft.Office.Interop.Word.AddIn" /> object.</summary>
<value>To be added.</value>
<remarks>
<para>The path doesn't include a trailing forward slash character—for example, "http://MyServer". Use the <see cref="P:Microsoft.Office.Interop.Word.ApplicationClass.PathSeparator" /> property to add a trailing forward slash character even though the <b>PathSeparator</b> property defaults to a backslash (\).</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>