SyncWorkspace Class

Article
08/13/2012

Represents the activity that synchronizes a workspace.

Inheritance Hierarchy

System.Object
System.Activities.Activity
Microsoft.TeamFoundation.Build.Workflow.Activities.SyncWorkspace

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

Syntax

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

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

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

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

public final class SyncWorkspace extends Activity

The SyncWorkspace type exposes the following members.

Constructors

	Name	Description
	SyncWorkspace	Initializes a new instance of the SyncWorkspace class.

Top

Properties

	Name	Description
	AllowUnmapped	Gets or sets a flag indicating whether to allow unmapped items.
	AutoMerge	Gets or sets a flag indicating whether to automatically merge conflicts.
	CacheId	Gets the identifier of the cache that is unique within the scope of the workflow definition. (Inherited from Activity.)
	Constraints	Gets a collection of Constraint activities that can be configured to provide validation for the Activity. (Inherited from Activity.)
	Deletes	Gets or sets an enumerable collection of items that were deleted during the synchronization.
	DisplayName	Gets or sets an optional friendly name that is used for debugging, validation, exception handling, and tracking. (Inherited from Activity.)
	GetOptions	Gets or sets a GetOption value indicating what items to get.
	Gets	Gets or sets an enumerable collection of items that were gotten during the synchronization.
	Id	Gets an identifier that is unique in the scope of the workflow definition. (Inherited from Activity.)
	Implementation	Gets or sets the delegate that returns an Activity that contains the execution logic. (Inherited from Activity.)
	NoCIOption	Gets or sets a flag indicating that there is no CI option.
	PopulateOutput	Gets or sets a flag indicating whether to populate the output.
	Replaces	Gets or sets an enumerable collection of items that were replaced during the synchronization.
	VersionOverride	Gets or sets a version specifier that indicates the version of the files to keep.
	Workspace	Gets or sets the workspace to synchronize.

Top

Methods

	Name	Description
	CacheMetadata	Creates and validates a description of the activity’s arguments, variables, child activities, and activity delegates. (Inherited from Activity.)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ShouldSerializeAllowUnmapped	Checks whether to serialize the AllowUnmapped property as a XAML string.
	ShouldSerializeAutoMerge	Checks whether to serialize the AutoMerge property as a XAML string.
	ShouldSerializeDisplayName	Indicates whether the DisplayName property should be serialized. (Inherited from Activity.)
	ShouldSerializeGetOptions	Checks whether to serialize the GetOptions property as a XAML string.
	ShouldSerializeNoCIOption	Checks whether to serialize the NoCIOption property as a XAML string.
	ToString	Returns a String that contains the Id and DisplayName of the Activity. (Inherited from Activity.)

Top

Remarks

This activity is not meant to be reused in a custom build process.

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.