-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
EntityObject.xml
298 lines (281 loc) · 20.1 KB
/
EntityObject.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
<Type Name="EntityObject" FullName="System.Data.Objects.DataClasses.EntityObject">
<TypeSignature Language="C#" Value="public abstract class EntityObject : System.Data.Objects.DataClasses.StructuralObject, System.Data.Objects.DataClasses.IEntityWithChangeTracker, System.Data.Objects.DataClasses.IEntityWithKey, System.Data.Objects.DataClasses.IEntityWithRelationships" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract serializable beforefieldinit EntityObject extends System.Data.Objects.DataClasses.StructuralObject implements class System.Data.Objects.DataClasses.IEntityWithChangeTracker, class System.Data.Objects.DataClasses.IEntityWithKey, class System.Data.Objects.DataClasses.IEntityWithRelationships" />
<TypeSignature Language="DocId" Value="T:System.Data.Objects.DataClasses.EntityObject" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class EntityObject
Inherits StructuralObject
Implements IEntityWithChangeTracker, IEntityWithKey, IEntityWithRelationships" />
<TypeSignature Language="F#" Value="type EntityObject = class
 inherit StructuralObject
 interface IEntityWithKey
 interface IEntityWithChangeTracker
 interface IEntityWithRelationships" />
<TypeSignature Language="C++ CLI" Value="public ref class EntityObject abstract : System::Data::Objects::DataClasses::StructuralObject, System::Data::Objects::DataClasses::IEntityWithChangeTracker, System::Data::Objects::DataClasses::IEntityWithKey, System::Data::Objects::DataClasses::IEntityWithRelationships" />
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Data.Objects.DataClasses.StructuralObject</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Data.Objects.DataClasses.IEntityWithChangeTracker</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Data.Objects.DataClasses.IEntityWithKey</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Data.Objects.DataClasses.IEntityWithRelationships</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataContract(IsReference=true)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract(IsReference=true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Serializable]</AttributeName>
<AttributeName Language="F#">[<System.Serializable>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Base class for entity types that are generated by the Entity Data Model tools.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EntityObject ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Objects.DataClasses.EntityObject.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 EntityObject();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Data.Objects.DataClasses.EntityObject" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="EntityKey">
<MemberSignature Language="C#" Value="public System.Data.EntityKey EntityKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Data.EntityKey EntityKey" />
<MemberSignature Language="DocId" Value="P:System.Data.Objects.DataClasses.EntityObject.EntityKey" />
<MemberSignature Language="VB.NET" Value="Public Property EntityKey As EntityKey" />
<MemberSignature Language="F#" Value="member this.EntityKey : System.Data.EntityKey with get, set" Usage="System.Data.Objects.DataClasses.EntityObject.EntityKey" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Data::EntityKey ^ EntityKey { System::Data::EntityKey ^ get(); void set(System::Data::EntityKey ^ value); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Data.Objects.DataClasses.IEntityWithKey.EntityKey</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataMember]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataMember>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Data.EntityKey</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the key for this object.</summary>
<value>The <see cref="T:System.Data.EntityKey" /> for this object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Object Services uses the <xref:System.Data.Objects.DataClasses.IEntityWithKey.EntityKey%2A> property to manage objects in the object context.
You cannot set the <xref:System.Data.Objects.DataClasses.EntityObject.EntityKey%2A> property after an object is attached to an <xref:System.Data.Objects.ObjectContext>.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
<Member MemberName="EntityState">
<MemberSignature Language="C#" Value="public System.Data.EntityState EntityState { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Data.EntityState EntityState" />
<MemberSignature Language="DocId" Value="P:System.Data.Objects.DataClasses.EntityObject.EntityState" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EntityState As EntityState" />
<MemberSignature Language="F#" Value="member this.EntityState : System.Data.EntityState" Usage="System.Data.Objects.DataClasses.EntityObject.EntityState" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Data::EntityState EntityState { System::Data::EntityState get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Xml.Serialization.XmlIgnore]</AttributeName>
<AttributeName Language="F#">[<System.Xml.Serialization.XmlIgnore>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Data.EntityState</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the entity state of the object.</summary>
<value>The <see cref="T:System.Data.EntityState" /> of this object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When an object is attached to the object context, either as the result of a query or by calling <xref:System.Data.Objects.ObjectContext.Attach%2A>, the <xref:System.Data.EntityState> becomes <xref:System.Data.EntityState.Unchanged>.
When an object is detached from the object context, it returns to the <xref:System.Data.EntityState.Detached> state.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
<Member MemberName="ReportPropertyChanged">
<MemberSignature Language="C#" Value="protected override sealed void ReportPropertyChanged (string property);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void ReportPropertyChanged(string property) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Objects.DataClasses.EntityObject.ReportPropertyChanged(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub ReportPropertyChanged (property As String)" />
<MemberSignature Language="F#" Value="override this.ReportPropertyChanged : string -> unit" Usage="entityObject.ReportPropertyChanged property" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void ReportPropertyChanged(System::String ^ property);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.String" />
</Parameters>
<Docs>
<param name="property">The name of the changed property.</param>
<summary>Notifies the change tracker that a property has changed.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When an entity type is generated by the Entity Data Model tools, the <xref:System.Data.Objects.DataClasses.EntityObject.ReportPropertyChanged%2A> method is called after a property change to commit the cached value in the <xref:System.Data.Objects.DataClasses.IEntityChangeTracker> as the original value of the property.
This method calls the <xref:System.Data.Objects.DataClasses.IEntityChangeTracker.EntityMemberChanged%2A> method in the change tracker.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="property" /> is <see langword="null" />.</exception>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
<Member MemberName="ReportPropertyChanging">
<MemberSignature Language="C#" Value="protected override sealed void ReportPropertyChanging (string property);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void ReportPropertyChanging(string property) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Objects.DataClasses.EntityObject.ReportPropertyChanging(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides NotOverridable Sub ReportPropertyChanging (property As String)" />
<MemberSignature Language="F#" Value="override this.ReportPropertyChanging : string -> unit" Usage="entityObject.ReportPropertyChanging property" />
<MemberSignature Language="C++ CLI" Value="protected:
 override void ReportPropertyChanging(System::String ^ property);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="property" Type="System.String" />
</Parameters>
<Docs>
<param name="property">The name of the changing property.</param>
<summary>Notifies the change tracker that a property change is pending.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
When an entity type is generated by the Entity Data Model tools, the <xref:System.Data.Objects.DataClasses.EntityObject.ReportPropertyChanging%2A> method is called before a property change to cache the current value of the property in the <xref:System.Data.Objects.DataClasses.IEntityChangeTracker> so that this value can be used as the original value for the property.
This method calls the <xref:System.Data.Objects.DataClasses.IEntityChangeTracker.EntityMemberChanging%2A> method in the change tracker.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="property" /> is <see langword="null" />.</exception>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
<Member MemberName="System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker">
<MemberSignature Language="C#" Value="void IEntityWithChangeTracker.SetChangeTracker (System.Data.Objects.DataClasses.IEntityChangeTracker changeTracker);" />
<MemberSignature Language="ILAsm" Value=".method hidebysig newslot virtual instance void System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker(class System.Data.Objects.DataClasses.IEntityChangeTracker changeTracker) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Data.Objects.DataClasses.EntityObject.System#Data#Objects#DataClasses#IEntityWithChangeTracker#SetChangeTracker(System.Data.Objects.DataClasses.IEntityChangeTracker)" />
<MemberSignature Language="VB.NET" Value="Sub SetChangeTracker (changeTracker As IEntityChangeTracker) Implements IEntityWithChangeTracker.SetChangeTracker" />
<MemberSignature Language="F#" Value="abstract member System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker : System.Data.Objects.DataClasses.IEntityChangeTracker -> unit
override this.System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker : System.Data.Objects.DataClasses.IEntityChangeTracker -> unit" Usage="entityObject.System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker changeTracker" />
<MemberSignature Language="C++ CLI" Value=" virtual void System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker(System::Data::Objects::DataClasses::IEntityChangeTracker ^ changeTracker) = System::Data::Objects::DataClasses::IEntityWithChangeTracker::SetChangeTracker;" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:System.Data.Objects.DataClasses.IEntityWithChangeTracker.SetChangeTracker(System.Data.Objects.DataClasses.IEntityChangeTracker)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="changeTracker" Type="System.Data.Objects.DataClasses.IEntityChangeTracker" />
</Parameters>
<Docs>
<param name="changeTracker">Reference to the change tracker that is used to report property changes.</param>
<summary>Specifies the instance of <see cref="T:System.Data.Objects.DataClasses.IEntityChangeTracker" /> that is used to report property changes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This method is called by Object Services to specify the instance of <xref:System.Data.Objects.DataClasses.IEntityChangeTracker> for the object to use to track changes. This is typically called when the entity is added to or removed from an <xref:System.Data.Objects.ObjectContext>.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
<Member MemberName="System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager">
<MemberSignature Language="C#" Value="System.Data.Objects.DataClasses.RelationshipManager System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Data.Objects.DataClasses.RelationshipManager System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager" />
<MemberSignature Language="DocId" Value="P:System.Data.Objects.DataClasses.EntityObject.System#Data#Objects#DataClasses#IEntityWithRelationships#RelationshipManager" />
<MemberSignature Language="VB.NET" Value=" ReadOnly Property RelationshipManager As RelationshipManager Implements IEntityWithRelationships.RelationshipManager" />
<MemberSignature Language="F#" Value="member this.System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager : System.Data.Objects.DataClasses.RelationshipManager" Usage="System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager" />
<MemberSignature Language="C++ CLI" Value="property System::Data::Objects::DataClasses::RelationshipManager ^ System::Data::Objects::DataClasses::IEntityWithRelationships::RelationshipManager { System::Data::Objects::DataClasses::RelationshipManager ^ get(); };" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Data.Objects.DataClasses.IEntityWithRelationships.RelationshipManager</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>System.Data.Entity</AssemblyName>
<AssemblyVersion>3.5.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Data.Objects.DataClasses.RelationshipManager</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the relationship manager used by this object.</summary>
<value>The <see cref="T:System.Data.Objects.DataClasses.RelationshipManager" /> used by this object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
<xref:System.Data.Objects.DataClasses.EntityObject.System%23Data%23Objects%23DataClasses%23IEntityWithRelationships%23RelationshipManager%2A> returns a <xref:System.Data.Objects.DataClasses.RelationshipManager> used by this object. Object Services uses the relationship manager to provide access to related objects.
Classes that expose relationships must implement this property by constructing and setting <xref:System.Data.Objects.DataClasses.RelationshipManager> in their constructor. The implementation of this property should use the static method <xref:System.Data.Objects.DataClasses.RelationshipManager.Create%2A> to create a new <xref:System.Data.Objects.DataClasses.RelationshipManager> when needed. After being created, it is expected that this object will be stored on the entity and will be provided through this property.
]]></format>
</remarks>
<related type="Article" href="/dotnet/framework/data/adonet/ef/working-with-objects">Working with Objects</related>
</Docs>
</Member>
</Members>
</Type>