TextPipe COM interface

startFilters()

first, and then call

endFilters()

when you have finished adding or changing. These function turn off the GUI, making adding filters much faster. They also prevent the GUI settings from overwriting the settings you make.

To create sub filters, you must surround each set of sub filters like this:

startSubfilters()

...define filters here...

endSubfilters()

Moves the child filter so that it becomes the last child sub filters of the parent filter. You must determine if this action is legal or not yourself - TextPipe does no error checking.

Type - the type of filter to add

0 Delete column
1 Restrict lines
2 Restrict columns
3 Not used
4 Restrict CSV fields
5 Restrict tab-delimited fields
6 Remove lines
7 Remove CSV fields
8 Remove Tab-delimited fields
9 Move columns
10 Move CSV columns
11 Move Tab-delimited columns
12 Copy columns
13 Copy CSV columns
14 Copy Tab-delimited columns

Locate Method - how to determine which areas to affect

0 Restrict %d .. %d
1 Restrict %1:d starting at %0:d
2 Restrict %1:d starting at END - %0:d
3 Restrict %d .. END - %d
4 Restrict END - %d .. END - %d

param1, param2 - the required integer values for the locate method

moveTo : integer - where to move or copy the columns or fields to. Default 1.

processIndividually - whether or not to apply sub filters to each CSV or Tab field individually, or to the fields as one string value. Default false.

excludeDelimiter - whether or not to include the comma or Tab field delimiter when passing the field to the sub filter. Default true.

excludeQuotes - whether or not to include the CSV quotes that may surround the field when passing the field to the sub filter. Default true.

type

0 Restrict lines matching
1 Restrict lines NOT matching
2 Extract
3 Retain matching lines
4 Retain non-matching lines
5 Remove matching lines
6 Remove non-matching lines

pattern - the pattern to match

includeLineNumbers - true to include the line number where the pattern was found, default False

includeFilename - true to include the filename where the pattern was found, default False

ignoreCase - ignore case when matching the pattern, default True

countMatches - true to only output a count of the number of matches, default False

patternType

0 Perl pattern
1 Egrep pattern
2 Brief pattern
3 MS Word pattern
4 EasyPattern

type

0 Split at a given size
1 Split at a given character
2 Split at a given number of lines

splitSize - the size file to split at

splitChar - the character to split at

splitCharPos -

0 Split before the character (it goes into the next file)
1 Split after the character (it remains in the first file)
2 Split on top of the character (remove it)

SplitCharCount - the number of times to see SplitChar before splitting

SplitLines - split after a given number of lines

SplitFilename - the name to give to each output split file

type

0 Merge into filename
1 Retain lines found in filename
2 Remove lines found in filename
3 Link filter filename

filename - the filename to use

includeOrExclude - whether to include or exclude the text, False for Include, True for Exclude

linesOrBytes - measure in terms of lines or bytes, False for Lines, True for Bytes

startOrEnd - measure from the start or end of the file, False for Start, True for End

Count - the count of lines or bytes to include or exclude

commandLine - the command line of the program to run. Should include double quotes around long filenames, and also usually includes the input and output filename.

inputFilename - the filename that TextPipe should read from after the External Program writes to it.

outputFilename - the filename that  TextPipe should write to for the External Program to read in.

type - the sort type

0 ANSI sort (case insensitive)
1 ANSI sort (case sensitive)
2 ASCII sort (case insensitive)
3 ASCII sort (case sensitive)
4 Numeric sort
5 Sort by length of line
6 Sort by date and time
7 Sort by date
8 Sort by time

reverse - whether to reverse the normal sort order, when set to True the order is Descending, default false

removeDuplicates - whether to remove duplicate values or not, default true

startColumn - the column to start comparisons from

length - the length of the comparison

type -

0 Remove duplicate lines
1 Show duplicate lines

ignoreCase - whether to ignore case during comparisons or not

startColumn - the starting column for the comparison

length - the length of the comparison

searchStr - the string to search for

replaceStr - the string to replace it with

type - the find type:

0 Replace
1 Pattern (old style)
2 Sounds like
3 Edit distance
4 Perl pattern
5 Brief pattern
6 Word pattern
7 EasyPattern

matchCase - Matches case when set to True, ignores case when set to false (default)

wholeWord - Matches whole words only when set to True, default false

caseSensReplace - Replaces with matching case when set to True, default false

promptOnReplace - Prompts before replacing when set to True, default false

extract - when True, all non-matching text is discarded, default false

firstOnly - when True, only replace the first occurrence, default False

skipPromptIdentical - when True, don't bother prompting if the replacement text is identical to the original.

filename - the file to load search/replace pairs from

Other options - as above.

bufferSize - the maximum buffer size to use for matches. Any match must fit into this buffer, so if you want to match larger pieces of text, increase the size of this buffer to suit. Default 4096.

greedy - if the pattern finds the longest match (greedy) or the shortest match. Default false.

allowComments - allow comments in the perl pattern. Default false.

dotMatchesNewLines - allow the '.' operator to match all characters, including new lines. Default true.

type - the type of filter to add

0 Convert Tabs to %d spaces
1 Convert %d spaces to Tabs
2 Word wrap (column width %d)
3 Pad to width of %d
4 Centre in width of %d
5 Right justify in width of %d
6 Restrict CSV field %d
7 Restrict tab-delimited field %d
8 Truncate to width %d
9 Force to width %d
10 Repeat file %d times

