The ChronoJob object gives access to the configuration of the job that is open: its fields and batch fields (as ChronoJobField objects), document types, output modules, labels and the approval workflow.
Get it with ChronoApp.GetCurrentJob (since v1.0.2.96):
Set job = ChronoApp.GetCurrentJob()
MsgBox job.JobName()
Properties
Type
Property
Description
string
ThumbMenuActionIds
(read-only)
Returns the ids of the actions of the thumbnail (page) menu of the job, separated by commas.
Methods
Returns
Method
Description
short
CreateLabel
(string labelname, string style)
Creates a batch label in the job with the given name and style (CSS style used to paint it). Returns 1 if created.
short
DeleteLabel
(string labelname)
Deletes a batch label of the job. Returns 1 if deleted.
object
GetBatchField
(short Index)
Returns the ChronoJobField object (definition of a batch field) at the given index (0-based).
object
GetBatchFieldByName
(string Name)
Returns the ChronoJobField object (definition of a batch field) by name.
short
GetBatchFieldsCount
()
Returns the number of batch fields defined in the job.
string
GetConfigDirectory
()
Returns the configuration folder of the job (where its config.xml and types are).
string
GetConversionModuleName
(long index)
Returns the name of the conversion module at the given index of the job outputs.
string
GetOutModuleName
(long Index)
Returns the name of the destination (output) module at the given index of the job outputs.
string
GetTypeAction
(string typeGuid)
Returns the action configured for a document type (GUID) when it is detected.
string
GetTypeName
(string typeguid)
Returns the name of a document type of the job from its GUID.
object
GetUserField
(short Index)
Returns the ChronoJobField object (definition of a document field) at the given index (0-based).
object
GetUserFieldByName
(string Name)
Returns the ChronoJobField object (definition of a document field) by name.
short
GetUserFieldsCount
()
Returns the number of document fields defined in the job.
short
HasXModule
(string moduleId)
Returns 1 if the job uses the module with the given id (for example a grid panel or an extra panel).
short
IsApprovalWorkflow
()
Since v1.0.2.96
Returns whether current ChronoJob has the approval workflow activated (enterprise)
Returns: 1 = True, 0 = False
ChronoScan Enterprise only.
Example
Dim isApproval
isApproval = ChronoJob.IsApprovalWorkflow()
short
IsUserApprover
(string username)
Since v1.0.2.96
Returns whether an user is an approver (enterprise)
