Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Macro Reference > Document Object > Methods

EmEditor Macro Reference: InsertColumn Method

Scroll Prev Top Next More
EmEditor Home - EmEditor Help - EmEditor Macro Reference - Document Object

InsertColumn Method

Inserts a column of text in CSV mode.

[JavaScript]

document.InsertColumn( iColumn, strInsert, strDelimiter, flags, yTop, yLines );

[VBScript]

document.InsertColumn( iColumn, strInsert, strDelimiter, flags, yTop, yLines )

Parameters

iColumn

Specifies the index of the column.

strInsert

Specifies the string to insert. The string can be separated by the delimiter specified in strDelimiter. If this is omitted, an empty string is used.

strDelimiter

Specifes the delimiter to separate the string specified in strInsert. If this is empty or omitted, the same string is used for every cell in the column.

flags

Specifies one of the following values. If omitted, eeAutoQuote is specified.

eeAutoQuote

Checks whether the string contains delimiters, newlines, or quotes, and escape those characters and add quotes if necessary.

eeDontQuote

Don't do the above process.

eeAlwaysQuote

Always add quotes.

yTop

Specifies a line number of the first line to insert. If omitted, the first line is specified.

yLines

Specifies the number of lines to insert as a limit. If this is zero or omitted, no limit is specified.

Examples

The following example inserts an empty column on the left side of the third column, and combines the first and second columns and set as third column. A CSV document must be active before this macro is run. Since a linefeed (\n, Chr(10)) is used as a delimiter, we assume that each cell does not contain a linefeed.

[JavaScript]

nLines = document.GetLines() - 1;

s3 = "";

for( y = 1; y <= nLines; y++ ) {

   s1 = document.GetCell( y, 1, eeCellIncludeNone );

   s2 = document.GetCell( y, 2, eeCellIncludeNone );

   s3 += s1 + " " + s2 + "\n";

}

document.InsertColumn( 3, s3, "\n", eeAutoQuote );

[VBScript]

nLines = document.GetLines() - 1

s3 = ""

For y = 1 To nLines

   s1 = document.GetCell( y, 1, eeCellIncludeNone )

   s2 = document.GetCell( y, 2, eeCellIncludeNone )

   s3 = s3 + s1 + " " + s2 + Chr(10)

Next

document.InsertColumn 3, s3, Chr(10), eeAutoQuote

Version

Supported on EmEditor Professional Version 16.7 or later.

Copyright © 2003-2021 by Emurasoft, Inc.