DownloadFile Class

  • [アーティクル]

Represents the activity that downloads a file.

Inheritance Hierarchy

System.Object
  System.Activities.Activity
    System.Activities.CodeActivity
      Microsoft.TeamFoundation.Build.Workflow.Activities.DownloadFile

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

Syntax

'宣言
<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)> _
<BuildCategoryAttribute> _
<ToolboxBitmapAttribute(GetType(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")> _
Public NotInheritable Class DownloadFile _
    Inherits CodeActivity

[ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)]
[BuildCategoryAttribute]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")]
public sealed class DownloadFile : CodeActivity

[ActivityTrackingAttribute(ActivityTrackingOption::ActivityOnly)]
[BuildCategoryAttribute]
[ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), L"DefaultBuildIcon.png")]
public ref class DownloadFile sealed : public CodeActivity

[<Sealed>]
[<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)>]
[<BuildCategoryAttribute>]
[<ToolboxBitmapAttribute(typeof(TeamBuildBaseActivityDesigner), "DefaultBuildIcon.png")>]
type DownloadFile =  
    class
        inherit CodeActivity
    end

public final class DownloadFile extends CodeActivity

The DownloadFile type exposes the following members.

Constructors

  Name Description
Public method DownloadFile Initializes a new instance of the DownloadFile class.

Top

Properties

  Name Description
Protected property CacheId Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
Protected property Constraints Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
Public property DeletionId Gets or sets the deletion ID of the file to download that was deleted from version control.
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.)
Protected property Implementation Not supported. (Inherited from CodeActivity.)
Public property LocalPath Gets or sets the local path to store the downloaded file.
Public property ServerPath Gets or sets the server path of the file to download.
Public property Version Gets or sets the version of the file to download.
Public property VersionControlServer Gets or sets the VersionControlServer object that represents the server from which to download a file.

Top

Methods

  Name Description
Protected method CacheMetadata(ActivityMetadata) Not implemented. Use CacheMetadata(CodeActivityMetadata) instead. (Inherited from CodeActivity.)
Protected method CacheMetadata(CodeActivityMetadata) Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Inherited from CodeActivity.)
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Execute When implemented in a derived class, performs the execution of the activity. (Inherited from CodeActivity.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (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

Remarks

The DownloadFiles activity is preferable to use since it supports downloading one or more files.

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