-
Notifications
You must be signed in to change notification settings - Fork 13
/
ScopeFolder.xml
240 lines (240 loc) · 16 KB
/
ScopeFolder.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
<Type Name="ScopeFolder" FullName="Microsoft.Office.Core.ScopeFolder">
<TypeSignature Language="C++ CLI" Value="public interface class ScopeFolder : Microsoft::Office::Core::_IMsoDispObj" />
<TypeSignature Language="C#" Value="public interface ScopeFolder : Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract ScopeFolder implements class Microsoft.Office.Core._IMsoDispObj" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Core.ScopeFolder" />
<TypeSignature Language="VB.NET" Value="Public Interface ScopeFolder
Implements _IMsoDispObj" />
<TypeSignature Language="F#" Value="type ScopeFolder = 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("000C0368-0000-0000-C000-000000000046")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.Guid("000C0368-0000-0000-C000-000000000046")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.InteropServices.TypeLibType(4160)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.InteropServices.TypeLibType(4160)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Corresponds to a searchable folder.</summary>
<remarks>
<para>
<b>ScopeFolder</b> objects are intended for use with the <see cref="T:Microsoft.Office.Core.SearchFolders" /> collection. The <b>SearchFolders</b> collection defines the folders that are searched when using the <see cref="T:Microsoft.Office.Core.FileSearch" /> object. When you want to search specific folders, you can use the methods and properties of the <see cref="T:Microsoft.Office.Core.SearchScope" /> object and the <see cref="T:Microsoft.Office.Core.ScopeFolders" /> collection to retrieve <b>ScopeFolder</b> objects and add them to the <b>SearchFolders</b> collection.</para>
<para>Use the <see cref="P:Microsoft.Office.Core.SearchScope.ScopeFolder" /> property of the <b>SearchScope</b> object to return the root <b>ScopeFolder</b> object of a search scope.</para>
<para>Use the <see cref="P:Microsoft.Office.Core.ScopeFolders.Item(System.Int32)" /> method of the <b>ScopeFolders</b> collection to return a subfolder of a root <b>ScopeFolder</b> object, or a folder that will be searched the next time the <see cref="M:Microsoft.Office.Core.FileSearch.Execute(Microsoft.Office.Core.MsoSortBy,Microsoft.Office.Core.MsoSortOrder,System.Boolean)" /> method of the <b>FileSearch</b> object is called.</para>
<para>In each <b>ScopeFolder</b> object there is a <b>ScopeFolders</b> collection that contains the subfolders of the parent <b>ScopeFolder</b> object. You can traverse the entire folder structure of a search scope (for example, all local drives) by looping through these <b>ScopeFolders</b> collections and returning all of the lower-level <b>ScopeFolder</b> objects. A <b>ScopeFolder</b> object with no subfolders contains an empty <b>ScopeFolders</b> collection.</para>
<para>You can use the <see cref="M:Microsoft.Office.Core.SearchFolders.Add(Microsoft.Office.Core.ScopeFolder)" /> method of the <b>SearchFolders</b> collection to add a <b>ScopeFolder</b> object to the <b>SearchFolders</b> collection; however, it is usually simpler to use the <see cref="M:Microsoft.Office.Core.ScopeFolder.AddToSearchFolders" /> method of the <b>ScopeFolder</b> that you want to add, because there is only one <b>SearchFolders</b> collection for all searches.</para>
<para />
</remarks>
</Docs>
<Members>
<Member MemberName="AddToSearchFolders">
<MemberSignature Language="C++ CLI" Value="public:
 void AddToSearchFolders();" />
<MemberSignature Language="C#" Value="public void AddToSearchFolders ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void AddToSearchFolders() runtime managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Core.ScopeFolder.AddToSearchFolders" />
<MemberSignature Language="VB.NET" Value="Public Sub AddToSearchFolders ()" />
<MemberSignature Language="F#" Value="abstract member AddToSearchFolders : unit -> unit" Usage="scopeFolder.AddToSearchFolders " />
<MemberType>Method</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.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Adds a <see cref="T:Microsoft.Office.Core.ScopeFolder" /> object the <see cref="T:Microsoft.Office.Core.SearchFolders" /> collection.</summary>
<remarks>
<para>Although you can use the <b>SearchFolders</b> collection's <see cref="M:Microsoft.Office.Core.SearchFolders.Add(Microsoft.Office.Core.ScopeFolder)" /> method to add a <b>ScopeFolder</b> object to the <b>SearchFolders</b> collection, it is usually simpler to use the <b>AddToSearchFolders</b> method of the <b>ScopeFolder</b> object that you want to add, because there is only one <b>SearchFolders</b> collection for all searches.</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.ScopeFolder.Application" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Object" />
<MemberSignature Language="F#" Value="member this.Application : obj" Usage="Microsoft.Office.Core.ScopeFolder.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="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.ScopeFolder.Creator" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
<MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Core.ScopeFolder.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 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.ScopeFolder.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="Name">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ default { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string this { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.ScopeFolder.Name" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Office.Core.ScopeFolder.Name" />
<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.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns the name of the specified object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Path { System::String ^ get(); };" />
<MemberSignature Language="C#" Value="public string Path { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Path" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.ScopeFolder.Path" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Path As String" />
<MemberSignature Language="F#" Value="member this.Path : string" Usage="Microsoft.Office.Core.ScopeFolder.Path" />
<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.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a <b>String</b> indicating the full path of a <see cref="T:Microsoft.Office.Core.ScopeFolder" /> object.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ScopeFolders">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Core::ScopeFolders ^ ScopeFolders { Microsoft::Office::Core::ScopeFolders ^ get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.Office.Core.ScopeFolders ScopeFolders { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Core.ScopeFolders ScopeFolders" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Core.ScopeFolder.ScopeFolders" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ScopeFolders As ScopeFolders" />
<MemberSignature Language="F#" Value="member this.ScopeFolders : Microsoft.Office.Core.ScopeFolders" Usage="Microsoft.Office.Core.ScopeFolder.ScopeFolders" />
<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>Microsoft.Office.Core.ScopeFolders</ReturnType>
</ReturnValue>
<Docs>
<summary>Returns a <see cref="T:Microsoft.Office.Core.ScopeFolders" /> collection.</summary>
<value>To be added.</value>
<remarks>
<para>The items in this collection correspond to the subfolders of the parent <see cref="T:Microsoft.Office.Core.ScopeFolder" /> object.</para>
<para />
</remarks>
</Docs>
</Member>
</Members>
</Type>