-
Notifications
You must be signed in to change notification settings - Fork 13
/
DocumentLibraryVersion.xml
388 lines (388 loc) · 22.8 KB
/
DocumentLibraryVersion.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
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
<Type Name="DocumentLibraryVersion" FullName="Microsoft.Office.Core.DocumentLibraryVersion">
<TypeSignature Language="C++ CLI" Value="public interface class DocumentLibraryVersion : Microsoft::Office::Core::_IMsoDispObj" />
<TypeSignature Language="C#" Value="public interface DocumentLibraryVersion : Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract DocumentLibraryVersion implements class Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.DocumentLibraryVersion" />
<TypeSignature Language="VB.NET" Value="Public Interface DocumentLibraryVersion
Implements _IMsoDispObj" />
<TypeSignature Language="F#" Value="type DocumentLibraryVersion = interface
 interface _IMsoDispObj" />
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Office.Core._IMsoDispObj</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.Guid("000C0387-0000-0000-C000-000000000046")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("000C0387-0000-0000-C000-000000000046")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibType(4288)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibType(4288)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>The <b>DocumentLibraryVersion</b> object represents a single saved version of a shared document that has versioning enabled and that is stored in a document library on the server.</summary>
<remarks>
<para>Each <b>DocumentLibraryVersion</b> object is a member of the active document's <see cref="T:Microsoft.Office.Core.DocumentLibraryVersions" /> collection.</para>
<para>Each <b>DocumentLibraryVersion</b> object represents one saved version of the active document. When versioning is enabled, a new version is created on the server when the actions listed below occur; additional versions are not created each time the user saves changes to the open document.</para>
<list type="bullet">
<item>
<para>Check In.</para>
</item>
<item>
<para>Save - A new version is created on the server when the user first saves the document after opening it. Additional changes saved while the document is open apply to the same version.</para>
</item>
<item>
<para>Restore.</para>
</item>
<item>
<para>Upload.</para>
</item>
</list>
<para>Use the <see cref="P:Microsoft.Office.Core.DocumentLibraryVersion.Modified" />, <see cref="P:Microsoft.Office.Core.DocumentLibraryVersion.ModifiedBy" />, and <see cref="P:Microsoft.Office.Core.DocumentLibraryVersion.Comments" /> properties to return information about a saved version of a shared document.</para>
<para>Use the <see cref="M:Microsoft.Office.Core.DocumentLibraryVersion.Open" /> method to open a previous version, or the <see cref="M:Microsoft.Office.Core.DocumentLibraryVersion.Restore" /> method to restore a previous version in place of the current version. Use the <see cref="M:Microsoft.Office.Core.DocumentLibraryVersion.Delete" /> method to delete a version.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Application">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Application { System::Object ^ get(); };" />
<MemberSignature Language="C#" Value="public object Application { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Application" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Object" />
<MemberSignature Language="F#" Value="member this.Application : obj" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Application" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Office.Core._IMsoDispObj.Application</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743808)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743808)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(1610743808)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(1610743808)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>Application</b> object that represents the container application for the object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Comments">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Comments { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string Comments { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Comments" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Comments" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Comments As String" />
<MemberSignature Language="F#" Value="member this.Comments : string" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Comments" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(4)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(4)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(4)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(4)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns any optional comments associated with the specified version of the shared document.</summary>
<value>To be added.</value>
<remarks>
<para>A user can attach version comments through the document library user interface when checking in a document that was previously checked out.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Creator">
<MemberSignature Language="C++ CLI" Value="public:
 property int Creator { int get(); };" />
<MemberSignature Language="C#" Value="public int Creator { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Creator" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Creator" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Office.Core._IMsoDispObj.Creator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743809)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743809)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(1610743809)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(1610743809)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a 32-bit integer that indicates the application in which the specified object was created.</summary>
<value>To be added.</value>
<remarks>
<para>If the object was created in Microsoft Word, this property returns 1297307460, which represents the string MSWD; in Microsoft Excel, this property returns 1480803660. This value can also be represented by the constant <b>wdCreatorCode</b> in Word, or <b>xlCreatorCode</b> in Excel.</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>The <b>Creator</b> property always returns the numeric identifier for the active application, just as the <see cref="P:Microsoft.Office.Core.DocumentLibraryVersion.Application" /> property always returns the name of the active application in string form. Use the <b>CreatedBy</b> property of the <see cref="T:Microsoft.Office.Core.SharedWorkspaceFile" />, <see cref="T:Microsoft.Office.Core.SharedWorkspaceFolder" />, <see cref="T:Microsoft.Office.Core.SharedWorkspaceLink" />, and <see cref="T:Microsoft.Office.Core.SharedWorkspaceTask" /> objects to return the name of the individual who created those objects. Use document properties to return information about the authors of Office documents.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Delete">
<MemberSignature Language="C++ CLI" Value="public:
 void 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.Core.DocumentLibraryVersion.Delete" />
<MemberSignature Language="VB.NET" Value="Public Sub Delete ()" />
<MemberSignature Language="F#" Value="abstract member Delete : unit -> unit" Usage="documentLibraryVersion.Delete " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(5)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(5)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Removes a document library version from the <see cref="T:Microsoft.Office.Core.DocumentLibraryVersions" /> collection.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Index">
<MemberSignature Language="C++ CLI" Value="public:
 property int Index { int get(); };" />
<MemberSignature Language="C#" Value="public int Index { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Index" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Index" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Index As Integer" />
<MemberSignature Language="F#" Value="member this.Index : int" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Index" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(1)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>Integer</b> representing the index number for an object in the collection.</summary>
<value>To be added.</value>
<remarks>
<para>The position of the first command bar control is 1. Separators are not counted in the <see cref="T:Microsoft.Office.Core.CommandBarControls" /> collection.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Modified">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ default { System::Object ^ get(); };" />
<MemberSignature Language="C#" Value="public object this { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Modified" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Modified" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Modified As Object" />
<MemberSignature Language="F#" Value="member this.Modified : obj" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Modified" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(0)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(0)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(0)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the date and time at which the specified version of the shared document was last saved to the server.</summary>
<value>To be added.</value>
<remarks>
<para>A new version is created on the server each time a user opens the document and is updated when the user saves changes; additional versions are not created each time the user saves changes to the open document. The <b>Modified</b> property of the active document version represents the last time the user saved changes to the open document.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="ModifiedBy">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ModifiedBy { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string ModifiedBy { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ModifiedBy" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.ModifiedBy" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ModifiedBy As String" />
<MemberSignature Language="F#" Value="member this.ModifiedBy : string" Usage="Microsoft.Office.Core.DocumentLibraryVersion.ModifiedBy" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(3)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(3)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(3)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(3)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the name of the user who last saved the specified version of the shared document to the server.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C++ CLI" Value="public:
 System::Object ^ Open();" />
<MemberSignature Language="C#" Value="public object Open ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Open() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.DocumentLibraryVersion.Open" />
<MemberSignature Language="VB.NET" Value="Public Function Open () As Object" />
<MemberSignature Language="F#" Value="abstract member Open : unit -> obj" Usage="documentLibraryVersion.Open " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(6)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(6)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Opens the specified version of the shared document from the <see cref="T:Microsoft.Office.Core.DocumentLibraryVersions" /> collection in read-only mode.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Object ^ Parent { System::Object ^ get(); };" />
<MemberSignature Language="C#" Value="public object Parent { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Parent" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentLibraryVersion.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Core.DocumentLibraryVersion.Parent" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(2)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(2)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[get: System.Runtime.InteropServices.DispId(2)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.DispId(2)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the parent object for the specified object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Restore">
<MemberSignature Language="C++ CLI" Value="public:
 System::Object ^ Restore();" />
<MemberSignature Language="C#" Value="public object Restore ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance object Restore() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.DocumentLibraryVersion.Restore" />
<MemberSignature Language="VB.NET" Value="Public Function Restore () As Object" />
<MemberSignature Language="F#" Value="abstract member Restore : unit -> obj" Usage="documentLibraryVersion.Restore " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(7)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(7)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Restores a previous saved version of a shared document from the <see cref="T:Microsoft.Office.Core.DocumentLibraryVersions" /> collection.</summary>
<returns>To be added.</returns>
<remarks>
<para>Use the <b>Restore</b> method to return to an earlier saved version of the active document. The <b>Restore</b> method does several things:</para>
<list type="number">
<item>
<description>It changes the open version of the shared document to read-only mode but leaves it open.</description>
</item>
<item>
<description>It opens the restored version in read/write mode.</description>
</item>
<item>
<description>It saves the restored version to the server as a new document version, making the restored version the latest version.</description>
</item>
</list>
<para>The <b>Restore</b> method raises a run-time error if the active document has changes that have not been saved.</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>