-
Notifications
You must be signed in to change notification settings - Fork 13
/
DocumentProperties.xml
259 lines (259 loc) · 17.6 KB
/
DocumentProperties.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
<Type Name="DocumentProperties" FullName="Microsoft.Office.Core.DocumentProperties">
<TypeSignature Language="C++ CLI" Value="public interface class DocumentProperties : System::Collections::IEnumerable" />
<TypeSignature Language="C#" Value="public interface DocumentProperties : System.Collections.IEnumerable" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract DocumentProperties implements class System.Collections.IEnumerable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.DocumentProperties" />
<TypeSignature Language="VB.NET" Value="Public Interface DocumentProperties
Implements IEnumerable" />
<TypeSignature Language="F#" Value="type DocumentProperties = interface
 interface IEnumerable" />
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.Guid("2DF8D04D-5BFA-101B-BDE5-00AA0044DE52")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("2DF8D04D-5BFA-101B-BDE5-00AA0044DE52")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibType(4096)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibType(4096)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>A collection of <see cref="T:Microsoft.Office.Core.DocumentProperty" /> objects.</summary>
<remarks>
<para>Each <b>DocumentProperty</b> object represents a built-in or custom property of a container document.</para>
<para>Use the <see cref="M:Microsoft.Office.Core.DocumentProperties.Add(System.String,System.Boolean,System.Object,System.Object,System.Object)" /> method to create a new custom property and add it to the <b>DocumentProperties</b> collection. You cannot use the <b>Add</b> method to create a built-in document property.</para>
<para>Use <b>BuiltinDocumentProperties</b>(<paramref name="index" />), where <paramref name="index" /> is the index number of the built-in document property, to return a single <b>DocumentProperty</b> object that represents a specific built-in document property. Use <b>CustomDocumentProperties</b>(<paramref name="index" />), where <paramref name="index" /> is the number of the custom document property, to return a <b>DocumentProperty</b> object that represents a specific custom document property.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.DocumentProperty Add (string Name, bool LinkToContent, object Type, object Value, object LinkSource);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Office.Core.DocumentProperty Add([in]string Name, [in]bool LinkToContent, [in]object Type, [in]object Value, [in]object LinkSource) runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.DocumentProperties.Add(System.String,System.Boolean,System.Object,System.Object,System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Function Add (Name As String, LinkToContent As Boolean, Optional Type As Object, Optional Value As Object, Optional LinkSource As Object) As DocumentProperty" />
<MemberSignature Language="F#" Value="abstract member Add : string * bool * obj * obj * obj -> Microsoft.Office.Core.DocumentProperty" Usage="documentProperties.Add (Name, LinkToContent, Type, Value, LinkSource)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.LCIDConversion(5)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.LCIDConversion(5)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Core.DocumentProperty</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="Name" Type="System.String" />
<Parameter Name="LinkToContent" Type="System.Boolean" />
<Parameter Name="Type" Type="System.Object" />
<Parameter Name="Value" Type="System.Object" />
<Parameter Name="LinkSource" Type="System.Object" />
</Parameters>
<Docs>
<param name="Name">Required <b>String</b>. The name of the property.</param>
<param name="LinkToContent">Required <b>Boolean</b>. Specifies whether the property is linked to the contents of the container document. If this argument is <b>True</b>, the <paramref name="LinkSource" /> argument is required; if it's <b>False</b>, the value argument is required.</param>
<param name="Type">Optional <b>Object</b>. The data type of the property. Can be one of the following <see cref="T:Microsoft.Office.Core.MsoDocProperties" /> constants: <b>msoPropertyTypeBoolean</b>, <b>msoPropertyTypeDate</b>, <b>msoPropertyTypeFloat</b>, <b>msoPropertyTypeNumber</b>, or <b>msoPropertyTypeString</b>.</param>
<param name="Value">Optional <b>Object</b>. The value of the property, if it's not linked to the contents of the container document. The value is converted to match the data type specified by the type argument. If it can't be converted, an error occurs. If <paramref name="LinkToContent" /> is <b>True</b>, the <paramref name="Value" /> argument is ignored and the new document property is assigned a default value until the linked property values are updated by the container application (usually when the document is saved).</param>
<param name="LinkSource">Optional <b>Object</b>. Ignored if <paramref name="LinkToContent" /> is <b>False</b>. The source of the linked property. The container application determines what types of source linking you can use.</param>
<summary>Creates a new custom document property.</summary>
<returns>To be added.</returns>
<remarks>
<para>If you add a custom document property to the <see cref="T:Microsoft.Office.Core.DocumentProperties" /> collection that’s linked to a given value in a Microsoft Office document, you must save the document to see the change to the <see cref="T:Microsoft.Office.Core.DocumentProperty" /> object.</para>
<para>You can only add a new document property to the custom <b>DocumentProperties</b> collection.</para>
<para />
</remarks>
</Docs>
</Member>
<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.DocumentProperties.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Object" />
<MemberSignature Language="F#" Value="member this.Application : obj" Usage="Microsoft.Office.Core.DocumentProperties.Application" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743813)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743813)>]</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="Count">
<MemberSignature Language="C++ CLI" Value="public:
 property int Count { int get(); };" />
<MemberSignature Language="C#" Value="public int Count { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentProperties.Count" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Count As Integer" />
<MemberSignature Language="F#" Value="member this.Count : int" Usage="Microsoft.Office.Core.DocumentProperties.Count" />
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns an <b>Integer</b> indicating the number of items in the specified collection.</summary>
<value>To be added.</value>
<remarks>To be added.</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.DocumentProperties.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Core.DocumentProperties.Creator" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.DispId(1610743814)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.DispId(1610743814)>]</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 specified object was created in Microsoft Word, this property returns 1297307460, which represents the string MSWD; if created 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.DocumentProperties.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="GetEnumerator">
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::IEnumerator ^ GetEnumerator();" />
<MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Collections.IEnumerator GetEnumerator() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.DocumentProperties.GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Public Function GetEnumerator () As IEnumerator" />
<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -> System.Collections.IEnumerator" Usage="documentProperties.GetEnumerator " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Collections.IEnumerable.GetEnumerator</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>office</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibFunc(1024)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibFunc(1024)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Core::DocumentProperty ^ default[System::Object ^] { Microsoft::Office::Core::DocumentProperty ^ get(System::Object ^ Index); };" />
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.DocumentProperty this[object Index] { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Core.DocumentProperty Item(object)" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.DocumentProperties.Item(System.Object)" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Item(Index As Object) As DocumentProperty" />
<MemberSignature Language="F#" Value="member this.Item(obj) : Microsoft.Office.Core.DocumentProperty" Usage="Microsoft.Office.Core.DocumentProperties.Item" />
<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.LCIDConversion(1)]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.InteropServices.LCIDConversion(1)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Core.DocumentProperty</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="Index" Type="System.Object" />
</Parameters>
<Docs>
<param name="Index">Required <b>Object</b>. The name or index number of the document property returned.</param>
<summary>Returns a <see cref="T:Microsoft.Office.Core.DocumentProperty" /> object from the <see cref="T:Microsoft.Office.Core.DocumentProperties" /> collection.</summary>
<value>To be added.</value>
<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.DocumentProperties.Parent" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
<MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Core.DocumentProperties.Parent" />
<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>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the <b>Parent</b> object for the specified object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>