Share via


DeployManifest Class

Definition

Describes a ClickOnce deployment manifest.

public ref class DeployManifest sealed : Microsoft::Build::Tasks::Deployment::ManifestUtilities::Manifest
[System.Runtime.InteropServices.ComVisible(false)]
public sealed class DeployManifest : Microsoft.Build.Tasks.Deployment.ManifestUtilities.Manifest
[<System.Runtime.InteropServices.ComVisible(false)>]
type DeployManifest = class
    inherit Manifest
Public NotInheritable Class DeployManifest
Inherits Manifest
Inheritance
DeployManifest
Attributes

Constructors

DeployManifest()

Initializes a new instance of the DeployManifest class.

DeployManifest(String)

Initializes a new instance of the DeployManifest class.

Properties

AssemblyIdentity

Specifies the identity of the manifest.

(Inherited from Manifest)
AssemblyName

Assembly name passed to the manifest generation task

(Inherited from Manifest)
AssemblyReferences

Specifies the set of assemblies referenced by the manifest.

(Inherited from Manifest)
CompatibleFrameworks

A collection of CompatibleFrameworks

CreateDesktopShortcut

Specifies whether the application install will create a shortcut on the desktop If True, the installation will create a shortcut to the application on the desktop. The default is False If Install is False, this value will be ignored

DeploymentUrl

Specifies the update location for the application. If this input is not specified then no update location will be defined for the application. However, if application updates are specified then the update location must be specified. The specified value should be a fully qualified URL or UNC path.

Description

Specifies a textual description for the manifest.

(Inherited from Manifest)
DisallowUrlActivation

Specifies whether the application should be blocked from being activated via a URL. If this option is True then application can only be activated from the user's Start menu. The default is False. This option is ignored if the Install property is False.

EntryPoint

Gets or sets a deployment reference that is the entry point of the application.

ErrorReportUrl

Specifies the link to use if there is a failure launching the application. The specified value should be a fully qualified URL or UNC path.

FileReferences

Specifies the set of files referenced by the manifest.

(Inherited from Manifest)
InputStream

The input stream from which the manifest was read. Used by ManifestWriter to reconstitute input which is not represented in the object representation.

(Inherited from Manifest)
Install

Specifies whether the application is an installed application or an online only application. If this flag is True the application will be installed on the user's Start menu, and can be removed from the Add/Remove Programs dialog. If this flag is False then the application is intended for online use from a web page. The default is True.

LauncherBasedDeployment

Indicates if manifest is part of Launcher-based deployment, which requires somewhat different manifest generation and validation.

(Inherited from Manifest)
MapFileExtensions

Specifies whether or not the ".deploy" file extension mapping is used. If this flag is true then every application file is published with a ".deploy" file extension. This option is useful for web server security to limit the number of file extensions that need to be unblocked to enable ClickOnce application deployment. The default is false.

MinimumRequiredVersion

Specifies whether or not the user can skip the update. If the user has a version less than the minimum required, he or she will not have the option to skip the update. The default is to have no minimum required version. This input only applies when Install is True.

OutputMessages

Contains a collection of current error and warning messages.

(Inherited from Manifest)
Product

Specifies the name of the application. If this input is not specified then the name is inferred from the identity of the generated manifest. This name is used for the shortcut name on the Start menu and is part of the name that appears in the Add/Remove Programs dialog.

Publisher

Specifies the publisher of the application. If this input is not specified then the name is inferred from the registered user, or the identity of the generated manifest. This name is used for the folder name on the Start menu and is part of the name that appears in the Add/Remove Programs dialog.

ReadOnly

Specifies whether the manifest is operating in read-only or read-write mode. If only using to read a manifest then set this flag to true. If using to write a new manifest then set this flag to false. The default is false. This flag provides additional context for the manifest generator, and affects how some error messages are reported.

(Inherited from Manifest)
SourcePath

Specifies the location where the manifest was loaded or saved.

(Inherited from Manifest)
SuiteName

Specifies the suite name of the application. This name is used for the sub-folder name on the Start menu (as a child of the publisher)

SupportUrl

Specifies the link that appears in the Add/Remove Programs dialog for the application. The specified value should be a fully qualified URL or UNC path.

TargetFrameworkMoniker

Specifies the target framework moniker of this project.

TrustUrlParameters

