Show/Hide Toolbars

EmEditor Help

Navigation: EmEditor Help > Macro Reference

EmEditor Macro Reference: Document Object

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

Document Object

Properties

ActiveString

Retrieves the active string.

BookmarkCount

Retrieves the number of bookmarks in the document.

CellMode

Sets or retrieves a flag indicating whether the selection mode is cell selection mode.

Config

Retrieves the Config Object.

ConfigName

Retrieves or sets the current configuration name.

Csv

Retrieves the Csv Object.

Encoding

Retrieves or sets the current encoding of the opened file.

filters

Retrieves or sets the Filters Collection.

FontCategory

Retrieves or sets the current font category.

FullName

Retrieves the complete path and file name of the document.

HeadingLines

Retrieves or sets the number of lines for headings (non-scrollable area).

HideQuotes

Sets or retrieves a flag indicating whether the Hide Quotes Temporarily mode is enabled in the CSV cell selection mode.

HighlightFind

Determines whether to highlight the searched strings.

HighlightTag

Determines whether to highlight tags.

MemorySize

Retrieves or sets the memory size used.

Name

Retrieves only the file name of the current document.

NarrowingTop

Retrieves or sets the top position (y-axis) of the narrowing (editable area).

NarrowingBottom

Retrieves or sets the bottom position (y-axis) of the narrowing (editable area).

NewlineCode

Retrieves the current newline character code of the document.

Path

Retrieves only the path of the current document.

ReadOnly

Sets the Read-Only status of the document.

Saved

Retrieves or sets the flag indicating whether the document has been modified since last being saved or opened.

selection

Retrieves the Selection Object.

UnicodeSignature

Retrieves or sets the flag indicating whether EmEditor should add the Unicode signature (BOM) next time it saves the document.

Untitled

Retrieves a flag indicating whether the document is untitled.

Methods

Activate

Activates the document.

AutoFill

Performs the AutoFill or Flash Fill action on the CSV document.

Close

Closes the document.

CombineColumns

Combines specified column(s) in a CSV mode.

CombineLines

Combines vertical adjacent duplicate cells of the CSV document.

ConvertCsv

Converts the CSV format.

DeleteColumn

Deletes specified column(s) in a CSV mode.

CopyFullName

Copies the complete path and file name of the document to the Clipboard.

CopyPath

Copies only the path of the document to the Clipboard.

DeleteDuplicates

Deletes duplicate lines, or sets bookmarks on duplicate lines.

ExtractColumns

Extracts the specified columns of the CSV document.

Filter

Filters the document with the specified string and settings.

GetCell

Retrieves the text on the specified cell in a CSV mode.

GetColumn

Retrieves a column of text in CSV mode.

GetColumns

Retrieves the number of columns in a CSV mode.

GetLine

Retrieves the text on the specified line.

GetLines

Retrieves the number of the lines in the document.

InsertColumn

Inserts a column of text in CSV mode.

LogicalToSerial

Converts the logical coordinates of a specified position to the one-based serial position.

LogicalToView

Converts the logical coordinates of a specified position to the display coordinates, and retrieves the position in the Point object.

MoveColumn

Moves or copies specified column(s) in a CSV mode.

Numbering

Inserts numbering at the cursor position or vertical selection.

Redo

Redo the last action undone with the Undo command.

Save

Saves the document.

SerialToLogical

Converts a serial position to the logical coordinates, and retrieves the position in the Point object.

SetCell

Sets the text on the specified cell in a CSV mode.

SetColumn

Sets a column of text in a CSV mode.

Sort

Sorts the document.

SplitColumn

Splits column(s) by a specified separator and put them into right columns or lines beneath in a CSV mode.

Undo

Undo the last action.

ValidateCsv

Validates the CSV document and output errors, and optionally adjusts separator positions.

ViewToLogical

Convert the display coordinates of a specified position to the logical coordinates, and retrieves the position in the Point object.

write

Inserts or overwrites a string at the current cursor position.

writeln

Inserts or overwrites a string and a newline character at the current cursor position.

Version

Supported on EmEditor Professional Version 4.00 or later.

Copyright © 2003-2021 by Emurasoft, Inc.