WiX Database XML Schema

Element: EmbeddedUI

Description

Element value is the condition.

Derived By

Restricting anyType

Attributes

Name  Type  Required?  Default  Description 
Id  string  Yes    Unique identifier for embedded UI.
IgnoreFatalExit  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_FATALEXIT messages.
IgnoreError  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_ERROR messages.
IgnoreWarning  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_WARNING messages.
IgnoreUser  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_USER messages.
IgnoreInfo  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_INFO messages.
IgnoreFilesInUse  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSE messages.
IgnoreResolveSource  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE messages.
IgnoreOutOfDiskSpace  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACE messages.
IgnoreActionStart  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTART messages.
IgnoreActionData  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATA messages.
IgnoreProgress  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_PROGRESS messages.
IgnoreCommonData  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATA messages.
IgnoreInitialize  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZE messages.
IgnoreTerminate  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_TERMINATE messages.
IgnoreShowDialog  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOG messages.
IgnoreRMFilesInUse  YesNoType  No    Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSE messages.
Name  LongFileNameType  No    The name for the embedded UI DLL when it is extracted from the Product and executed. (Windows Installer does not support the typical short filename and long filename combination for embedded UI files as it does for other kinds of files.)
SourceFile  string  Yes    Path to the binary file that is the embedded UI.
SupportBasicUI  YesNoType  No    Set yes to allow the Windows Installer to display the embedded UI during basic UI level installation.

Content Model

Can contain a mix of text and the elements defined in the following table.

Component  Type  Occurs  Description 
    1..1   
EmbeddedUIResource  anyType (restriction)  0..*  Defines a resource for use by the embedded UI.

Referenced By

  • Element UI

Remarks

Use CDATA if message contains delimiter characters.

Definition

<xs:element name="EmbeddedUI">
  <xs:annotation>
    <xs:appinfo>
      <xse:msiRef table="MsiEmbeddedUI" href="http://msdn.microsoft.com/library/bb736317.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
    </xs:appinfo>
    <xs:documentation>Element value is the condition. Use CDATA if message contains delimiter characters.</xs:documentation>
  </xs:annotation>
  <xs:complexType mixed="true">
    <xs:sequence>
      <xs:element ref="EmbeddedUIResource" minOccurs="0" maxOccurs="unbounded">
        <xs:annotation>
          <xs:documentation>Specifies extra files to be extracted for use by the embedded UI, such as language resources.</xs:documentation>
        </xs:annotation>
      </xs:element>
    </xs:sequence>
    <xs:attribute name="Id" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Unique identifier for embedded UI.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreFatalExit" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_FATALEXIT messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreError" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ERROR messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreWarning" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_WARNING messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreUser" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_USER messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreInfo" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_INFO messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreFilesInUse" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_FILESINUSE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreResolveSource" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_RESOLVESOURCE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreOutOfDiskSpace" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_OUTOFDISKSPACE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreActionStart" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ACTIONSTART messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreActionData" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_ACTIONDATA messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreProgress" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_PROGRESS messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreCommonData" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_COMMONDATA messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreInitialize" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_INITIALIZE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreTerminate" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_TERMINATE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreShowDialog" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_SHOWDIALOG messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="IgnoreRMFilesInUse" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Embedded UI will not recieve any INSTALLLOGMODE_RMFILESINUSE messages.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Name" type="LongFileNameType">
      <xs:annotation>
        <xs:documentation>
                        The name for the embedded UI DLL when it is extracted from the Product and executed. (Windows Installer 
                        does not support the typical short filename and long filename combination for embedded UI files as it 
                        does for other kinds of files.) If this attribute is not specified the Id attribute will be used.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="SourceFile" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>
                        Path to the binary file that is the embedded UI. This must be a DLL that exports the following
                        three entry points: InitializeEmbeddedUI, EmbeddedUIHandler and ShutdownEmbeddedUI.
                    </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="SupportBasicUI" type="YesNoType">
      <xs:annotation>
        <xs:documentation>Set yes to allow the Windows Installer to display the embedded UI during basic UI level installation.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
  </xs:complexType>
</xs:element>