Specifies whether or not URL query-string parameters should be made available to the application. The default is False indicating that parameters will not be available to the application.

UpdateEnabled

Indicates whether or not the application is updatable. The default is False. This input only applies when Install is True.

UpdateInterval

Specifies the update interval for the application. The default is zero. This input only applies when Install and UpdateEnabled are both True.

UpdateMode

Specifies whether updates should be checked in the foreground before starting the application, or in the background as the application is running. The default is "Background". This input only applies when Install and UpdateEnabled are both True.

UpdateUnit

Specifies the units for UpdateInterval input. This input only applies when Install and UpdateEnabled are both True.

XmlAssemblyIdentity

Gets or sets a property that is used to serialize the AssemblyIdentity property to an XML file.

(Inherited from Manifest)
XmlAssemblyReferences

Gets or sets a property that is used to serialize the AssemblyReferences property to an XML file.

(Inherited from Manifest)
XmlCompatibleFrameworks

Gets or sets the array of XML elements that represent the versions of the .NET Framework that an application can run on.

XmlCreateDesktopShortcut

Gets or sets a property that is used to serialize the CreateDesktopShortcut property to an XML file.

XmlDeploymentUrl

Gets or sets a property that is used to serialize the DeploymentUrl property to an XML file.

XmlDescription

Gets or sets a property that is used to serialize the Description property to an XML file.

(Inherited from Manifest)
XmlDisallowUrlActivation

Gets or sets a property that is used to serialize the DisallowUrlActivation property to an XML file.

XmlErrorReportUrl

Gets or sets a property that is used to serialize the ErrorReportUrl property to an XML file.

XmlFileReferences

Gets or sets a property that is used to serialize the FileReferences property to an XML file.

(Inherited from Manifest)
XmlInstall

Gets or sets a property that is used to serialize the Install property to an XML file.

XmlMapFileExtensions

Gets or sets a property that is used to serialize the MapFileExtensions property to an XML file.

XmlMinimumRequiredVersion

Gets or sets a property that is used to serialize the MinimumRequiredVersion property to an XML file.

XmlProduct

Gets or sets a property that is used to serialize the Product property to an XML file.

XmlPublisher

Gets or sets a property that is used to serialize the Publisher property to an XML file.

XmlSchema

Gets or sets a property that is used to serialize the schema to an XML file.

(Inherited from Manifest)
XmlSuiteName

Gets or sets a property that is used to serialize the SuiteName property to an XML file.

XmlSupportUrl

Gets or sets a property that is used to serialize the SupportUrl property to an XML file.

XmlTrustUrlParameters

Gets or sets a property that is used to serialize the TrustUrlParameters property to an XML file.

XmlUpdateEnabled

Gets or sets a property that is used to serialize the UpdateEnabled property to an XML file.

XmlUpdateInterval

Gets or sets a property that is used to serialize the UpdateInterval property to an XML file.

XmlUpdateMode

Gets or sets a property that is used to serialize the UpdateMode property to an XML file.

XmlUpdateUnit

Gets or sets a property that is used to serialize the UpdateUnit property to an XML file.

Methods

ResolveFiles()

Locates all specified assembly and file references by searching in the same directory as the loaded manifest, or in the current directory. The location of each referenced assembly and file is required for hash computation and assembly identity resolution. Any resulting errors or warnings are reported in the OutputMessages collection.

(Inherited from Manifest)
ResolveFiles(String[])

Locates all specified assembly and file references by searching in the specified directories. The location of each referenced assembly and file is required for hash computation and assembly identity resolution. Any resulting errors or warnings are reported in the OutputMessages collection.

(Inherited from Manifest)
ToString()

Returns the manifest name.

(Inherited from Manifest)
UpdateFileInfo()

Updates file information for each referenced assembly and file. The file information includes a hash computation and a file size for each referenced file and assembly. Also, the assembly identity is obtained for any referenced assemblies with an unspecified assembly identity. Any resulting errors or warnings are reported in the OutputMessages collection.

(Inherited from Manifest)
UpdateFileInfo(String)

Updates file information for each referenced assembly and file, using the specified version of the target framework.

(Inherited from Manifest)
Validate()

Performs various checks to verify the validity of the manifest. Any resulting errors or warnings are reported in the OutputMessageCollection object.

ValidatePlatform()

Validates the manifest platform.

(Inherited from Manifest)

Applies to