This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?


stream class Studio.ExampleDocument extends %Studio.AbstractDocument

Method Inventory


method Compile(flags As %String) as %Status
Compile the document
classmethod Delete(name As %String) as %Status
Delete the document 'name' which includes the document extension
classmethod Exists(name As %String) as %Boolean
Return 1 if the document 'name' exists and 0 if it does not.
classmethod ListExecute(ByRef qHandle As %Binary, Directory As %String, Flat As %Boolean, System As %Boolean) as %Status
classmethod ListFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
This should return a Row in the form:
$listbuild(name,date/time modified,size,directory delimiter)
  • name - The name to display in the open dialog
  • date/time modified - In %TimeStamp format the date/time this item was last modified
  • size - The size of this item
  • directory delimiter - If this is not an directory then return "" here, if it is a directory then return the type of delimiter to use when they double click on this directory
method Load() as %Status
Load the document into the stream Code
method Lock(flags As %String) as %Status
Lock the current document, default method just locks the ^ROUTINE global with the name of the document. If it fails then return a status code of the error, otherise return $$$OK
method Save() as %Status
Save the document stored in Code
classmethod TimeStamp(name As %String) as %TimeStamp
Return the timestamp of document 'name' in %TimeStamp format. This is used to determine if the document has been updated on the server and so needs reloading into Studio. The format should be $zdatetime($horolog,3), or "" if the document does not exist.
method Unlock(flags As %String) as %Status
Unlock the current document, default method just unlocks the ^ROUTINE global with the name of the document

Inherited Members

Inherited Properties

Inherited Methods