Constructs a new batch process object. Each object can only be used once.
Namespace:
InfigoSDKAssembly: InfigoSDK (in InfigoSDK.dll) Version: 1.0.0.0 (1.0.0.0)
Syntax
C# |
---|
public InfigoBatchRun( string strFileName, IInfigoDataSource dataSource, IInfigoMapping mapping, InfigoBatchRunData props, IInfigoBatchPreviewParameter preview ) |
Visual Basic (Declaration) |
---|
Public Sub New ( _ strFileName As String, _ dataSource As IInfigoDataSource, _ mapping As IInfigoMapping, _ props As InfigoBatchRunData, _ preview As IInfigoBatchPreviewParameter _ ) |
Visual C++ |
---|
public: InfigoBatchRun( String^ strFileName, IInfigoDataSource^ dataSource, IInfigoMapping^ mapping, InfigoBatchRunData^ props, IInfigoBatchPreviewParameter^ preview ) |
Parameters
- strFileName
- Type: System..::.String
The file name to the PDF template file used for the batch.
- dataSource
- Type: InfigoSDK..::.IInfigoDataSource
The IInfigoDataSource object which is used as input. Please note that this must not be opened already, as that happens during the batch process automatically.
- mapping
- Type: InfigoSDK..::.IInfigoMapping
The mapping object (see InfigoFieldMapping which is used for connecting the input data source columns with the variable parts of the template.
- props
- Type: InfigoSDK..::.InfigoBatchRunData
The batch parameters (see InfigoBatchRunData). This controls the output and operation modes. Can be null, in which case the preview parameters must be given. The output is then stored in the working directory.
- preview
- Type: InfigoSDK..::.IInfigoBatchPreviewParameter
The preview parameters (see InfigoBatchPreviewData). This can be null if no preview is required. If not null, the input data source is used to look for the constraints given in this object.