The InfigoTemplate type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | InfigoTemplate |
Creates a new InfigoTemplate object.
This object should then be initialized either via a PDFHandler (which does have
an Infigo template open) or an Infigo XML file.
|
Methods
Name | Description | |
---|---|---|
![]() | CreateDocumentProperty |
Creates a new document property.
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.) |
![]() | GetFieldValue |
Returns the value of a field.
|
![]() | GetGlobalValue |
Returns the value of a global variable.
|
![]() | GetHashCode |
Serves as a hash function for a particular type.
(Inherited from Object.) |
![]() | GetLocalValue |
Returns the value of a local variable.
|
![]() | GetSortedControls | Returns a sorted multi-dimensional array of all fields and variables used in that template. This can be used to easily display them as intended in an UI form. The first dimension are reserved for the pages. If the parameter Pages is false, the controls are not sorted by pages, instead, only one element exists in the first dimension. If the parameter Pages is true, the first element are the global variables (if there are any), then come the pages in order (all elements on page 1, then all on page 2) etc. The next dimension are the groups, each element for one group (the groups themselfs are in the order specified by the template designer). The last dimension is for the elements directly (fields, local and global variables) - again order by the template designer. By using that function, it is possible to setup the UI in the way the template designer setup the template without looking furhter into the properties (there is always the possibility to create the order manually by looking at the GroupName, TabID and GroupOrder properties). |
![]() | GetType |
Gets the Type of the current instance.
(Inherited from Object.) |
![]() | Load | Overloaded. |
![]() | LoadFile |
Loads the object with the Infigo XML data stored in a text file.
|
![]() | MemberwiseClone |
Creates a shallow copy of the current Object.
(Inherited from Object.) |
![]() | SetFieldValue |
Helper method to set a field without retrieving the field objects.
Any field type can be the target (text, image, barcode), however,
if the field is using text variables, the method SetLocalValue(String, String, String, Boolean)
must be used instead.
|
![]() | SetGlobalValue |
Helper method to set a global variable without retrieving the variable objects.
|
![]() | SetLocalValue |
Helper method to set a field's local variable value (for text fields with
local variables only).
|
![]() | ToString | (Inherited from Object.) |
![]() | Write |
Write the object data to a string (the string contains the Infigo XML data).
|
![]() | WriteFile |
Write the object data to a text file containing the
Infigo XML data.
|
Properties
Name | Description | |
---|---|---|
![]() | Colours | Returns an array of all colours defined in the template. This colour data can be used to determine the actual reference for alternative colours used on some fields. Furhtermore, the colour names can be used in custom rich text tags. |
![]() | DocumentProperties |
Returns an array of document properties.
The value of non-fixed properties can be changed.
|
![]() | Fields |
Returns an array of fields.
The field value as well as properties and possible local variables can
be modified.
|
![]() | Files | Returns an array of embedded file information objects. This does not return the embedded files directly (see for how to extract the file. |
![]() | GlobalTextVariables |
Returns an array of global text variables.
The variable value of those as well as the properties can be
modified.
|
![]() | IsLoaded |
Returns true if the object is loaded with valid Infigo data.
|
![]() | LastError |
Returns the last error code, which should be checked if
a function doesn't return success.
|
![]() | Layers |
Returns an arrof of layers.
Individual layers can be switched on/off easily.
|
![]() | Pages | Returns an array with page information. Each page might have set a name which is supposed to be displayed in a page overview. |