Programming API User 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_timestamp	Adds a time stamp to the output file name. Can be true or false.	Property
AddItem	Creates a variable or an object of a required type and adds it to the list of component's variables.	Function
AddScript	Adds a scriptlet to the TextConverter's script.	Function
AddTemplate	Adds an input template to a project.	Function
append	Adds a time stamp to the output file name. Can be true or false.	Property
AppendRecord	Inserts the current output record into the output database table.	Function
AppendStart	Clears output fields. Call this function after calling AppendRecord from script if you need to clean up the output fields.	Function
batch	The batch processing object.	Object
Cancel	Cancels the data extraction process.	Function
case_sensitive	This property controls case sensitivity for all string operations for the project. Can be true or false.	Property
cleanup	The object defining cleaning rules for junk symbols.	Object
CleanupInputFiles	Leaves, deletes or moves input files after the data extraction is finished.	Function
CloseInputFile	Closes the input file.	Function
CloseOutputDS	Closes the output data source, it can be called only from OnFinishProcess context method.	Function
Convert	Runs the data extraction process.	Function
DeleteItem	Deletes a variable or an object.	Function
DeleteTemplate	Deletes a project's input template.	Function
DeleteTemplates	Deletes all input templates.	Function
field_delimiter	A character string specifying a field separator.	Property
file_output	This property specifies if output to a file/table is needed. Can be true or false.	Property
first_line	The 1-based index of input file's first line.	Property
first_page	The 1-based index of input file's first page.	Property
FreezeUI	Prevents all user interface activity while modifying a project through script.	Function
GetBatchCount	Gets the number of currently processed batches.	Function
GetComment	Returns the component's comment.	Function
GetDBConverter	Gets DBConverter object integrated into this TextConverter.	Function
GetFFR	Gets Free Form Report object integrated into the TextConverter.	Function
GetFilePosition	Gets a file position in the input text file.	Function
GetInputFile	Gets an input file's full path or just a name and extension or a sheet name.	Function
GetInputRecordNumber	Gets an index of the current input record.	Function
GetItem	Returns a variable or an object by name.	Function
GetItems	Returns the list of names of project's variables/objects.	Function
GetLine	Gets the input line's content.	Function
GetLineNumber	Gets an index of the current input line	Function
GetName	Returns TextConverter's name.	Function
GetOutputDictionary	Returns the output dictionary object.	Function
GetOutputDS	Returns the output data source object.	Function
GetOutputFields	Returns output field names.	Function
GetOutputRecordCount	"Gets the current number of the output records.	Function
GetPageNumber	Gets the current page number.	Function
GetProjectFile	Returns the project's file name.	Function
GetScript	Gets TextConverter's script.	Function
GetStartPath	Returns a file path to the location from where the TextConverter component was started.	Function
GetTemplate	Returns an input template object by a template name or index.	Function
GetTemplateCount	Returns the number of input templates.	Function
GetTextColor	Returns a text color from a specified position in the input file.	Function
GetTextSize	Returns a text size from a specified position in the input file.	Function
GetToolTip	Returns the component's tooltip.	Function
GetTR	Gets TARGET Reports object integrated into the TextConverter.	Function
GetType	Returns component's type.	Function
GetVersion	Returns the current TARGET version.	Function
GetWorkPath	Returns a file path to the component's working folder.	Function
GoTo	Changes the current TextConverter positions in the input file.	Function
IsRunning	Returns true if TextConverter is running in the processing mode vs. the preview mode.	Function
IsValid	Checks if the project is ready to run.	Function
last_page	The 1-based index of input file's last page.	Property
LimitInput	Limits the run-time number of input records or pages to the number of preview records or pages.	Function
MoveTemplate	Moves an input template.	Function
NewProject	Creates a new TextConverter project.	Function
OnFile	Implement custom scripts for file parsing properties such as ranges and skips. OnFile accepts one parameter.	Context Method
OnFinishBatch	OnFinishBatch is called upon finishing the last file in the batch.	Context Method
OnFinishProcess	OnFinishProcess 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
OnInputField	Implement 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
OnInputLine	OnInputLine is called for every line in the input file.	Context Method
OnInputRecord	OnInputRecord is called for each input record of every template before the corresponding output record is inserted into the output database table.	Context Method
OnOutputRecord	OnOutputRecord is called before an output record is inserted into the output database table.	Context Method
OnSetup	OnSetup is called before connections to all data-sources used or referenced are established, allowing you to safely alter input/output data-sources.	Context Method
OnSetupBatch	OnSetupBatch is called before a batch processing begins. Batch properties can be modified here.	Context Method
OnStartProcess	OnStartProcess is called before the first input record is processed.	Context Method
OnTemplate	Implements custom scripts for template's properties such as filters, ranges, and skips.	Context Method
OpenProject	Opens a TextConverter project file.	Function
page_break	The object defining page breaks.	Object
post_processing	Runs integrated processes upon the data extraction completion. Can be true or false.	Property
range	The object defining filtering by vertical ranges.	Object
record_delimiter	A character string specifying a record separator.	Property
RemoveScript	Remove scriptlet from the component's script.	Function
RenameItem	Renames component's variables.	Function
ResetOutput	Truncates an output table (or file) or resets an output destination while in process.	Function
SaveProject	Saves the current TextConverter project to a file.	Function
scanned_image	Turns ON the special handling of files which went through the OCR process. Can be true or false.	Property
SetComment	Sets the component's comment.	Function
SetFilePosition	Changes TextConverter's starting position in the input file.	Function
SetInputFile	Sets the input file.	Function
SetName	Sets the component's name.	Function
SetPassword	Sets a password for an input or an output file.	Function
SetScript	Set TextConverter's script.	Function
SetToolTip	Sets the component's tooltip.	Function
SetUnicodeOutput	Sets the output text encoding to UNICODE [true] or ANSI [false].	Function
skip	The object defining the line skipping behavior.	Object
SkipFile	Skips a file during a batch processing.	Function
SkipRecord	Call 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
SuppressDuplicates	Suppresses duplicate input records.	Function
supress_empty_lines	Skips empty lines in the input text. Can be true or false.	Property
text_qualifier	A character that separates blocks of text, within which all field and record delimiters are ignored.	Property
UpdateUI	Updates user interface after script-based modifications are finished.	Function
uppercase_output	Makes all output characters upper case. Can be true or false.	Property
use_narrow_fonts	Tells 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