TrackingProfile.xml

<Type Name="TrackingProfile" FullName="System.Activities.Tracking.TrackingProfile">
  <TypeSignature Language="C#" Value="public class TrackingProfile" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit TrackingProfile extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Activities.Tracking.TrackingProfile" />
  <TypeSignature Language="VB.NET" Value="Public Class TrackingProfile" />
  <TypeSignature Language="F#" Value="type TrackingProfile = class" />
  <TypeSignature Language="C++ CLI" Value="public ref class TrackingProfile" />
  <AssemblyInfo>
    <AssemblyName>System.Activities</AssemblyName>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.Windows.Markup.ContentProperty("Queries")]</AttributeName>
      <AttributeName Language="F#">[&lt;System.Windows.Markup.ContentProperty("Queries")&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Creates a subscription to workflow tracking records in a <see cref="T:System.Activities.Tracking.TrackingParticipant" />.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The queries defined within the tracking profile define the kinds of events that are returned by the subscription.  
  
 ]]></format>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public TrackingProfile ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Activities.Tracking.TrackingProfile.#ctor" />
      <MemberSignature Language="VB.NET" Value="Public Sub New ()" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; TrackingProfile();" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Activities</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <Parameters />
      <Docs>
        <summary>Creates a new instance of the <see cref="T:System.Activities.Tracking.TrackingProfile" /> class.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ActivityDefinitionId">
      <MemberSignature Language="C#" Value="public string ActivityDefinitionId { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string ActivityDefinitionId" />
      <MemberSignature Language="DocId" Value="P:System.Activities.Tracking.TrackingProfile.ActivityDefinitionId" />
      <MemberSignature Language="VB.NET" Value="Public Property ActivityDefinitionId As String" />
      <MemberSignature Language="F#" Value="member this.ActivityDefinitionId : string with get, set" Usage="System.Activities.Tracking.TrackingProfile.ActivityDefinitionId" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ ActivityDefinitionId { System::String ^ get(); void set(System::String ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Activities</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.DefaultValue(null)&gt;]</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#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets the activity definition ID of the tracking profile.</summary>
        <value>The activity definition ID.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="ImplementationVisibility">
      <MemberSignature Language="C#" Value="public System.Activities.Tracking.ImplementationVisibility ImplementationVisibility { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Activities.Tracking.ImplementationVisibility ImplementationVisibility" />
      <MemberSignature Language="DocId" Value="P:System.Activities.Tracking.TrackingProfile.ImplementationVisibility" />
      <MemberSignature Language="VB.NET" Value="Public Property ImplementationVisibility As ImplementationVisibility" />
      <MemberSignature Language="F#" Value="member this.ImplementationVisibility : System.Activities.Tracking.ImplementationVisibility with get, set" Usage="System.Activities.Tracking.TrackingProfile.ImplementationVisibility" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Activities::Tracking::ImplementationVisibility ImplementationVisibility { System::Activities::Tracking::ImplementationVisibility get(); void set(System::Activities::Tracking::ImplementationVisibility value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Activities</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.DefaultValue(System.Activities.Tracking.ImplementationVisibility.RootScope)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.DefaultValue(System.Activities.Tracking.ImplementationVisibility.RootScope)&gt;]</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#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Activities.Tracking.ImplementationVisibility</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets or sets a value that filters tracking records emitted from nested activities within a top level activity (activities that compose the implementation of another activity.)</summary>
        <value>An <see cref="T:System.Activities.Tracking.ImplementationVisibility" /> object that indicates the scope of records to be filtered.  
  
 The default value is <see cref="F:System.Activities.Tracking.ImplementationVisibility.RootScope" />.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Tracking records can be filtered using two visibility modes within a tracking profile. The visibility mode specifies the activities being tracked within the workflow. The visibility modes specified by the implementationVisibility setting in the tracking profile are:  
  
-   <xref:System.Activities.Tracking.ImplementationVisibility.RootScope>  
  
-   <xref:System.Activities.Tracking.ImplementationVisibility.All>  
  
 This setting applies to the filtering of tracking records for composite activities (activities that contain other activities within its implementation.)  
  
 If **implementationVisibility** is **RootScope** and the composite activity is not the root activity for the workflow, only the top level activity within the composite activity is tracked. When set to **RootScope**, this flag suppresses the tracking records for activities that are not visible from the root of the workflow. Only the root activity and its implementation are tracked. If the implementation contains activities that are composite activities, then the composite activity is tracked but not its implementation.  
  
 For example, if a composite activity is created that is implemented as "MyActivity" with an implementation containing "Activity1" and "Activity2", and **implementationVisibility** is set to **RootScope**, when this activity is added to a workflow tracking records are emitted only for "MyActivity" and not "Activity1" or "Activity2". If **implementationVisibility** is set to **All**, then tracking records for "MyActivity", "Activity1", and "Activity2" are emitted.  
  
 ]]></format>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Name">
      <MemberSignature Language="C#" Value="public string Name { get; set; }" />
      <MemberSignature Language="ILAsm" Value=".property instance string Name" />
      <MemberSignature Language="DocId" Value="P:System.Activities.Tracking.TrackingProfile.Name" />
      <MemberSignature Language="VB.NET" Value="Public Property Name As String" />
      <MemberSignature Language="F#" Value="member this.Name : string with get, set" Usage="System.Activities.Tracking.TrackingProfile.Name" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::String ^ Name { System::String ^ get(); void set(System::String ^ value); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Activities</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName Language="C#">[System.ComponentModel.DefaultValue(null)]</AttributeName>
          <AttributeName Language="F#">[&lt;System.ComponentModel.DefaultValue(null)&gt;]</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#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the display name of the tracking profile.</summary>
        <value>The profile name.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Queries">
      <MemberSignature Language="C#" Value="public System.Collections.ObjectModel.Collection&lt;System.Activities.Tracking.TrackingQuery&gt; Queries { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.Collection`1&lt;class System.Activities.Tracking.TrackingQuery&gt; Queries" />
      <MemberSignature Language="DocId" Value="P:System.Activities.Tracking.TrackingProfile.Queries" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Queries As Collection(Of TrackingQuery)" />
      <MemberSignature Language="F#" Value="member this.Queries : System.Collections.ObjectModel.Collection&lt;System.Activities.Tracking.TrackingQuery&gt;" Usage="System.Activities.Tracking.TrackingProfile.Queries" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Collections::ObjectModel::Collection&lt;System::Activities::Tracking::TrackingQuery ^&gt; ^ Queries { System::Collections::ObjectModel::Collection&lt;System::Activities::Tracking::TrackingQuery ^&gt; ^ get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Activities</AssemblyName>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.ObjectModel.Collection&lt;System.Activities.Tracking.TrackingQuery&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the collection of <see cref="T:System.Activities.Tracking.TrackingQuery" /> objects that define the records to which this tracking profile subscribes.</summary>
        <value>The collection of queries.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>