C# Class WixSharp.Action

Defines generic WiX CustomAction.

This class does not contain any public constructor and is only to be used as a base class for deriving specialized CustomActions (e.g. ) or for declaring heterogeneous collections.

Inheritance: WixEntity
Mostrar archivo Open project: Eun/WixSharp Class Usage Examples

Public Properties

Property Type Description
Condition Condition
Execute Execute
Impersonate bool?
Return Return
Sequence WixSharp.Sequence
SequenceNumber int?
Step Step
When When

Protected Properties

Property Type Description
count int

Public Methods

Method Description
ToString ( ) : string

Returns a System.String that represents this instance.

Protected Methods

Method Description
Action ( )

Default constructor. Creates instance of the class.
Action ( Id id )

Creates instance of the class with properties initialized with specified parameters.
Action ( Id id, Return returnType, When when, Step step, Condition condition )

Creates instance of the class with properties initialized with specified parameters.
Action ( Id id, Return returnType, When when, Step step, Condition condition, WixSharp.Sequence sequence )

Creates instance of the class with properties initialized with specified parameters.
Action ( Return returnType, When when, Step step, Condition condition )

Creates instance of the class with properties initialized with specified parameters.
Action ( Return returnType, When when, Step step, Condition condition, WixSharp.Sequence sequence )

Creates instance of the class with properties initialized with specified parameters.

Method Details

Action() protected method

Default constructor. Creates instance of the class.
protected Action ( )

Action() protected method

Creates instance of the class with properties initialized with specified parameters.
protected Action ( Id id )
id Id The explicit to be associated with instance.

Action() protected method

Creates instance of the class with properties initialized with specified parameters.
protected Action ( Id id, Return returnType, When when, Step step, Condition condition )
id Id The explicit to be associated with instance.
returnType Return The return type of the action.
when When the action should be executed with respect to the parameter.
step Step the action should be executed before/after during the installation.
condition Condition The launch condition for the .

Action() protected method

Creates instance of the class with properties initialized with specified parameters.
protected Action ( Id id, Return returnType, When when, Step step, Condition condition, WixSharp.Sequence sequence )
id Id The explicit to be associated with instance.
returnType Return The return type of the action.
when When the action should be executed with respect to the parameter.
step Step the action should be executed before/after during the installation.
condition Condition The launch condition for the .
sequence WixSharp.Sequence The MSI sequence the action belongs to.

Action() protected method

Creates instance of the class with properties initialized with specified parameters.
protected Action ( Return returnType, When when, Step step, Condition condition )
returnType Return The return type of the action.
when When the action should be executed with respect to the parameter.
step Step the action should be executed before/after during the installation.
condition Condition The launch condition for the .

Action() protected method

Creates instance of the class with properties initialized with specified parameters.
protected Action ( Return returnType, When when, Step step, Condition condition, WixSharp.Sequence sequence )
returnType Return The return type of the action.
when When the action should be executed with respect to the parameter.
step Step the action should be executed before/after during the installation.
condition Condition The launch condition for the .
sequence WixSharp.Sequence The MSI sequence the action belongs to.

ToString() public method

Returns a System.String that represents this instance.
public ToString ( ) : string
return string

Property Details

Condition public_oe property

Defines the launch Condition, which is to be checked during the installation to determine if the actions should be executed.
public Condition,WixSharp Condition
return Condition

Execute public_oe property

Defines Execute the action associated with.
public Execute Execute
return Execute

Impersonate public_oe property

This attribute specifies whether the Windows Installer, which executes as LocalSystem, should impersonate the user context of the installing user when executing this custom action. Typically the value should be true, except when the custom action needs elevated privileges to apply changes to the machine.
public bool? Impersonate
return bool?

Return public_oe property

Defines Return type of the action.
public Return Return
return Return

Sequence public_oe property

Defines Sequence the action belongs to.
public Sequence,WixSharp Sequence
return WixSharp.Sequence

SequenceNumber public_oe property

The sequence number for this action. Mutually exclusive with Before, After, and OnExit of When field.
public int? SequenceNumber
return int?

Step public_oe property

Defines at what Step the action should be executed during the installation.
public Step,WixSharp Step
return Step

When public_oe property

Defines order When the action should be executed with respect to the action Step.
public When When
return When

count protected_oe static_oe property

Global counter which is used as suffix for the automatically generated action name. This counter is used by Wix# engine to avoid naming collision and indicate CustomActions declaration order.
protected static int count
return int