Using JavaScript in HomeSite 4.0, Part II: The ActiveDocument Object's Methods, Part I

Using JavaScript in HomeSite 4.0, Part II

The ActiveDocument Object's Methods, Part I

In this page we start describing the ActiveDocument Object's methods.

Clear()

None

Clears all text from the active document, i.e. erases the active document.

Close(promptToSaveFlag)

Boolean

Closes the active document. The user is prompted if promptToSaveFlag is true. Returns true if the document was closed, i.e. the user did not cancel the prompt for saving.

GetCaretPos(x, y)

Boolean

Returns the caret (insertion point or I beam) position. The column position is denoted by x and the line position is y. Does not work in JavaScript because there is no way to pass parameters by reference between a JavaScript script and ActiveScript methods.

GetNextChar()

Character

Returns the next character after the insertion point (I Beam). For example, if the insertion point is before the character "r" in the word "erase", this method will return the character "a". Can be significantly slow when used in long loops.

GetPreviousChar()

Character

Returns the character before the insertion point (I Beam). For example, if the insertion point is before the character "r" in the word "erase", this method will return the character "e". Can be significantly slow when used in long loops.

GotoNextStartTag(selectItFlag)

Boolean

Moves the insertion point (I Beam) to the next starting tag, and selects the tag if the selectItFlag is true. Returns a false value if no tag is found until the end of the document.

GotoPreviousStartTag(selectItFlag)

Boolean

Moves the insertion point (I Beam) to the previous starting tag, and selects the tag if the selectItFlag is true. Returns a false value if no tag is found until the beginning of the document.

GotoNextEndTag(selectItFlag)

Boolean

Moves the insertion point (I Beam) to the next end tag, and selects the tag if the selectItFlag is true. Returns a false value if no tag is found until the end of the document.

GotoPreviousEndTag(selectItFlag)

Boolean

Moves the insertion point (I Beam) to the previous end tag, and selects the tag if the selectItFlag is true. Returns a false value if no tag is found until the beginning of the document.

Produced by Yehuda Shiran and Tomer Shiran

Created: September 27, 1999
Revised: September 27, 1999

URL: https://www.webreference.com/js/column49/activemet1.html