RunOnce Class

  • Article

Ensures that the enclosed activities run one time across all build agents.

Inheritance Hierarchy

System.Object
  System.Activities.Activity
    System.Activities.ActivityWithResult
      System.Activities.Activity<RunOnceResult>
        Microsoft.TeamFoundation.Build.Workflow.Activities.RunOnce

Namespace:  Microsoft.TeamFoundation.Build.Workflow.Activities
Assembly:  Microsoft.TeamFoundation.Build.Workflow (in Microsoft.TeamFoundation.Build.Workflow.dll)

Syntax

'Declaration
<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)> _
<ContentPropertyAttribute("Activities")> _
<ToolboxBitmapAttribute(GetType(TeamBuildBaseActivityDesigner), "RunOnceIcon.png")> _
Public NotInheritable Class RunOnce _
    Inherits Activity(Of RunOnceResult)

[ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)]
[ContentPropertyAttribute("Activities")]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "RunOnceIcon.png")]
public sealed class RunOnce : Activity<RunOnceResult>

[ActivityTrackingAttribute(ActivityTrackingOption::ActivityOnly)]
[ContentPropertyAttribute(L"Activities")]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), L"RunOnceIcon.png")]
public ref class RunOnce sealed : public Activity<RunOnceResult>

[<Sealed>]
[<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)>]
[<ContentPropertyAttribute("Activities")>]
[<ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "RunOnceIcon.png")>]
type RunOnce =  
    class 
        inherit Activity<RunOnceResult>
    end

public final class RunOnce extends Activity<RunOnceResult>

The RunOnce type exposes the following members.

Constructors

  Name Description
Public method RunOnce

Top

Properties

  Name Description
Public property Activities Gets the collection of child activities.
Protected property CacheId Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Public property DisplayName Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
Public property Id Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
Public property Name Gets or sets the name of the run once activity.
Public property Result Gets or sets the result argument for the Activity<TResult>. (Inherited from Activity<RunOnceResult>.)
Public property ResultType When implemented in a derived class, gets the type of an activity OutArgument. (Inherited from ActivityWithResult.)
Public property Variables Gets the collection of variables.

Top

Methods

  Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method ShouldSerializeDisplayName Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
Public method ToString Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

Top

Extension Methods

  Name Description
Public Extension Method GetAssemblyMetadataCollection (Defined by WorkflowHelpers.)

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.TeamFoundation.Build.Workflow.Activities Namespace