The InfigoSDK namespace contains all classes from the Infigo SDK.

Classes

  ClassDescription
InfigoAutoMapping
This static class allows you to automatically map the variable data to the columns of the data source via a heuristic.
InfigoBatchPreviewData
This class specifies the parameter for creating batch previews. This class operates in two modes:
  • Maximum number of records.
  • Maximum/Minimum record data for a specific column.
InfigoBatchRun
This class allows to perform the batch process.
InfigoBatchRunData
This class specifies the batch run parameters to be used for a specific batch run.
InfigoDataSourceException
This exception gets thrown if a data source error occurred.
InfigoDataSourceFactory
This static class helps creating IInfigoDataSource for various data sources.
InfigoFieldMapping
This class represents the overal mapping for all destinations in a template. It has a list of InfigoMappingData-objects.
InfigoMappingData
This type defines a single mapping between a template destination (field or variable) and either a fixed text or a specific column from the data source.
InfigoPDFException
This exception gets thrown if a PDF handling error occurred.
InfigoSDKException
This exception gets thrown if a SDK error happened.
InfigoSDKUtility
This class provides some helper functions and settings for the SDK.
InfigoTemplate
This class represents an Infigo Template. This includes:
PagesAn array of page information (read-only)
ColoursAn array of colour information (read-only)
Embedded FilesAn array of embedded file information (read-only)
Document PropertiesAn array of properties specified for the document. This can be extended and for non-fixed properties, the values can be changed.
Global text variablesAn array of text variables. Those variable values and non-fixed properties can be changed.
FieldsAn array of fields. The field values and non-fixed properties can be changed.
InfigoThreadException
This exception gets thrown if the internal threading encountered an error.
PDFHandler
This class is used to interact with PDF files and Infigo templates directly.

Interfaces

  InterfaceDescription
IInfigoAlternateChooser
This type allows to choose between different alternatives a designer has set during design-time of the template. Check which returns true if there is a choice to make. The array returns then all available options. The current option can be retrieved and a new can be set via the member.
IInfigoBarcodeField
This type is for barcode fields.
IInfigoBatchPreviewParameter
Use this interface to perform custom preview selection for data records. See class InfigoBatchPreviewData can be used for the most common preview types. Please note that using the preview facility is slower than using the batch without it, so this should be used for a minor number of records only.
IInfigoBooleanProperty
This boolean property allows to select between true and false.
IInfigoCMYKColour
This class contains information about a CMYK colour used in an Infigo Template.
IInfigoColour
An abstract type representing a colour object.
IInfigoDataSource
This type defines the interface for all Infigo input data sources.
IInfigoDoubleProperty
This double property allows to select a double value.
IInfigoEmbeddedFile
This type contains information about an embedded file of an Infigo Template. This is read-only information.
IInfigoField
This type represents an Infigo field and is the base type for , IInfigoTextFieldWithLocals and .
IInfigoGlobalVariable
This type represents a global text variable which can be used in any text field.
IInfigoImageField
This type is for image fields. An image field can reference to an external file via a path, or to an embedded file via the embedded file name.
IInfigoIntegerProperty
This integer property allows to select an integer value.
IInfigoLayer
This type represents a layer of fields. Layers can be simply switched on/off.
IInfigoLocalVariable
This type represents a local text variable as part of a text field.
IInfigoMapping
Use this interface to perform custom mapping if required. The class InfigoFieldMapping would be sufficient for most situations. If you require custom mapping, you can use this interface. Please note that using a custom mapping might be slower in performance.
IInfigoPage
This type contains information about a page of an Infigo template. This is read-only information.
IInfigoProperty
A property object. It has a name which must be unique in the context. If the IsFixed property is false, you can change the property value for input to an Infigo Template.
IInfigoPropertyControl
This type is the base type for fields and variables which have to be displayed in a form in order to fill the variable data for a template. Check for the proper type (IInfigoTextField, IInfigoTextFieldWithLocals, IInfigoImageField, IInfigoBarcodeField, IInfigoLocalVariable and IInfigoGlobalVariable) dynamically in order to further use the objects.
IInfigoRGBColour
This type contains information about a RGB colour used in an Infigo Template.
IInfigoSetProperty
This set property allows to select an item of a predefined list of texts.
IInfigoTextField
This type is for normal text fields
IInfigoTextFieldBase
This base type is for text fields and .
IInfigoTextFieldWithLocals
This type is for text fields which are using local text variables.
IInfigoTextListProperty
This text list property allows to select a whole sorted list of texts.
IInfigoTextProperty
This text property allows to select a text value.
IInfigoVariable
This text variable type represents a text variable to be used in text fields. and

Enumerations

  EnumerationDescription
InfigoBatchPreviewData..::.InfigoBatchPreviewType
The operation type for the object.
  • Minimum Show the record set with the minimal data in the specified column.
  • Maximum Show the record set with the maximal data in the specified column.
  • None Use the NumberOfRecords information to specify the maximal number of preview records to show.
InfigoBatchRunData..::.InfigoBatchType
There are three general modes in which a batch job can work.
  • SINGLE_FILE This mode generates a single output file containing all records.
  • X_RECORDS This mode generates PDF files where each one contains NumberOfRecordsPerFile records.
  • ONE_RECORD Each record is written into a separate file.
InfigoBatchRunData..::.InfigoOutputType
There are two different output types at the moment: ordinary PDF files or PPML. The PPML output consists of a PDF file along with an XML file with the PPML information. The two files can be put in an archive automatically.
InfigoDataSourceFactory..::.AccessType
Used for creating data sources reading from Microsoft Access files. Can be the new XML file format (starting from Access 2007) or the old binary format.
InfigoDataSourceFactory..::.ExcelType
Used for creating data sources reading from Microsoft Excel files. Can be the new XML file format (starting from Excel 2007) or the old binary format.
InfigoDataSourceFactory..::.SQLServerType
Used for creating data sources reading from Microsoft SQL Server. The supported server versions can be specified.
InfigoPropertyType
Enumeration for declaring the required property type upon property creation. Possible values are:
  • TEXT Text properies
  • TEXTLIST Textlist properties
  • INTEGER Integer properties
  • DOUBLE Double properties
  • BOOL Boolean properties
PDFHandler..::.BatchOutputType
Specifies the output type for batch operations. Possible values are:
  • PPMLOutput is a PPML file along with the PDF for optimized printing.
  • PDFOutput is a normal PDF file.
PDFHandler..::.ThumbnailFileType
Specifies the output image type for thumbnailing operations. Possible values are:
  • PNG
  • TIFF
  • JPEG
  • BMP
  • GIF