Value - the numeric value to use

insertPos - the position to insert the string

insertString - the string to insert

connectionStr - the database connection string.

mode

0 Delimited output
1 Fixed width
2 XML
3 Insert script

fieldDelimiter - the string to use between columns

textQualifier - the string to use around string column values

generateHeader - generates header information when True

insertTable - the name of the insert table

timeout - SQL command timeout in seconds, default 30

filename - the filename containing the map

See also prepareMapFilter

setMap( characterIndex : integer, outputString : string )
setMap( characterIndex : integer, outputString : string )
setMap( characterIndex : integer, outputString : string )
...

See also addMapFilter

setUnicodeMap2( startRange, endRange, outputString : string )
setUnicodeMap( characterIndex : integer, outputString : string )
setUnicodeMap( characterIndex : integer, outputString : string )
setUnicodeMap( characterIndex : integer, outputString : string )
...

unenteredValue:

• 0 - Pass through unchanged
• 1 - Pass to subfilter
• 2 - Replace with value (use next option to specify it)
• 3 - Remove

Replace with:

The string to replace it with, if the Replace Type is 2.

inputLineFeeds - the type of incoming line feeds

0 Unix
1 Mac
2 DOS
3 Auto
4 Fixed (use the fixedLength parameter to specify the length)

fixedLength - the length of fixedLength input files when option #4 is chosen above.

outputLineFeeds - the type of outgoing line feeds

0 Unix
1 Mac
2 DOS
3 None
4 String (use the newLineFeed parameter to specify the new string)

newLineFeed - the new line feed string on output when option #4 is chosen.

removeBadEOLs - whether to remove bad EOLs or not

type - the type of filter to add.

1 Convert ASCII to EBCDIC
2 Convert EBCDIC to ASCII
3 Convert ANSI to OEM
4 Convert OEM to ANSI
5 Convert to UPPERCASE
6 Convert to lowercase
7 Convert to Title Case
8 Convert to Sentence Case
9 Convert to tOGGLE cASE
10 Remove blank lines
11 Remove blanks from End of Line
12 Remove blanks from Start of Line
13 Remove binary characters
14 Remove ANSI codes
15 Convert IBM drawing characters
16 Remove HTML and SGML
17 Remove backspaces
18 Resolve backspaces
19 Remove multiple whitespace
20 UUEncode
21 Hex Encode
22 Hex Decode
23 MIME Encode (Base 64)
24 MIME Decode (Base 64)
25 MIME Encode (Quoted printable)
26 MIME Decode (Quoted printable)
27 UUDecode
28 Extract email addresses
29 Unscramble (ROT13)
30 Hex dump
32 XXEncode
33 XXDecode
34 Reverse line order
35 Remove email headers
36 Decimal dump
37 HTTP Encode
38 HTTP Decode
39 Randomize lines
40 Create word list
41 Reverse each line
42 Convert to RanDOm case
43 Extract URLs
44 ANSI to Unicode
45 Unicode to ANSI
46 Display debug window
47 Word concordance
48 Delete all
49 Restrict to each line in turn
50 Convert CSV to Tab-delimited
51 Convert CSV to XML' )
52 Convert Tab-delimited to CSV
53 Convert Tab-delimited to XML
54 Convert CSV (with column headers) to XML
55 Convert Tab-delimited (with column headers) to XML
 

addStringFilterFile( type : integer, filename : string ) : treenode

type - the type of filter to add

0 Add left margin
1 Add header
2 Add footer
3 Add right margin
4 Remove lines
5 Retain lines
6 Remove lines matching perl pattern
7 Retain lines matching perl pattern
8 Add text side by side
9 Add repeating text side by side

str - the string to use

filename - the filename to use

startNumber - the starting line number

increment - the amount to add for each new line number

skipBlankIncrement  - don't increase the line number for blank lines

dontNumberBlank - don't put a line number on blank lines

numberFormat - the format to use for the line number

language - the language of the script

script - the code

timeout - the command timeout in seconds, default 30

comment - the comment.

operation - the operation to perform

0 +
1 -
2 *
3 div (the remainder is ignored)
4 mod (the remainder after division)
5 xor
6 and
7 or
8 not
9 shift left (0 inserted)
10 shift right (0 inserted)
11 rotate left
12 rotate right

operand - the operand to use

0 Output to clipboard (all files are joined together)
1 Output to files
2 Output merged (joined) to a single file

0 Input from clipboard
1 Input from files (default). You can add files using the addFile function.
2 Input from Trial Run area. You can set the Trial Run text using the trialInput property
3 Input from random file generator. You can set the

value (default 0)

0 Binary files are processed
1 Binary files are skipped
2 Binary files are confirmed before processing

Returns true on success, False on failure (with error message in errorText)

Returns true on success, False on failure (with error message in errorText)

If an error occurs, errorText will be set to the error message, or blank if there is no error.

Returns a blank string on success, error message on failure. errorText is also cleared if there is no error, or set if there is an error.

compiledFilterStartJob() - this function prepares a compiled filter for processing.

compiledFilterEndJob() - this function completes a compiled filter's processing.

fileSpec - the filename, folder or wildcard

subfolders - how many subfolders to include (default 255)

0 No subfolders
1..9 1..9 Subfolder(s)
255 All subfolders

action - the action column (default 1)

1 Add the files
2 Subtract the files
3 Ignore the files

filename - the list of files is contained in this file.