C# Class WixSharp.EnvironmentVariable

Defines FileType association to be created for the file extension and the installed file/application (parent T:WixSharp.File).

Inheritance: WixEntity

Datei anzeigen Open project: Eun/WixSharp

Public Properties

Property	Type	Description
Action	EnvVarAction
Condition	Condition
Feature	Feature
Part	EnvVarPart?
Permanent	bool?
System	bool?
Value	string

Public Methods

Method	Description
EnvironmentVariable ( Feature feature, string name, string value ) : System	Initializes a new instance of the EnvironmentVariable class.
EnvironmentVariable ( Id id, Feature feature, string name, string value ) : System	Initializes a new instance of the EnvironmentVariable class.
EnvironmentVariable ( Id id, string name, string value ) : System	Initializes a new instance of the EnvironmentVariable class.
EnvironmentVariable ( string name, string value ) : System	Initializes a new instance of the EnvironmentVariable class.

Private Methods

Method	Description
ToXml ( ) : object[]

Method Details

EnvironmentVariable() public method

Initializes a new instance of the EnvironmentVariable class.

public EnvironmentVariable ( Feature feature, string name, string value ) : System
feature	Feature	the environment variable should be included in.
name	string	The name of the environment variable.
value	string	The value of the environment variable.
return	System

EnvironmentVariable() public method

Initializes a new instance of the EnvironmentVariable class.

public EnvironmentVariable ( Id id, Feature feature, string name, string value ) : System
id	Id	The explicit to be associated with instance.
feature	Feature	the environment variable should be included in.
name	string	The name.
value	string	The value.
return	System

EnvironmentVariable() public method

Initializes a new instance of the EnvironmentVariable class.

public EnvironmentVariable ( Id id, string name, string value ) : System
id	Id	The explicit to be associated with instance.
name	string	The name of the environment variable.
value	string	The value of the environment variable.
return	System

EnvironmentVariable() public method

Initializes a new instance of the EnvironmentVariable class.

public EnvironmentVariable ( string name, string value ) : System
name	string	The name of the environment variable.
value	string	The value of the environment variable.
return	System

Property Details

Action public_oe property

Specifies whether the environmental variable should be created, set or removed when the parent component is installed. T:WixSharp.EnvironmentVariable.Action.

public EnvVarAction Action
return	EnvVarAction

Condition public_oe property

Defines the installation Condition, which is to be checked during the installation to determine if the registry value should be created on the target system.

public Condition Condition
return	Condition

Feature public_oe property

the environment variable belongs to.

public Feature,WixSharp Feature
return	Feature

Part public_oe property

Indicates how value should be set.

public EnvVarPart? Part
return	EnvVarPart?

Permanent public_oe property

Specifies that the environment variable should not be removed on uninstall.

public bool? Permanent
return	bool?

System public_oe property

Specifies that the environment variable should be added to the system environment space. The default is 'no' which indicates the environment variable is added to the user environment space.

public bool? System
return	bool?

Value public_oe property

The value to set into the environment variable. If this attribute is not set, the environment variable is removed during installation if it exists on the machine.

public string Value
return	string