FormatUrl Class

Definition

Formats a url by canonicalizing it (i.e. " " -> "%20") and transforming "localhost" to "machinename".

This API supports the product infrastructure and is not intended to be used directly from your code.

public ref class FormatUrl sealed : Microsoft::Build::Tasks::TaskExtension
public sealed class FormatUrl : Microsoft.Build.Tasks.TaskExtension
type FormatUrl = class
    inherit TaskExtension
Public NotInheritable Class FormatUrl
Inherits TaskExtension
Inheritance

Remarks

Proper URL format consists of applying URL character encoding and replacing "localhost" by the actual machine name.

Constructors

FormatUrl()

This API supports the product infrastructure and is not intended to be used directly from your code.

Initializes a new instance of the FormatUrl class.

Properties

BuildEngine

The build engine automatically sets this property to allow tasks to call back into it.

(Inherited from Task)
BuildEngine2

The build engine automatically sets this property to allow tasks to call back into it. This is a convenience property so that task authors inheriting from this class do not have to cast the value from IBuildEngine to IBuildEngine2.

(Inherited from Task)
BuildEngine3

Retrieves the IBuildEngine3 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine4

Retrieves the IBuildEngine4 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine5

Retrieves the IBuildEngine5 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine6

Retrieves the IBuildEngine6 version of the build engine interface provided by the host.

(Inherited from Task)
BuildEngine7

Gets the version of the build engine interface provided by the host.

(Inherited from Task)
HelpKeywordPrefix

Gets or sets the prefix used to compose help keywords from string resource names. If a task does not have help keywords associated with its messages, it can ignore this property or set it to null. If the prefix is set to an empty string, then string resource names will be used verbatim as help keywords. For an example of how this prefix is used, see the TaskLoggingHelper.LogErrorWithCodeFromResources(string, object[]) method.

(Inherited from Task)
HostObject

The build engine sets this property if the host IDE has associated a host object with this particular task.

(Inherited from Task)
InputUrl

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the URL to format.

Log

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets an instance of a TaskLoggingHelperExtension class containing task logging methods.

(Inherited from TaskExtension)
OutputUrl

This API supports the product infrastructure and is not intended to be used directly from your code.

Gets or sets the formatted URL.

TaskResources

Gets or sets the task's culture-specific resources. Derived classes should register their resources either during construction, or via this property, if they have localized strings.

(Inherited from Task)

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Execute()

This API supports the product infrastructure and is not intended to be used directly from your code.

Executes the FormatUrl task.

GetHashCode()

Serves as the default hash function.

(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)
ToString()

Returns a string that represents the current object.

(Inherited from Object)

Applies to