C# Class WixSharp.Feature

Defines WiX Feature.

All installable WiX components belong to one or more features. By default, if no Features are defined by user, Wix# creates "Complete" feature, which contains all installable components.

Inheritance: WixEntity

Mostrar archivo Open project: Eun/WixSharp Class Usage Examples

Public Properties

Property	Type	Description
AllowChange	bool
Children	List
Condition	FeatureCondition
ConfigurableDir	string
Description	string
IsEnabled	bool

Public Methods

Method	Description
Add ( ) : Feature	Adds the specified nested features.
Feature ( ) : System.Collections.Generic	Initializes a new instance of the Feature class.
Feature ( string name ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, bool isEnabled ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, bool isEnabled, bool allowChange ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, string description ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, string description, bool isEnabled ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, string description, bool isEnabled, bool allowChange ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, string description, bool isEnabled, bool allowChange, string configurableDir ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
Feature ( string name, string description, string configurableDir ) : System.Collections.Generic	Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.
ToString ( ) : string	Returns a System.String that represents this instance.

Private Methods

Method	Description
ToXml ( ) : System.Xml.Linq.XElement

Method Details

Add() public method

Adds the specified nested features.

public Add ( ) : Feature
return	Feature

Feature() public method

Initializes a new instance of the Feature class.

public Feature ( ) : System.Collections.Generic
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name ) : System.Collections.Generic
name	string	The feature name.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, bool isEnabled ) : System.Collections.Generic
name	string	The feature name.
isEnabled	bool	Defines if the is enabled at startup. /// Use this parameter if the feature should be disabled by default and only enabled after /// processing the Condition Table or user input.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, bool isEnabled, bool allowChange ) : System.Collections.Generic
name	string	The feature name.
isEnabled	bool	Defines if the is enabled at startup. /// Use this parameter if the feature should be disabled by default and only enabled after /// processing the Condition Table or user input.
allowChange	bool	Defines if setup allows the user interface to display an option to change the state to Absent.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, string description ) : System.Collections.Generic
name	string	The feature name.
description	string	The feature description.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, string description, bool isEnabled ) : System.Collections.Generic
name	string	The feature name.
description	string	The feature description.
isEnabled	bool	Defines if the is enabled at startup. /// Use this parameter if the feature should be disabled by default and only enabled after /// processing the Condition Table or user input.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, string description, bool isEnabled, bool allowChange ) : System.Collections.Generic
name	string	The feature name.
description	string	The feature description.
isEnabled	bool	Defines if the is enabled at startup. /// Use this parameter if the feature should be disabled by default and only enabled after /// processing the Condition Table or user input.
allowChange	bool	Defines if setup allows the user interface to display an option to change the state to Absent.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, string description, bool isEnabled, bool allowChange, string configurableDir ) : System.Collections.Generic
name	string	The feature name.
description	string	The feature description.
isEnabled	bool	Defines if the is enabled at startup. /// Use this parameter if the feature should be disabled by default and only enabled after /// processing the Condition Table or user input.
allowChange	bool	Defines if setup allows the user interface to display an option to change the state to Absent.
configurableDir	string	The default path of the feature ConfigurableDirectory. If set to non-empty string, MSI runtime will place /// Configure button for the feature in the Feature Selection dialog.
return	System.Collections.Generic

Feature() public method

Initializes a new instance of the Feature class with properties/fields initialized with specified parameters.

public Feature ( string name, string description, string configurableDir ) : System.Collections.Generic
name	string	The feature name.
description	string	The feature description.
configurableDir	string	The default path of the feature ConfigurableDirectory. If set to non-empty string, MSI runtime will place /// Configure button for the feature in the Feature Selection dialog.
return	System.Collections.Generic

ToString() public method

Returns a System.String that represents this instance.

public ToString ( ) : string
return	string

Property Details

AllowChange public_oe property

Defines if setup allows the user interface to display an option to change the Feature state to Absent.

This property is translated into WiX Feature.Absent attribute.

The default value is true.

public bool AllowChange
return	bool

Children public_oe property

Child Feature. To be added in the nested Features scenarios.

public List Children
return	List

Condition public_oe property

Defines the installation Condition, which is to be checked during the installation to determine if the feature should be installed on the target system.

public FeatureCondition,WixSharp Condition
return	FeatureCondition

ConfigurableDir public_oe property

The default path of the feature ConfigurableDirectory. If set to non-empty string, MSI runtime will place Configure button for the feature in the Feature Selection dialog.

public string ConfigurableDir
return	string

Description public_oe property

The feature description.

public string Description
return	string

IsEnabled public_oe property

Defines if the Feature is enabled at startup. Use this parameter if the feature should be disabled by default and only enabled after processing the Condition Table or user input.

The default value is true.

public bool IsEnabled
return	bool