RiaClientFilesTask Class

[WCF RIA Services Version 1 Service Pack 2 is compatible with either .NET framework 4 or .NET Framework 4.5, and with either Silverlight 4 or Silverlight 5.]

Abstract base class for common tasks used to manage the generation of client code by WCF RIA Services.

Inheritance Hierarchy

System.Object
  Microsoft.Build.Utilities.Task
    Microsoft.ServiceModel.DomainServices.Tools.RiaClientFilesTask
      Microsoft.ServiceModel.DomainServices.Tools.CleanRiaClientFilesTask
      Microsoft.ServiceModel.DomainServices.Tools.CreateRiaClientFilesTask

Namespace:  Microsoft.ServiceModel.DomainServices.Tools
Assembly:  Microsoft.ServiceModel.DomainServices.Tools (in Microsoft.ServiceModel.DomainServices.Tools.dll)

Syntax

'Declaration
Public MustInherit Class RiaClientFilesTask _
    Inherits Task _
    Implements ILogger
'Usage
Dim instance As RiaClientFilesTask
public abstract class RiaClientFilesTask : Task, 
    ILogger
public ref class RiaClientFilesTask abstract : public Task, 
    ILogger
[<AbstractClassAttribute>]
type RiaClientFilesTask =  
    class
        inherit Task
        interface ILogger
    end
public abstract class RiaClientFilesTask extends Task implements ILogger

The RiaClientFilesTask type exposes the following members.

Constructors

  Name Description
Protected method RiaClientFilesTask Creates an instance of the RiaClientFilesTask class.

Top

Properties

  Name Description
Public property BuildEngine (Inherited from Task.)
Public property BuildEngine2 (Inherited from Task.)
Public property BuildEngine3 (Inherited from Task.)
Public property BuildEngine4 (Inherited from Task.)
Protected property ClientProjectDirectory Gets the absolute path to the project running this task.
Public property ClientProjectPath Gets or sets the path to the client project currently running this task.
Public property HasLoggedErrors Gets a value that indicates whether any errors were logged.
Protected property HelpKeywordPrefix (Inherited from Task.)
Public property HostObject (Inherited from Task.)
Public property LiveIntellisense Gets or sets a value that indicates whether this is a build specifically for Live Intellisense that should not affect artifacts used by a real build.
Public property Log (Inherited from Task.)
Protected property OutputDirectory Gets the absolute path of the output directory.
Public property OutputPath Gets or sets the path where ancillary temporary files should go.
Protected property TaskResources (Inherited from Task.)

Top

Methods

  Name Description
Protected method DeleteCodeGenMetafileLists Deletes the breadcrumb files created to track files written on prior pass.
Protected method DeleteFolderIfEmpty Deletes the specified folder if it is empty.
Public method Equals (Inherited from Object.)
Public method Execute Implements the normal tasks execution entry point method used by the product infrastructure. (Overrides Task.Execute().)
Protected method ExecuteInternal Implementation for the Execute() method, called from this base class.
Protected method FilesPreviouslyWritten Returns the collection of full file names written previously by the last code generation pass.
Protected method Finalize (Inherited from Object.)
Protected method GetFullPathRelativeToDirectory Resolves a potentially relative path and a root directory to a full path.
Public method GetHashCode (Inherited from Object.)
Protected methodStatic member GetPathRelativeToProjectDirectory Returns the relative path under the project directory if the file path is under the project directory, otherwise returns the original file path.
Public method GetType (Inherited from Object.)
Public method LogError(String) Logs the specified error message to the logger associated with this task.
Public method LogError(String, String, String, String, String, Int32, Int32, Int32, Int32) Logs the specified message as a warning, together with information about the source location.
Public method LogMessage Logs the given informational message to the logger associated with this task.
Public method LogWarning(String) Logs the specified message as a warning.
Public method LogWarning(String, String, String, String, String, Int32, Int32, Int32, Int32) Logs the given message as a warning, together with information about the source location.
Protected method MemberwiseClone (Inherited from Object.)
Protected method NormalizeProjectPaths Converts input project paths to full path names.
Public method ToString (Inherited from Object.)

Top

Remarks

The CreateRiaClientFilesTask and CleanRiaClientFilesTask classes derive from this abstract base class.

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.ServiceModel.DomainServices.Tools Namespace