Element: RemoveFolder

Description

Remove an empty folder if the parent component is selected for installation or removal.

Derived By

Restricting anyType

Attributes

Name	Type	Required?	Default	Description
Id	string	Yes		Primary key used to identify this particular entry.
Directory	string	No		Overrides the directory of the parent component with a specific Directory.
Property	string	No		Overrides the directory of the parent component with the value of the specified property.
On	NMTOKEN (restriction)	Yes		This value determines the time at which the folder may be removed.

Content Model

Always empty.

Referenced By

• Element Component

Remarks

By default, the folder is the directory of the parent component. This can be overridden by specifying the Directory attribute with a value corresponding to the Id of the directory, or by specifying the Property attribute with a value corresponding to a property that will have a value that resolves to the full path of the folder.

Definition

<xs:element name="RemoveFolder">
  <xs:annotation>
    <xs:appinfo>
      <xse:seeAlso ref="CreateFolder" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
      <xse:msiRef table="RemoveFile" href="http://msdn.microsoft.com/library/aa371201.aspx" xmlns:xse="http://schemas.microsoft.com/wix/2005/XmlSchemaExtension" />
    </xs:appinfo>
    <xs:documentation>
                Remove an empty folder if the parent component is selected for installation or removal.  By default, the folder
                is the directory of the parent component.  This can be overridden by specifying the Directory attribute
                with a value corresponding to the Id of the directory, or by specifying the Property attribute with a value
                corresponding to a property that will have a value that resolves to the full path of the folder.
            </xs:documentation>
  </xs:annotation>
  <xs:complexType>
    <xs:attribute name="Id" type="xs:string" use="required">
      <xs:annotation>
        <xs:documentation>Primary key used to identify this particular entry.</xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Directory" type="xs:string">
      <xs:annotation>
        <xs:documentation>
                    Overrides the directory of the parent component with a specific Directory.  This Directory must exist in the
                    installer database at creation time.  This attribute cannot be specified in conjunction with the Property attribute.
                </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="Property" type="xs:string">
      <xs:annotation>
        <xs:documentation>
                    Overrides the directory of the parent component with the value of the specified property.  The property
                    should have a value that resolves to the full path of the source directory.  The property does not have
                    to exist in the installer database at creation time; it could be created at installation time by a custom
                    action, on the command line, etc.  This attribute cannot be specified in conjunction with the Directory attribute.
                </xs:documentation>
      </xs:annotation>
    </xs:attribute>
    <xs:attribute name="On" use="required">
      <xs:annotation>
        <xs:documentation>
                        This value determines the time at which the folder may be removed.
                    </xs:documentation>
      </xs:annotation>
      <xs:simpleType>
        <xs:restriction base="xs:NMTOKEN">
          <xs:enumeration value="install">
            <xs:annotation>
              <xs:documentation>
                                    Removes the folder only when the parent component is being installed (msiInstallStateLocal or msiInstallStateSource).
                                </xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="uninstall">
            <xs:annotation>
              <xs:documentation>
                                    Removes the folder only when the parent component is being removed (msiInstallStateAbsent).
                                </xs:documentation>
            </xs:annotation>
          </xs:enumeration>
          <xs:enumeration value="both">
            <xs:annotation>
              <xs:documentation>
                                    Removes the folder when the parent component is being installed or removed.
                                </xs:documentation>
            </xs:annotation>
          </xs:enumeration>
        </xs:restriction>
      </xs:simpleType>
    </xs:attribute>
  </xs:complexType>
</xs:element>

---