HitTestResultBehavior.xml

<Type Name="HitTestResultBehavior" FullName="System.Windows.Media.HitTestResultBehavior">
  <TypeSignature Language="C#" Value="public enum HitTestResultBehavior" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed HitTestResultBehavior extends System.Enum" />
  <TypeSignature Language="DocId" Value="T:System.Windows.Media.HitTestResultBehavior" />
  <TypeSignature Language="VB.NET" Value="Public Enum HitTestResultBehavior" />
  <TypeSignature Language="F#" Value="type HitTestResultBehavior = " />
  <TypeSignature Language="C++ CLI" Value="public enum class HitTestResultBehavior" />
  <AssemblyInfo>
    <AssemblyName>PresentationCore</AssemblyName>
    <AssemblyVersion>3.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
    <AssemblyVersion>5.0.0.0</AssemblyVersion>
    <AssemblyVersion>6.0.0.0</AssemblyVersion>
    <AssemblyVersion>7.0.0.0</AssemblyVersion>
    <AssemblyVersion>8.0.0.0</AssemblyVersion>
    <AssemblyVersion>9.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Enum</BaseTypeName>
  </Base>
  <Docs>
    <summary>Determines whether to continue the enumeration of any remaining visual objects during a hit test.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 A hit test results callback method defines the actions that you perform when a hit test is identified on a particular visual object in the visual tree. After you perform the actions, you return a `HitTestResultBehavior` value that determines whether to continue the enumeration of any other visual objects.  
  
 You can enumerate all visual objects in a visual tree whose geometry contains a specified coordinate value. By returning `Continue` in your hit test callback method, you can identify all visual objects that are hit, even those that may be partly or wholly obscured by other visual objects.  
  
   
  
## Examples  
 The following example shows how to return a `HitTestResultBehavior` value from a hit test results callback method.  
  
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Media/GeometryHitTestParameters/Overview/Window1.xaml.cs" id="Snippet102":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Wpf/HitTestingOverview/visualbasic/window1.xaml.vb" id="Snippet102":::  
  
 ]]></format>
    </remarks>
    <altmember cref="T:System.Windows.Media.HitTestResultCallback" />
  </Docs>
  <Members>
    <Member MemberName="Continue">
      <MemberSignature Language="C#" Value="Continue" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Media.HitTestResultBehavior Continue = int32(1)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Media.HitTestResultBehavior.Continue" />
      <MemberSignature Language="VB.NET" Value="Continue" />
      <MemberSignature Language="F#" Value="Continue = 1" Usage="System.Windows.Media.HitTestResultBehavior.Continue" />
      <MemberSignature Language="C++ CLI" Value="Continue" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>PresentationCore</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Media.HitTestResultBehavior</ReturnType>
      </ReturnValue>
      <MemberValue>1</MemberValue>
      <Docs>
        <summary>Continue hit testing against the next visual in the visual tree hierarchy.</summary>
      </Docs>
    </Member>
    <Member MemberName="Stop">
      <MemberSignature Language="C#" Value="Stop" />
      <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Windows.Media.HitTestResultBehavior Stop = int32(0)" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Media.HitTestResultBehavior.Stop" />
      <MemberSignature Language="VB.NET" Value="Stop" />
      <MemberSignature Language="F#" Value="Stop = 0" Usage="System.Windows.Media.HitTestResultBehavior.Stop" />
      <MemberSignature Language="C++ CLI" Value="Stop" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>PresentationCore</AssemblyName>
        <AssemblyVersion>3.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
        <AssemblyVersion>5.0.0.0</AssemblyVersion>
        <AssemblyVersion>6.0.0.0</AssemblyVersion>
        <AssemblyVersion>7.0.0.0</AssemblyVersion>
        <AssemblyVersion>8.0.0.0</AssemblyVersion>
        <AssemblyVersion>9.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Media.HitTestResultBehavior</ReturnType>
      </ReturnValue>
      <MemberValue>0</MemberValue>
      <Docs>
        <summary>Stop any further hit testing and return from the callback.</summary>
      </Docs>
    </Member>
  </Members>
</Type>