DownloadFile Class

Article
07/02/2014

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

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

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

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

[<Sealed>]
[<BuildCategoryAttribute>]
[<ActivityTrackingAttribute(ActivityTrackingOption.ActivityOnly)>]
[<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
	DownloadFile	Initializes a new instance of the DownloadFile class.

Top

Properties

	Name	Description
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	DeletionId	Gets or sets the deletion ID of the file to download that was deleted from version control.
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	LocalPath	Gets or sets the local path to store the downloaded file.
	ServerPath	Gets or sets the server path of the file to download.
	Version	Gets or sets the version of the file to download.
	VersionControlServer	Gets or sets the VersionControlServer object that represents the server from which to download a file.

Top

Methods

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

Top

Extension Methods

	Name	Description
	GetAssemblyMetadataCollection	(Defined by WorkflowHelpers.)

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.

Share via