-
Notifications
You must be signed in to change notification settings - Fork 41
/
ConventionAnnotatableExtensions.xml
134 lines (134 loc) · 11.9 KB
/
ConventionAnnotatableExtensions.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
<Type Name="ConventionAnnotatableExtensions" FullName="Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions">
<TypeSignature Language="C#" Value="public static class ConventionAnnotatableExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit ConventionAnnotatableExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module ConventionAnnotatableExtensions" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<TypeSignature Language="F#" Value="type ConventionAnnotatableExtensions = class" />
<TypeSignature Language="VB.NET" Value="Public Class ConventionAnnotatableExtensions" FrameworkAlternate="efcore-6.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="efcore-6.0">
<AttributeName Language="C#">[System.Obsolete("Use IConventionAnnotatable")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IConventionAnnotatable")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Extension methods for <see cref="T:Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddAnnotations">
<MemberSignature Language="C#" Value="public static void AddAnnotations (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation> annotations, bool fromDataAnnotation = false);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddAnnotations(class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, class System.Collections.Generic.IEnumerable`1<class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation> annotations, bool fromDataAnnotation) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.AddAnnotations(Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable,System.Collections.Generic.IEnumerable{Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation},System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub AddAnnotations (annotatable As IConventionAnnotatable, annotations As IEnumerable(Of IConventionAnnotation), Optional fromDataAnnotation As Boolean = false)" />
<MemberSignature Language="F#" Value="static member AddAnnotations : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * seq<Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation> * bool -> unit" Usage="Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.AddAnnotations (annotatable, annotations, fromDataAnnotation)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotatable" Type="Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="annotations" Type="System.Collections.Generic.IEnumerable<Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation>" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="2" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
</Parameters>
<Docs>
<param name="annotatable"> The object to add the annotations to. </param>
<param name="annotations"> The annotations to be added. </param>
<param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
<summary>
Adds annotations to an object.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAnnotation">
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation GetAnnotation (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string annotationName);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation GetAnnotation(class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string annotationName) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.GetAnnotation(Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetAnnotation (annotatable As IConventionAnnotatable, annotationName As String) As IConventionAnnotation" />
<MemberSignature Language="F#" Value="static member GetAnnotation : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * string -> Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation" Usage="Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.GetAnnotation (annotatable, annotationName)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotatable" Type="Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="annotationName" Type="System.String" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
</Parameters>
<Docs>
<param name="annotatable"> The object to find the annotation on. </param>
<param name="annotationName"> The key of the annotation to find. </param>
<summary>
Gets the annotation with the given name, throwing if it does not exist.
</summary>
<returns> The annotation with the specified name. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SetOrRemoveAnnotation">
<MemberSignature Language="C#" Value="public static void SetOrRemoveAnnotation (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void SetOrRemoveAnnotation(class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation) cil managed" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="DocId" Value="M:Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.SetOrRemoveAnnotation(Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable,System.String,System.Object,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Sub SetOrRemoveAnnotation (annotatable As IConventionAnnotatable, name As String, value As Object, Optional fromDataAnnotation As Boolean = false)" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="F#" Value="static member SetOrRemoveAnnotation : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * string * obj * bool -> unit" Usage="Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.SetOrRemoveAnnotation (annotatable, name, value, fromDataAnnotation)" FrameworkAlternate="efcore-3.0;efcore-3.1" />
<MemberSignature Language="C#" Value="public static Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation SetOrRemoveAnnotation (this Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation = false);" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation SetOrRemoveAnnotation(class Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable annotatable, string name, object value, bool fromDataAnnotation) cil managed" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function SetOrRemoveAnnotation (annotatable As IConventionAnnotatable, name As String, value As Object, Optional fromDataAnnotation As Boolean = false) As IConventionAnnotation" FrameworkAlternate="efcore-5.0" />
<MemberSignature Language="F#" Value="static member SetOrRemoveAnnotation : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable * string * obj * bool -> Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation" Usage="Microsoft.EntityFrameworkCore.ConventionAnnotatableExtensions.SetOrRemoveAnnotation (annotatable, name, value, fromDataAnnotation)" FrameworkAlternate="efcore-5.0" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.EntityFrameworkCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType FrameworkAlternate="efcore-3.0;efcore-3.1">System.Void</ReturnType>
<ReturnType FrameworkAlternate="efcore-5.0">Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="annotatable" Type="Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable" RefType="this" Index="0" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="name" Type="System.String" Index="1" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="value" Type="System.Object" Index="2" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
<Parameter Name="fromDataAnnotation" Type="System.Boolean" Index="3" FrameworkAlternate="efcore-3.0;efcore-3.1;efcore-5.0" />
</Parameters>
<Docs>
<param name="annotatable"> The object to set the annotation for. </param>
<param name="name"> The name of the annotation to be added. </param>
<param name="value"> The value to be stored in the annotation. </param>
<param name="fromDataAnnotation"> Indicates whether the configuration was specified using a data annotation. </param>
<summary>
Sets the annotation stored under the given name. Overwrites the existing annotation if an
annotation with the specified name already exists. Removes the existing annotation if <see langword="null" /> is supplied.
</summary>
<returns> The new annotation or <see langword="null" /> if it was removed. </returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>