Skip to main content

BasePreprocessorExtension Class

Base class for creating a preprocessor extension.

Methods

MethodDescription
EvaluateFunction(prefix, function, args)Evaluates a function defined in the extension.
GetVariableValue(prefix, name)Gets the value of a variable whose prefix matches the extension.
PostPreprocess()Called at the end of the preprocessing of a source file.
PrePreprocess()Called at the beginning of the preprocessing of a source file.
ProcessPragma(prefix, pragma, args, parent)Processes a pragma defined in the extension.

Properties

PropertyDescription
ContextContext for use by the extension.
MessagingMessaging for use by the extension.
PrefixesGets or sets the variable prefixes for the extension.
PreprocessHelperPreprocessHelper for use by the extension.

WixToolset.Extensibility.dll version 5.0.1+2f00cbe680fb01ab485d56f16de9cd19b133f875

EvaluateFunction(prefix, function, args) Method

Evaluates a function defined in the extension.

Declaration

public string EvaluateFunction(
string prefix,
string function,
System.String[] args
)

Parameters

ParameterTypeDescription
prefixstringThe prefix of the function to be processed by the extension.
functionstringThe name of the function.
argsSystem.String[]The list of arguments.

Return value

string The value of the function or null if the function is not defined.

GetVariableValue(prefix, name) Method

Gets the value of a variable whose prefix matches the extension.

Declaration

public string GetVariableValue(
string prefix,
string name
)

Parameters

ParameterTypeDescription
prefixstringThe prefix of the variable to be processed by the extension.
namestringThe name of the variable.

Return value

string The value of the variable or null if the variable is undefined.

PostPreprocess() Method

Called at the end of the preprocessing of a source file.

Declaration

public void PostPreprocess()

PrePreprocess() Method

Called at the beginning of the preprocessing of a source file.

Declaration

public void PrePreprocess()

ProcessPragma(prefix, pragma, args, parent) Method

Processes a pragma defined in the extension.

Declaration

public bool ProcessPragma(
string prefix,
string pragma,
string args,
System.Xml.Linq.XContainer parent
)

Parameters

ParameterTypeDescription
prefixstringThe prefix of the pragma to be processed by the extension.
pragmastringThe name of the pragma.
argsstringThe pragma's arguments.
parentSystem.Xml.Linq.XContainerThe parent node of the pragma.

Return value

bool false if the pragma is not defined.

Context Property

Context for use by the extension.

Declaration

protected Data.IPreprocessContext Context { get; set; } 

Messaging Property

Messaging for use by the extension.

Declaration

protected Services.IMessaging Messaging { get; set; } 

Prefixes Property

Gets or sets the variable prefixes for the extension.

Declaration

public System.String[] Prefixes { get; set; } 

PreprocessHelper Property

PreprocessHelper for use by the extension.

Declaration

protected Services.IPreprocessHelper PreprocessHelper { get; set; }