Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
231 lines (215 sloc) 15.7 KB
<Type Name="LocalValueEntry" FullName="System.Windows.LocalValueEntry">
<TypeSignature Language="C#" Value="public struct LocalValueEntry" />
<TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit LocalValueEntry extends System.ValueType" />
<TypeSignature Language="DocId" Value="T:System.Windows.LocalValueEntry" />
<TypeSignature Language="VB.NET" Value="Public Structure LocalValueEntry" />
<TypeSignature Language="C++ CLI" Value="public value class LocalValueEntry" />
<TypeSignature Language="F#" Value="type LocalValueEntry = struct" />
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a property identifier and the property value for a locally set dependency property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Instances of this class are returned when getting the value of the <xref:System.Windows.LocalValueEnumerator.Current%2A> property of a <xref:System.Windows.LocalValueEnumerator>. All <xref:System.Windows.LocalValueEntry> properties are read-only.
This class has no public constructor. In order to obtain instances of this class you must call <xref:System.Windows.DependencyObject.GetLocalValueEnumerator%2A>, and then get the value of <xref:System.Windows.LocalValueEnumerator.Current%2A> from the returned <xref:System.Windows.LocalValueEnumerator>.
## Examples
The following example iterates locally set values of a <xref:System.Windows.DependencyObject> and queries <xref:System.Windows.LocalValueEntry> properties.
[!code-csharp[DPClearValue#IterateLocalValuesAndClear](~/samples/snippets/csharp/VS_Snippets_Wpf/DPClearValue/CSharp/default.xaml.cs#iteratelocalvaluesandclear)]
[!code-vb[DPClearValue#IterateLocalValuesAndClear](~/samples/snippets/visualbasic/VS_Snippets_Wpf/DPClearValue/VisualBasic/default.xaml.vb#iteratelocalvaluesandclear)]
]]></format>
</remarks>
<altmember cref="T:System.Windows.LocalValueEnumerator" />
</Docs>
<Members>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.LocalValueEntry.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ obj);" />
<MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="localValueEntry.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The <see cref="T:System.Windows.LocalValueEntry" /> to compare with the current <see cref="T:System.Windows.LocalValueEntry" />.</param>
<summary>Determines whether two <see cref="T:System.Windows.LocalValueEntry" /> instances are equal.</summary>
<returns>This <see cref="M:System.Windows.LocalValueEntry.op_Equality(System.Windows.LocalValueEntry,System.Windows.LocalValueEntry)" /> implementation compares the values of the <see cref="P:System.Windows.LocalValueEntry.Property" />, and potentially compares the values of <see cref="P:System.Windows.LocalValueEntry.Value" />. The <see cref="P:System.Windows.LocalValueEntry.Property" /> component of a <see cref="T:System.Windows.LocalValueEntry" /> is a value type, so will always be a bitwise comparison. For the <see cref="P:System.Windows.LocalValueEntry.Value" /> component, this implementation employs a bitwise comparison if it is a value type. For locally set properties that have reference types, the behavior is deferred to that type's equality determination mechanisms, because it just uses the == operator on the two values internally. By default, this would be a reference equality of the values and thus the equality of the entire <see cref="T:System.Windows.LocalValueEntry" /> would become a reference equality.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.LocalValueEntry.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="localValueEntry.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the hash code for this <see cref="T:System.Windows.LocalValueEntry" />.</summary>
<returns>A signed 32-bit integer value.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="op_Equality">
<MemberSignature Language="C#" Value="public static bool operator == (System.Windows.LocalValueEntry obj1, System.Windows.LocalValueEntry obj2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Equality(valuetype System.Windows.LocalValueEntry obj1, valuetype System.Windows.LocalValueEntry obj2) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.LocalValueEntry.op_Equality(System.Windows.LocalValueEntry,System.Windows.LocalValueEntry)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator == (obj1 As LocalValueEntry, obj2 As LocalValueEntry) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool operator ==(System::Windows::LocalValueEntry obj1, System::Windows::LocalValueEntry obj2);" />
<MemberSignature Language="F#" Value="static member ( = ) : System.Windows.LocalValueEntry * System.Windows.LocalValueEntry -&gt; bool" Usage="obj1 = obj2" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj1" Type="System.Windows.LocalValueEntry" />
<Parameter Name="obj2" Type="System.Windows.LocalValueEntry" />
</Parameters>
<Docs>
<param name="obj1">The first instance to compare.</param>
<param name="obj2">The second instance to compare.</param>
<summary>Compares the specified <see cref="T:System.Windows.LocalValueEntry" /> instances to determine whether they are the same.</summary>
<returns>
<see langword="true" /> if the <paramref name="obj1" /><see cref="T:System.Windows.LocalValueEntry" /> is equal to the <paramref name="obj2" /><see cref="T:System.Windows.LocalValueEntry" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This <xref:System.Windows.LocalValueEntry.op_Equality%2A> implementation compares the values of the <xref:System.Windows.LocalValueEntry.Property%2A>, and potentially compares the values of <xref:System.Windows.LocalValueEntry.Value%2A>. The <xref:System.Windows.LocalValueEntry.Property%2A> component of a <xref:System.Windows.LocalValueEntry> is always a value type, so this comparison will always be a bitwise value comparison. For the <xref:System.Windows.LocalValueEntry.Value%2A> component, this implementation employs a bitwise comparison if it is a value type.
For locally set properties that have reference types, the behavior is deferred to that type's equality determination mechanisms, because it uses the `==` operator on the two values internally. By default, this is a reference equality of the values.
]]></format>
</remarks>
<altmember cref="M:System.Windows.LocalValueEntry.Equals(System.Object)" />
</Docs>
</Member>
<Member MemberName="op_Inequality">
<MemberSignature Language="C#" Value="public static bool operator != (System.Windows.LocalValueEntry obj1, System.Windows.LocalValueEntry obj2);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname bool op_Inequality(valuetype System.Windows.LocalValueEntry obj1, valuetype System.Windows.LocalValueEntry obj2) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.LocalValueEntry.op_Inequality(System.Windows.LocalValueEntry,System.Windows.LocalValueEntry)" />
<MemberSignature Language="VB.NET" Value="Public Shared Operator != (obj1 As LocalValueEntry, obj2 As LocalValueEntry) As Boolean" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; static bool operator !=(System::Windows::LocalValueEntry obj1, System::Windows::LocalValueEntry obj2);" />
<MemberSignature Language="F#" Value="static member op_Inequality : System.Windows.LocalValueEntry * System.Windows.LocalValueEntry -&gt; bool" Usage="System.Windows.LocalValueEntry.op_Inequality (obj1, obj2)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj1" Type="System.Windows.LocalValueEntry" />
<Parameter Name="obj2" Type="System.Windows.LocalValueEntry" />
</Parameters>
<Docs>
<param name="obj1">The first instance to compare.</param>
<param name="obj2">The second instance to compare.</param>
<summary>Compares the specified <see cref="T:System.Windows.LocalValueEnumerator" /> instances to determine whether they are different.</summary>
<returns>This implementation compares the values of the <see cref="P:System.Windows.LocalValueEntry.Property" /> and <see cref="P:System.Windows.LocalValueEntry.Value" /> components of a <see cref="T:System.Windows.LocalValueEntry" />. The <see cref="P:System.Windows.LocalValueEntry.Property" /> component of a <see cref="T:System.Windows.LocalValueEntry" /> is always a value type, so this comparison will always be a bitwise comparison. For the <see cref="P:System.Windows.LocalValueEntry.Value" /> component, this implementation employs a bitwise comparison if it is a value type.
For locally set properties that have reference types, the behavior is deferred to that type's equality determination mechanisms, because it uses the <see langword="==" /> operator on the two values internally. By default, this is a reference equality of the values.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.LocalValueEntry.Equals(System.Object)" />
</Docs>
</Member>
<Member MemberName="Property">
<MemberSignature Language="C#" Value="public System.Windows.DependencyProperty Property { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.DependencyProperty Property" />
<MemberSignature Language="DocId" Value="P:System.Windows.LocalValueEntry.Property" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Property As DependencyProperty" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::DependencyProperty ^ Property { System::Windows::DependencyProperty ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Property : System.Windows.DependencyProperty" Usage="System.Windows.LocalValueEntry.Property" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the identifier for the locally set dependency property that is represented by this entry.</summary>
<value>The identifier for the locally set dependency property.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this property to query the identifier of the locally set dependency property and to obtain its metadata. This obtained metadata may include the initial default value of the property and whether the property supports property value inheritance.
]]></format>
</remarks>
<altmember cref="T:System.Windows.DependencyProperty" />
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public object Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance object Value" />
<MemberSignature Language="DocId" Value="P:System.Windows.LocalValueEntry.Value" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Value As Object" />
<MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ Value { System::Object ^ get(); };" />
<MemberSignature Language="F#" Value="member this.Value : obj" Usage="System.Windows.LocalValueEntry.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>WindowsBase</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName>get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the value of the locally set dependency property.</summary>
<value>The value of the locally set dependency property as an object.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To determine a more specific type for this value, check the <xref:System.Windows.LocalValueEntry.Property%2A> for the current <xref:System.Windows.LocalValueEntry> and get its <xref:System.Windows.DependencyProperty.PropertyType%2A>.
]]></format>
</remarks>
<altmember cref="T:System.Windows.DependencyProperty" />
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.