Properties & Methods

TextConverter properties and methods include some very useful functions that are implemented by the TextConverter object. Using these methods you can access different TextConverter objects and their data or modify TextConverter's default behavior. The TextConverter object is accessible by the "this" name, but the "this." word could be omitted. All TextConverter object's top level properties and methods accessible just by their names.Hint: In the script editor start typing "this." (note the dot "." after the word "this") and then choose a desired method from the list. Note: Most methods can be used strictly in the context methods, which are called on a per-input-record basis (OnRecord, OnRecordDone). The only exception is IsRunning method, which can be called in any context method

Here's the list of properties and methods with a brief description

Properties:

append - controls output table's appending mode

DictIn (Dx) - objects which represents template's input dictionary

DictOut - an object which represents the output dictionary

DSOut - an instance of a DataSource (DS) object, which represents the output

text_qualifier - separate a block of text, within which all field and record delimiters are ignored

Methods (available in all modes)

GetLine()

GetText()

GetVar()

Only available in the Auto mode

GetRecordNumber()

GetLineNumber( template )

Only available in the Manual mode

GetLineNumber()

GoNext()

Available for a rich text input only

GetPageNumber()

FStrGet()

FStrCat

FStrMid

IsFontBold

IsFontItalic

3. System Buffer Management Methods (Advanced):

this.AppendRecord - Inserts the current output record into the output database table

this.AppendStart - Prepares for a record insertion into the output database table

this.Cancel() - Call this function to stop the conversion procedure

this.CloseInputFile - Call this to close the input file

this.CloseOutputDS - Call this function to close the output data source

this.Find - This will find a string within a field or record

this.FStrGet() - Call this function to receive extended information about a string

this.GetDictIn - This returns the input dictionary

this.GetInputFields() - Use this function to grab input fields names to insert into an output field

this.GetInputFields - Get the input fields

this.GetInputFile() - Inserts the current input data source file name into the output database table

this.GetItem - Retrieves an item

this.GetLine - Calling this method will retrieve a line based on several parameters

this.GetName - This will get the name of a field.

this.GetOutputFields() - Use this function to grab output fields names to insert into an output field

this.GetPageNumber - Inserts the page number from which the record was obtained into the output

this.GetProjectFile - Call this method to retrieve a project file

this.GetRecordNumber() - Calls on the record number to use as part of a function

this.GetRecordNumber - Calling this will get the number of records of a template index

this.GetText - Retrieves text from input based on various parameters.

this.GetValueByTag - Use GetValueByTag when the input fields are marked by tags and are not separated by constant delimiters

this.GetVar - Call this function to set the variable both in and out of TextConverter in automation (API)

this.GoNext/this.GoToN - Call this function to move through the records of the selected database

this.IsDelimited() - IsDelimited separates records extracted by implied delimiters from other text data in the document

this.IsRunning - The function is helpful if some portions of your script should run in the real mode only, not in the preview mode

this.SetInputFile() - Defines the input file if processing multiple documents

this.SkipRecord() - This function is usually used with a heterogeneous input text when multi-level information should be filtered out in order to insert only a specific level into the output database