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

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).

HighlightFind

Determines whether to highlight the searched strings.

HighlightTag

Determines whether to highlight tags.

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).

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.

close

Closes the document.

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.

Filter

Filters the document with the specified string and settings.

GetCell

Retrieves the text on the specified cell in a 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.

Redo

Redo the last action undone with the Undo command.

Save

Saves the document.

Undo

Undo the last action.

write

Inserts or overwrites a string at the current cursor position.

writeln

Inserts or overwrites a string and a new line at the current cursor position.

Version

Supported on EmEditor Professional Version 4.00 or later.

Copyright © 2003-2016 by Emurasoft, Inc.