Skip to main content

IWindowsInstallerBackendHelper Interface

Interface provided to help Windows Installer backend extensions.

Methods

MethodDescription
CreateFileFacade(file)Creates a file facade from a FileSymbol .
CreateFileFacade(fileRow)Creates a file facade from a File row.
CreateRow(section, symbol, data, tableDefinition)Creates a «see T:WixToolset.Data.WindowsInstaller.Row» in the specified table.
TryAddSymbolToMatchingTableDefinitions(section, symbol, data, tableDefinitions)Looks up the registered «see T:WixToolset.Data.WindowsInstaller.TableDefinition» for the given «see T:WixToolset.Data.IntermediateSymbol» and creates a «see T:WixToolset.Data.WindowsInstaller.Row» in that table. Goes sequentially through each field in the symbol and assigns the value to the column with the same index as the field. If the symbol's Id is registered as the primary key then that is used for the first column and the column data is offset by 1.

WixToolset.Extensibility.dll version 5.0.1+2f00cbe680fb01ab485d56f16de9cd19b133f875

CreateFileFacade(file) Method

Creates a file facade from a FileSymbol .

Declaration

public WixToolset.Extensibility.Data.IFileFacade CreateFileFacade(
WixToolset.Data.Symbols.FileSymbol file
)

Parameters

ParameterTypeDescription
fileWixToolset.Data.Symbols.FileSymbolFileSymbol backing the facade.

CreateFileFacade(fileRow) Method

Creates a file facade from a File row.

Declaration

public WixToolset.Extensibility.Data.IFileFacade CreateFileFacade(
WixToolset.Data.WindowsInstaller.Rows.FileRow fileRow
)

Parameters

ParameterTypeDescription
fileRowWixToolset.Data.WindowsInstaller.Rows.FileRowFileRow

Return value

WixToolset.Extensibility.Data.IFileFacade New IFileFacade .

CreateRow(section, symbol, data, tableDefinition) Method

Creates a «see T:WixToolset.Data.WindowsInstaller.Row» in the specified table.

Declaration

public WixToolset.Data.WindowsInstaller.Row CreateRow(
WixToolset.Data.IntermediateSection section,
WixToolset.Data.IntermediateSymbol symbol,
WixToolset.Data.WindowsInstaller.WindowsInstallerData data,
WixToolset.Data.WindowsInstaller.TableDefinition tableDefinition
)

Parameters

ParameterTypeDescription
sectionWixToolset.Data.IntermediateSectionParent section.
symbolWixToolset.Data.IntermediateSymbolSymbol with line information for the row.
dataWixToolset.Data.WindowsInstaller.WindowsInstallerDataWindows Installer data.
tableDefinitionWixToolset.Data.WindowsInstaller.TableDefinitionTable definition for the row.

Return value

WixToolset.Data.WindowsInstaller.Row Row created in the data .

TryAddSymbolToMatchingTableDefinitions(section, symbol, data, tableDefinitions) Method

Looks up the registered «see T:WixToolset.Data.WindowsInstaller.TableDefinition» for the given «see T:WixToolset.Data.IntermediateSymbol» and creates a «see T:WixToolset.Data.WindowsInstaller.Row» in that table. Goes sequentially through each field in the symbol and assigns the value to the column with the same index as the field. If the symbol's Id is registered as the primary key then that is used for the first column and the column data is offset by 1.

Declaration

public bool TryAddSymbolToMatchingTableDefinitions(
WixToolset.Data.IntermediateSection section,
WixToolset.Data.IntermediateSymbol symbol,
WixToolset.Data.WindowsInstaller.WindowsInstallerData data,
WixToolset.Data.WindowsInstaller.TableDefinitionCollection tableDefinitions
)

Parameters

ParameterTypeDescription
sectionWixToolset.Data.IntermediateSectionParent section.
symbolWixToolset.Data.IntermediateSymbolSymbol to create the row from.
dataWixToolset.Data.WindowsInstaller.WindowsInstallerDataWindows Installer data.
tableDefinitionsWixToolset.Data.WindowsInstaller.TableDefinitionCollectionTable definitions that have been registered with the binder.

Return value

bool True if a row was created.