Using JavaScript in HomeSite 4.0, Part II: The DocumentCache Object

Using JavaScript in HomeSite 4.0, Part II

The DocumentCache Object

Caching information shortens its access time and thus boosts the application's performance. HomeSite's cache keeps only the active document in memory. All other open files are stored in a cached array named DocumentCache. Each open document has an element in this array. Its index is the index of the document in the HomeSite's window. This DocumentCache array is a property of the Application Object. For example, if app is an Application Object, the third open document will be cached in app.DocumentCached[2]. Here is a script that loops through the cache array and pops up a message window for each document, displaying its file name:

var app = Application;
function Main() {
  for (i = 0; i < app.DocumentCount; i++) { 
    fileName = app.DocumentCache(i).Filename; 
    app.MessageBox(fileName, "test", 0);
  } 
  app = null;
}

As you will see below, the amount of information you can get from the DocumentCache Object is limited. To get more information about an open file, make it the active document and then use the ActiveDocument Object, as we describe in the following page. To make an open file the active document you need to first find its index from its file name:

i = app.GetTabIndexForFile("U:\\Yehuda\\Column49\\cache.html");

and then make it the active document:

app.DocumentIndex = i;

In the rest of this page we describe the DocumentCache's properties.

Text

Read-only

String

Returns the contents of the cached document. Obviously, the returned string's length is equal to the document's character length.

CanUndo

Read-only

Boolean

Returns a true value if recent changes can be undone.

CanRedo

Read-only

Boolean

Returns a true value if recent changes can be re-done.

Modified

Read-only

Boolean

Returns a true value if the cached document has been modified since it was last saved to disk.

Filename

Read-only

String

Returns the file name of the cached document.

ReadOnly

Read-only

Boolean

Returns a true value if the cached document is read-only.

Produced by Yehuda Shiran and Tomer Shiran

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

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