Payload element
Describes a payload to a bootstrapper.
Attributes
BAFactoryAssembly, from extension namespace http://wixtoolset.org/schemas/v4/wxs/bal
wxs:YesNoTypeUnionWhen set to “yes”, WixDotNetCoreBootstrapperApplicationHost will load the DLL and instantiate the type with the BootstrapperApplicationFactoryAttribute. The DLL must have been built referencing the WixToolset.Dnc.HostGenerator source generator NuGet package. The .NET Core project must have been published, not just built. Only one payload may be marked with this attribute set to “yes”.
Available in WiX v4. Deprecated in WiX v5. Move the Payload/@SourceFile attribute to be the BootstrapperApplication/@SourceFile attribute and remove the Payload element.
BAFunctions, from extension namespace http://wixtoolset.org/schemas/v4/wxs/bal
wxs:YesNoTypeUnionWhen set to “yes”, WixStdBA will load the DLL and work with it to handle BA messages. Only one payload may be marked with this attribute set to “yes”.
CertificatePublicKey
stringOptional public key of the certificate used to sign the payload. It is not recommended to use this attribute and rely on the Hash alone.
CertificateThumbprint
stringOptional thumbprint of the certificate used to sign the payload. It is not recommended to use this attribute and rely on the Hash alone.
Compressed
YesNoDefaultTypeUnionWhether the payload should be embedded in a container or left as an external payload.
DownloadUrl
stringThe URL to use to download the package. The following substitutions are supported:
- {0} is replaced by the package Id.
- {1} is replaced by the payload Id.
- {2} is replaced by the payload file name.
Hash
stringOptional SHA256 hash of the payload. Must be provided if the SourceFile attribute is not used.
Id
stringThe identifier of Payload element.
Name
stringThe destination path and file name for this payload. The default is the source file name. At a minimum, the Name or SourceFile attribute must be specified. This must be a relative path (‘\foo’ or ‘C:\foo’ is not allowed).
Size
IntegerOptional size of the payload in bytes. Required if Hash is specified, otherwise must not be specified.
SourceFile
stringLocation of the source file. The default value is the Name attribute, if provided. At a minimum, the SourceFile or Name attribute must be specified.