GenerateDeploymentManifest Class

Definition

Generates a deploy manifest for ClickOnce projects.

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

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

Constructors

GenerateDeploymentManifest()

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

Initializes a new instance of the GenerateDeploymentManifest class.

Properties

AssemblyName

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

Gets or sets the name of the assembly.

(Inherited from GenerateManifestBase)
AssemblyVersion

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

Gets or sets the assembly version.

(Inherited from GenerateManifestBase)
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

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

(Inherited from Task)
BuildEngine8

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

(Inherited from Task)
BuildEngine9

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

(Inherited from Task)
CreateDesktopShortcut

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

Gets or sets whether an icon is created on the desktop during ClickOnce application installation.

DeploymentUrl

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

Gets or sets the update location for the application.

Description

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

Gets or sets the manifest description text.

(Inherited from GenerateManifestBase)
DisallowUrlActivation

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

Gets or sets a Boolean value that indicates whether the application should be run automatically when it is opened through a URL.

EntryPoint

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

Gets or sets the managed assembly or ClickOnce manifest reference that is the entry point to the manifest.

(Inherited from GenerateManifestBase)
ErrorReportUrl

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

Gets or sets the URL of the Web page that is displayed in dialog boxes during ClickOnce installations.

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)
InputManifest

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

Gets or sets the input manifest.

(Inherited from GenerateManifestBase)
Install

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

Gets or sets a Boolean that indicates whether the application is an installed application or an online-only application.

LauncherBasedDeployment (Inherited from GenerateManifestBase)
Log

Gets an instance of a TaskLoggingHelper class containing task logging methods. The taskLoggingHelper is a MarshallByRef object which needs to have MarkAsInactive called if the parent task is making the appdomain and marshaling this object into it. If the appdomain is not unloaded at the end of the task execution and the MarkAsInactive method is not called this will result in a leak of the task instances in the appdomain the task was created within.

(Inherited from Task)
MapFileExtensions

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

Gets or sets a Boolean value that indicates whether the .deploy file name extension mapping is used.

MaxTargetPath

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

Gets or sets the maximum manifest file name length.

(Inherited from GenerateManifestBase)
MinimumRequiredVersion

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

Gets or sets a Boolean value that indicates whether the user can skip the update.

OutputManifest

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

Gets or sets the generated manifest.

(Inherited from GenerateManifestBase)
Platform

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

Gets or sets the manifest platform.

(Inherited from GenerateManifestBase)
Product

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

Gets or sets the name of the application.

Publisher

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

Gets or sets the publisher of the application.

SuiteName

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

Gets or sets the name of the folder on the Start menu where the application is located after ClickOnce deployment.

SupportUrl

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

Gets or sets the link that appears in the Uninstall or change a program dialog box for the application. The specified value should be a fully qualified URL or UNC path.

TargetCulture

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

Gets or sets the manifest target culture code.

(Inherited from GenerateManifestBase)
TargetFrameworkMoniker

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

Gets or sets the target framework moniker.

(Inherited from GenerateManifestBase)
TargetFrameworkVersion

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

The target .NET Framework version for the project.

(Inherited from GenerateManifestBase)
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)
TrustUrlParameters

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

Gets or sets a Boolean value that indicates whether URL query-string parameters should be made available to the application.

UpdateEnabled

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

Gets or sets a Boolean value that indicates whether the application is enabled for updates.

UpdateInterval

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

Gets or sets the update interval for the application.

UpdateMode

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

Gets or sets a Boolean value that indicates whether updates should be checked. Updates can be checked before the application is started (in the foreground), or when the application is running (in the background).

UpdateUnit

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

Gets or sets the time unit for the UpdateInterval property.

Methods

AddAssemblyFromItem(ITaskItem)

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

Adds an assembly reference to the manifest, based on the specified item.

(Inherited from GenerateManifestBase)
AddAssemblyNameFromItem(ITaskItem, AssemblyReferenceType)

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

Adds an assembly reference to the manifest, based on the specified item and the assembly reference type.

(Inherited from GenerateManifestBase)
AddEntryPointFromItem(ITaskItem, AssemblyReferenceType)

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

Adds an entry point reference to the manifest, based on the specified item and the assembly reference type.

(Inherited from GenerateManifestBase)
AddFileFromItem(ITaskItem)

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

Adds a file reference to the manifest, based on the specified item.

(Inherited from GenerateManifestBase)
CompareFrameworkVersions(String, String)

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

Compares two .NET Framework versions and determines which version comes before the other one.

(Inherited from GenerateManifestBase)
ConvertFrameworkVersionToString(String)

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

Converts the given .NET Framework version to a string.

(Inherited from GenerateManifestBase)
Execute()
Execute()

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

Executes the GenerateManifestBase task.

(Inherited from GenerateManifestBase)
FindFileFromItem(ITaskItem)

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

Returns the manifest file reference that matches the specified item.

(Inherited from GenerateManifestBase)
GetObjectType()

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

When implemented in a derived class, returns the type of the manifest.

(Inherited from GenerateManifestBase)
OnManifestLoaded(Manifest)

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

When implemented in a derived class, sets manifest properties and any dependencies.

(Inherited from GenerateManifestBase)
OnManifestResolved(Manifest)

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

When implemented in a derived class, sets resolved manifest properties.

(Inherited from GenerateManifestBase)
ValidateInputs()

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

Validates the inputs of the GenerateManifestBase task.

(Inherited from GenerateManifestBase)
ValidateOutput()

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

Validates the generated manifest.

(Inherited from GenerateManifestBase)

Applies to