Share via


GenerateApplicationManifest Class

Definition

Generates an application manifest for ClickOnce projects.

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

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

Remarks

EntryPoint is an optional ITaskItem[] parameter that indicates the entry point for the generated manifest assembly. For a ClickOnce deployment manifest, this input specifies the ClickOnce application manifest.

In Visual Studio 2005, the GenerateApplicationManifest Task requires an EntryPoint when an application manifest is generated. (Assembly or native manifests do not require an EntryPoint.) This requirement is enforced by the build error "MSB3185: EntryPoint not specified for manifest."

In Visual Studio 2008, MSBuild does not issue this error when the EntryPoint task parameter is not specified. Instead, the <customHostSpecified> tag is inserted as a child of the <entryPoint> tag, for example, as follows.

<entryPoint xmlns="urn:schemas-
  microsoft-com:asm.v2">
    <co.v1:customHostSpecified />
</entryPoint>

You can add DLL dependencies to the application manifest by using the following steps:

  1. Resolve the references in the assembly by using a call to ResolveAssemblyReference.

  2. Pass the output of the previous task and the assembly itself to ResolveManifestFiles.

  3. Pass the dependencies by using the Dependencies parameter to GenerateApplicationManifest.

Constructors

GenerateApplicationManifest()

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

Initializes a new instance of the GenerateApplicationManifest 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)
ClrVersion

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

Gets or sets the minimum version of the Common Language Runtime (CLR) required by the application.

ConfigFile

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

Gets or sets the task item that contains the application configuration file.

Dependencies

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

Gets or sets an item list that defines the set of dependent assemblies for the generated manifest.

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

FileAssociations

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

Gets or sets a list of one or more file type that are associated with the ClickOnce deployment manifest. File associations only valid only when .NET Framework 3.5 or later is targeted.

Files

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

Gets or sets the full paths of files to include in the manifest.

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

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

Gets or sets whether the application is hosted in a browser (as are WPF Web Browser Applications).

HostObject

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

(Inherited from Task)
IconFile

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

Gets or sets the application's icon file.

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

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

Gets or sets COM components to isolate in the generated manifest.

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

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

Gets or sets the type of manifest to generate.

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

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

Gets or sets the operating system (OS) version that is the minimum required by the application.

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.

Specifies the ProductName property in the project file.

Publisher

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

Specifies the PublisherName property in the project file.

RequiresMinimumFramework35SP1

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

Gets or sets whether the application requires the .NET Framework 3.5 SP1.

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.

Specifies the SupportUrl property in the project file.

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

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

Gets or sets the target framework profile.

TargetFrameworkSubset

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

Gets or sets the name of the .NET Framework subset to target.

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

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

Gets or sets an XML document that specifies the application security.

UseApplicationTrust

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

Specifies whether the Product, Publisher, and SupportUrl properties are written to the application manifest.

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