Programming APIUser Interface
Help
 
 
Text Converter

SiMX TextConverter is a powerful and easy-to-use tool for extracting data from popular document formats such as PDF, DOC, RTF, XLS, HTML, CSV, XML, or just about any file that contains the text.
TextConverter offers a flexible and intuitive visual interface combined with advanced support for scripting and professional programmers.

 Methods and properties
add_timestampAdds a time stamp to the output file name. Can be true or false.Property
AddItemCreates a variable or an object of a required type and adds it to the list of component's variables.Function
AddScriptAdds a scriptlet to the TextConverter's script.Function
AddTemplateAdds an input template to a project.Function
appendAdds a time stamp to the output file name. Can be true or false.Property
AppendRecordInserts the current output record into the output database table.Function
AppendStartClears output fields. Call this function after calling AppendRecord from script if you need to clean up the output fields.Function
batchThe batch processing object.Object
CancelCancels the data extraction process.Function
case_sensitiveThis property controls case sensitivity for all string operations for the project. Can be true or false.Property
cleanupThe object defining cleaning rules for junk symbols.Object
CleanupInputFilesLeaves, deletes or moves input files after the data extraction is finished.Function
CloseInputFileCloses the input file.Function
CloseOutputDSCloses the output data source, it can be called only from OnFinishProcess context method.Function
ConvertRuns the data extraction process.Function
DeleteItemDeletes a variable or an object.Function
DeleteTemplateDeletes a project's input template.Function
DeleteTemplatesDeletes all input templates.Function
field_delimiterA character string specifying a field separator.Property
file_outputThis property specifies if output to a file/table is needed. Can be true or false.Property
first_lineThe 1-based index of input file's first line.Property
first_pageThe 1-based index of input file's first page.Property
FreezeUIPrevents all user interface activity while modifying a project through script.Function
GetBatchCountGets the number of currently processed batches.Function
GetCommentReturns the component's comment.Function
GetDBConverterGets DBConverter object integrated into this TextConverter.Function
GetFFRGets Free Form Report object integrated into the TextConverter.Function
GetFilePositionGets a file position in the input text file.Function
GetInputFileGets an input file's full path or just a name and extension or a sheet name.Function
GetInputRecordNumberGets an index of the current input record.Function
GetItemReturns a variable or an object by name.Function
GetItemsReturns the list of names of project's variables/objects.Function
GetLineGets the input line's content.Function
GetLineNumberGets an index of the current input lineFunction
GetNameReturns TextConverter's name.Function
GetOutputDictionaryReturns the output dictionary object.Function
GetOutputDSReturns the output data source object.Function
GetOutputFieldsReturns output field names.Function
GetOutputRecordCount"Gets the current number of the output records.Function
GetPageNumberGets the current page number.Function
GetProjectFileReturns the project's file name.Function
GetScriptGets TextConverter's script.Function
GetStartPathReturns a file path to the location from where the TextConverter component was started.Function
GetTemplateReturns an input template object by a template name or index.Function
GetTemplateCountReturns the number of input templates.Function
GetTextColorReturns a text color from a specified position in the input file.Function
GetTextSizeReturns a text size from a specified position in the input file.Function
GetToolTipReturns the component's tooltip.Function
GetTRGets TARGET Reports object integrated into the TextConverter.Function
GetTypeReturns component's type.Function
GetVersionReturns the current TARGET version.Function
GetWorkPathReturns a file path to the component's working folder.Function
GoToChanges the current TextConverter positions in the input file.Function
IsRunningReturns true if TextConverter is running in the processing mode vs. the preview mode.Function
IsValidChecks if the project is ready to run.Function
last_pageThe 1-based index of input file's last page.Property
LimitInputLimits the run-time number of input records or pages to the number of preview records or pages.Function
MoveTemplateMoves an input template.Function
NewProjectCreates a new TextConverter project.Function
OnFileImplement custom scripts for file parsing properties such as ranges and skips. OnFile accepts one parameter.Context Method
OnFinishBatchOnFinishBatch is called upon finishing the last file in the batch.Context Method
OnFinishProcessOnFinishProcess is called after the last input record is processed. Implement this method if you want to customize the final actions after the conversion process is done.Context Method
OnInputFieldImplement custom scripts for input field's properties such as tags, filters, ranges, and skips. OnInputField requires three Parameters: Function OnInputField(template, field, code) 'Codes:tag,ttag,btag,skip,skipto'.Context Method
OnInputLineOnInputLine is called for every line in the input file.Context Method
OnInputRecordOnInputRecord is called for each input record of every template before the corresponding output record is inserted into the output database table.Context Method
OnOutputRecordOnOutputRecord is called before an output record is inserted into the output database table.Context Method
OnSetupOnSetup is called before connections to all data-sources used or referenced are established, allowing you to safely alter input/output data-sources.Context Method
OnSetupBatchOnSetupBatch is called before a batch processing begins. Batch properties can be modified here.Context Method
OnStartProcessOnStartProcess is called before the first input record is processed.Context Method
OnTemplateImplements custom scripts for template's properties such as filters, ranges, and skips.Context Method
OpenProjectOpens a TextConverter project file.Function
page_breakThe object defining page breaks.Object
post_processingRuns integrated processes upon the data extraction completion. Can be true or false.Property
rangeThe object defining filtering by vertical ranges.Object
record_delimiterA character string specifying a record separator.Property
RemoveScriptRemove scriptlet from the component's script.Function
RenameItemRenames component's variables.Function
ResetOutputTruncates an output table (or file) or resets an output destination while in process.Function
SaveProjectSaves the current TextConverter project to a file.Function
scanned_imageTurns ON the special handling of files which went through the OCR process. Can be true or false.Property
SetCommentSets the component's comment.Function
SetFilePositionChanges TextConverter's starting position in the input file.Function
SetInputFileSets the input file.Function
SetNameSets the component's name.Function
SetPasswordSets a password for an input or an output file.Function
SetScriptSet TextConverter's script.Function
SetToolTipSets the component's tooltip.Function
SetUnicodeOutputSets the output text encoding to UNICODE [true] or ANSI [false].Function
skipThe object defining the line skipping behavior.Object
SkipFileSkips a file during a batch processing.Function
SkipRecordCall this method from your implementation of the OnRecord context methods to indicate that the current output record should not be inserted into the output database table.Function
SuppressDuplicatesSuppresses duplicate input records.Function
supress_empty_linesSkips empty lines in the input text. Can be true or false.Property
text_qualifierA character that separates blocks of text, within which all field and record delimiters are ignored.Property
UpdateUIUpdates user interface after script-based modifications are finished.Function
uppercase_outputMakes all output characters upper case. Can be true or false.Property
use_narrow_fontsTells TextConverter to use narrow versions of PDF fonts. Can be true or false.Property
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
   
 
add_timestamp
Adds a time stamp to the output file name. Can be true or false.
 
add_timestamp