-
Notifications
You must be signed in to change notification settings - Fork 8
/
Errors.xml
274 lines (274 loc) · 19.3 KB
/
Errors.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
<Type Name="Errors" FullName="Microsoft.Office.Interop.InfoPath.SemiTrust.Errors">
<TypeSignature Language="C#" Value="public interface Errors" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract Errors" />
<TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors" />
<TypeSignature Language="VB.NET" Value="Public Interface Errors" />
<TypeSignature Language="C++ CLI" Value="public interface class Errors" />
<TypeSignature Language="F#" Value="type Errors = interface" />
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.Guid("096cd578-0786-11d1-95fa-0080c78ee3bb")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Runtime.InteropServices.InterfaceType(System.Runtime.InteropServices.ComInterfaceType.InterfaceIsDual)</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>This type is a wrapper for a COM interface implemented by a coclass that is required by managed code for COM interoperability. To access the members specified by this interface, use the type that wraps the coclass that implements this interface. For information about that type, including usage, remarks, and examples, see<see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" />.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject Add (object varNode, string bstrConditionName, string bstrShortErrorMessage, string bstrDetailedErrorMessage, int lErrorCode, string bstrType);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject Add(object varNode, string bstrConditionName, string bstrShortErrorMessage, string bstrDetailedErrorMessage, int32 lErrorCode, string bstrType) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Add(System.Object,System.String,System.String,System.String,System.Int32,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function Add (varNode As Object, bstrConditionName As String, bstrShortErrorMessage As String, bstrDetailedErrorMessage As String, lErrorCode As Integer, bstrType As String) As ErrorObject" />
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::Office::Interop::InfoPath::SemiTrust::ErrorObject ^ Add(System::Object ^ varNode, System::String ^ bstrConditionName, System::String ^ bstrShortErrorMessage, System::String ^ bstrDetailedErrorMessage, int lErrorCode, System::String ^ bstrType);" />
<MemberSignature Language="F#" Value="abstract member Add : obj * string * string * string * int * string -> Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" Usage="errors.Add (varNode, bstrConditionName, bstrShortErrorMessage, bstrDetailedErrorMessage, lErrorCode, bstrType)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(2)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="varNode" Type="System.Object" />
<Parameter Name="bstrConditionName" Type="System.String" />
<Parameter Name="bstrShortErrorMessage" Type="System.String" />
<Parameter Name="bstrDetailedErrorMessage" Type="System.String" />
<Parameter Name="lErrorCode" Type="System.Int32" />
<Parameter Name="bstrType" Type="System.String" />
</Parameters>
<Docs>
<param name="varNode">The XML node that the error will be associated with.</param>
<param name="bstrConditionName">The name of the error.</param>
<param name="bstrShortErrorMessage">The short message for the error.</param>
<param name="bstrDetailedErrorMessage">The detailed message for the error.</param>
<param name="lErrorCode">The error code of the error.</param>
<param name="bstrType">Default value is "modeless". The type of error processing. The other supported value is "modal".</param>
<summary>Adds an <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> to <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> and returns a reference to the new <b>Error</b> object.</summary>
<returns>An <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> object which represents the newly created <b>Error</b>.</returns>
<remarks>
<para>The <b>Add</b> method is used to create custom error messages in a Microsoft InfoPath form. There are two types of errors that can be created using the <b>Add</b> method:</para>
<list type="table">
<item>
<term>modeless</term>
<description>The user is notified of the error with an inline alert and can choose to return to the previous value with an undo operation</description>
</item>
<item>
<term>modal</term>
<description>The user is notified of the error with a dialog box alert. After clicking OK in the dialog box alert, the error will appear as an inline alert and the user can choose to return to the previous value with an undo operation</description>
</item>
</list>
<para>
<b>Note</b>: Custom errors can also be created using the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.DataDOMEvent.ReportError(System.Object,System.String,System.Boolean,System.String,System.Int32,System.String)" /> method.</para>
<para>
<b>Important</b>: This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.</para>
<para />
</remarks>
<example>
<code>//Add an error to the node
IXMLDOMDocument myDOM = thisXDocument.DOM;
IXMLDOMNode myNode = myDOM.selectSingleNode("my:myFields/my:aGroup/my:field1");
thisXDocument.Errors.<span class="label">Add</span>(myNode,"condition","short","detail",102057,"modeless");</code>
</example>
</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.Interop.InfoPath.SemiTrust.Errors.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.Interop.InfoPath.SemiTrust.Errors.Count" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(1)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a count of the number of <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> objects contained in the collection.</summary>
<value>To be added.</value>
<remarks>
<para>
<b>Important</b>: This member can be accessed without restrictions.</para>
<para />
</remarks>
<example>
<para>In the following example, the <b>Count</b> property is used to iterate through the collection of <b>Error</b> objects and display a message box indicating the short error message of each error:</para>
<code>for (int i=0; i &lt; thisXDocument.Errors.<span class="label">Count</span>; i++)
{
thisXDocument.UI.Alert("Error message: " + thisXDocument.Errors[i].ShortErrorMessage);
}</code>
</example>
</Docs>
</Member>
<Member MemberName="Delete">
<MemberSignature Language="C#" Value="public void Delete (object varNode, string bstrConditionName);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Delete(object varNode, string bstrConditionName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Delete(System.Object,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub Delete (varNode As Object, bstrConditionName As String)" />
<MemberSignature Language="C++ CLI" Value="public:
 void Delete(System::Object ^ varNode, System::String ^ bstrConditionName);" />
