/
RecordSeriesCollection.xml
236 lines (236 loc) · 16.7 KB
/
RecordSeriesCollection.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
<Type Name="RecordSeriesCollection" FullName="Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection">
<TypeSignature Language="C#" Value="public class RecordSeriesCollection : IDisposable" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RecordSeriesCollection extends System.Object implements class System.IDisposable" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" />
<TypeSignature Language="VB.NET" Value="Public Class RecordSeriesCollection
Implements IDisposable" />
<TypeSignature Language="C++ CLI" Value="public ref class RecordSeriesCollection : IDisposable" />
<TypeSignature Language="F#" Value="type RecordSeriesCollection = class
 interface IDisposable" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("The Record Series is deprecated - use the routing rules list.")</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Represents a collection of all rules in the repository.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RecordSeriesCollection (Microsoft.SharePoint.SPWeb web);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.SharePoint.SPWeb web) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.#ctor(Microsoft.SharePoint.SPWeb)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (web As SPWeb)" />
<MemberSignature Language="C++ CLI" Value="public:
 RecordSeriesCollection(Microsoft::SharePoint::SPWeb ^ web);" />
<MemberSignature Language="F#" Value="new Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection : Microsoft.SharePoint.SPWeb -> Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" Usage="new Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection web" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="web" Type="Microsoft.SharePoint.SPWeb" />
</Parameters>
<Docs>
<param name="web">The Web site in which to store this <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</param>
<summary>Initializes a new instance of the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries Add (string strName, string strLocation, string strDescription, string[] rgstrMappings, string strRouter, bool fDefault);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries Add(string strName, string strLocation, string strDescription, string[] rgstrMappings, string strRouter, bool fDefault) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Add(System.String,System.String,System.String,System.String[],System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function Add (strName As String, strLocation As String, strDescription As String, rgstrMappings As String(), strRouter As String, fDefault As Boolean) As RecordSeries" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Office::RecordsManagement::RecordsRepository::RecordSeries ^ Add(System::String ^ strName, System::String ^ strLocation, System::String ^ strDescription, cli::array <System::String ^> ^ rgstrMappings, System::String ^ strRouter, bool fDefault);" />
<MemberSignature Language="F#" Value="member this.Add : string * string * string * string[] * string * bool -> Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" Usage="recordSeriesCollection.Add (strName, strLocation, strDescription, rgstrMappings, strRouter, fDefault)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="strName" Type="System.String" />
<Parameter Name="strLocation" Type="System.String" />
<Parameter Name="strDescription" Type="System.String" />
<Parameter Name="rgstrMappings" Type="System.String[]" />
<Parameter Name="strRouter" Type="System.String" />
<Parameter Name="fDefault" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="strName">The file type to which the new rule applies.</param>
<param name="strLocation">The storage location in the repository for file types that apply to the new rule.</param>
<param name="strDescription">A human-readable text description that explains the rule.</param>
<param name="rgstrMappings">The list of other file types for which the rule applies.</param>
<param name="strRouter">The custom <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object for the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> object that is added.</param>
<param name="fDefault">
<b>true</b> if this instance is to be configured as the default rule; otherwise, <b>false</b>.</param>
<summary>Adds a <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> object to the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</summary>
<returns>The newly added <b>RecordSeries</b> object.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddRouter">
<MemberSignature Language="C#" Value="public void AddRouter (string strName, string strAssembly, string strClass);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddRouter(string strName, string strAssembly, string strClass) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.AddRouter(System.String,System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub AddRouter (strName As String, strAssembly As String, strClass As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void AddRouter(System::String ^ strName, System::String ^ strAssembly, System::String ^ strClass);" />
<MemberSignature Language="F#" Value="member this.AddRouter : string * string * string -> unit" Usage="recordSeriesCollection.AddRouter (strName, strAssembly, strClass)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="strName" Type="System.String" />
<Parameter Name="strAssembly" Type="System.String" />
<Parameter Name="strClass" Type="System.String" />
</Parameters>
<Docs>
<param name="strName">The name of the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object to add.</param>
<param name="strAssembly">The assembly that stores the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object.</param>
<param name="strClass">The <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> class.</param>
<summary>Adds a custom <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object to the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Contains">
<MemberSignature Language="C#" Value="public bool Contains (string strRecordSeries);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Contains(string strRecordSeries) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Contains(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function Contains (strRecordSeries As String) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Contains(System::String ^ strRecordSeries);" />
<MemberSignature Language="F#" Value="member this.Contains : string -> bool" Usage="recordSeriesCollection.Contains strRecordSeries" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="strRecordSeries" Type="System.String" />
</Parameters>
<Docs>
<param name="strRecordSeries">The <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> object to find in the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</param>
<summary>
<b>true</b> if the given <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> object can be found in the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object; otherwise, returns <b>false</b>.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Count">
<MemberSignature Language="C#" Value="public int Count { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Count" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Count As Integer" />
<MemberSignature Language="C++ CLI" Value="public:
 property int Count { int get(); };" />
<MemberSignature Language="F#" Value="member this.Count : int" Usage="Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Count" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the total number of <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> objects in this collection.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Dispose" />
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual void Dispose();" />
<MemberSignature Language="F#" Value="abstract member Dispose : unit -> unit
override this.Dispose : unit -> unit" Usage="recordSeriesCollection.Dispose " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases all unmanaged resources that are used by the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries this[int index] { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries Item(int32)" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Item(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Item(index As Integer) As RecordSeries" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::RecordsManagement::RecordsRepository::RecordSeries ^ default[int] { Microsoft::Office::RecordsManagement::RecordsRepository::RecordSeries ^ get(int index); };" />
<MemberSignature Language="F#" Value="member this.Item(int) : Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" Usage="Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.Item" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">Index into the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</param>
<summary>Gets the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeries" /> object at the specified <paramref name="index" />.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveRouter">
<MemberSignature Language="C#" Value="public void RemoveRouter (string strName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void RemoveRouter(string strName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection.RemoveRouter(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub RemoveRouter (strName As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void RemoveRouter(System::String ^ strName);" />
<MemberSignature Language="F#" Value="member this.RemoveRouter : string -> unit" Usage="recordSeriesCollection.RemoveRouter strName" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Policy</AssemblyName>
<AssemblyVersion>15.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="strName" Type="System.String" />
</Parameters>
<Docs>
<param name="strName">The <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object to remove.</param>
<summary>Removes the specified <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.Router" /> object from the <see cref="T:Microsoft.Office.RecordsManagement.RecordsRepository.RecordSeriesCollection" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>