<MemberSignature Language="F#" Value="abstract member Delete : obj * string -> unit" Usage="errors.Delete (varNode, bstrConditionName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(3)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="varNode" Type="System.Object" />
<Parameter Name="bstrConditionName" Type="System.String" />
</Parameters>
<Docs>
<param name="varNode">The XML Document Object Model (DOM) node associated with the error.</param>
<param name="bstrConditionName">The name of the error.</param>
<summary>Deletes the specified <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> object from the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> collection.</summary>
<remarks>
<para>The <b>Delete</b> method deletes all the <b>Error</b> objects in the <b>Errors</b> collection that are associated with the specified XML node and that have the same name. To delete all of the <b>Error</b> objects contained in the <b>Errors</b> collection, use the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.DeleteAll" /> method.</para>
<para>
<b>Note</b>: The <b>Delete</b> method will only delete errors that were created using the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Add(System.Object,System.String,System.String,System.String,System.Int32,System.String)" /> method. It cannot be used to delete errors that occur because of schema or data validation constraints, or errors that were created using the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.DataDOMEvent.ReportError(System.Object,System.String,System.Boolean,System.String,System.Int32,System.String)" /> method.</para>
<para>
<b>Important</b>: This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.</para>
<para />
</remarks>
<example>
<code>//Delete the errors associated with a specific node
IXMLDOMDocument myDOM = thisXDocument.DOM;
IXMLDOMNode myNode = myDOM.selectSingleNode("my:myFields/my:aGroup/my:field1");
thisXDocument.Errors.<span class="label">Delete</span>(myNode,thisXDocument.Errors[0].ConditionName.ToString());</code>
</example>
</Docs>
</Member>
<Member MemberName="DeleteAll">
<MemberSignature Language="C#" Value="public void DeleteAll ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void DeleteAll() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.DeleteAll" />
<MemberSignature Language="VB.NET" Value="Public Sub DeleteAll ()" />
<MemberSignature Language="C++ CLI" Value="public:
 void DeleteAll();" />
<MemberSignature Language="F#" Value="abstract member DeleteAll : unit -> unit" Usage="errors.DeleteAll " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(4)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Deletes all of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> objects contained in the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> collection.</summary>
<remarks>
<para>To delete a specific <b>Error</b> object from the <b>Errors</b> collection, use the <b>Delete</b> method.</para>
<para>
<b>Note</b>: Unlike the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Delete(System.Object,System.String)" /> method that will only delete errors that were created using the <see cref="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Add(System.Object,System.String,System.String,System.String,System.Int32,System.String)" /> method, the <b>DeleteAll</b> method will delete all errors in the collection, regardless of how they were created.</para>
<para>
<b>Important</b>: This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.</para>
<para />
</remarks>
<example>
<para>In the following example, the <b>DeleteAll</b> method of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> collection is used to delete all the errors that it contains:</para>
<code>thisXDocument.Errors.<span class="label">DeleteAll</span>();</code>
</example>
</Docs>
</Member>
<Member MemberName="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() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.GetEnumerator" />
<MemberSignature Language="VB.NET" Value="Public Function GetEnumerator () As IEnumerator" />
<MemberSignature Language="C++ CLI" Value="public:
 System::Collections::IEnumerator ^ GetEnumerator();" />
<MemberSignature Language="F#" Value="abstract member GetEnumerator : unit -> System.Collections.IEnumerator" Usage="errors.GetEnumerator " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets an <b>IEnumerator</b> that iterates over all entries in the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> object.</summary>
<returns>An IEnumerator that iterates over all entries in the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> object.</returns>
<remarks>
<para>
<b>Important</b>: This member can be accessed only by forms running in the same domain as the currently open form, or by forms that have been granted cross-domain permissions.</para>
<para />
</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject this[int index] { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject Item(int32)" />
<MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Item(System.Int32)" />
<MemberSignature Language="VB.NET" Value="Default Public ReadOnly Property Item(index As Integer) As ErrorObject" />
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Office::Interop::InfoPath::SemiTrust::ErrorObject ^ default[int] { Microsoft::Office::Interop::InfoPath::SemiTrust::ErrorObject ^ get(int index); };" />
<MemberSignature Language="F#" Value="member this.Item(int) : Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" Usage="Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Item" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Office.Interop.InfoPath.SemiTrust</AssemblyName>
<AssemblyVersion>11.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.Runtime.InteropServices.DispId(0)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="index">An expression that specifies the position of a member of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> collection The argument must be a number from 0 to the value of the <see cref="P:Microsoft.Office.Interop.InfoPath.SemiTrust.Errors.Count" /> property minus 1.</param>
<summary>Gets a reference to the specified <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorObject" /> object from the collection.</summary>
<value>To be added.</value>
<remarks>
<para>If the value provided for the <paramref name="index" /> argument does not match any existing member of the collection, an error occurs.</para>
<para>After you have set a reference to the <b>Error</b> object that the <b>Item</b> method returns, you can access any of its properties or methods.</para>
<para>
<b>Important</b>: This member can be accessed without restrictions.</para>
<para />
</remarks>
<example>
<para>Because the <b>Item</b> property is the default property of the <see cref="T:Microsoft.Office.Interop.InfoPath.SemiTrust.ErrorsCollection" /> collection, it can be used as follows:</para>
<code>Error nextError = thisXDocument.Errors[i];</code>
</example>
</Docs>
</Member>
</Members>
</Type>