Home > Class Reference > ENSLIB namespace > Ens.Util.ProjectTextDocument

Ens.Util.ProjectTextDocument

class Ens.Util.ProjectTextDocument extends %Studio.AbstractDocument

Studio Document used to store arbitrary text documents in a Project file and edit them in Studio.

Method Inventory (Including Private)

Parameters

parameter EXTENSION = .PTD;

Methods (Including Private)

classmethod CompileTime(pName As %String) as %TimeStamp
Return the compile time of routine 'pName' in %TimeStamp format. The format should be $zdatetime($horolog,3), or "" if the routine does not exist.
classmethod Create(pText As %String, pName As %String, pDescription As %String = "") as %Status
Save a text document into global storage as a PTD document
classmethod Delete(pName As %String) as %Status
Delete the named PTD document pName.
classmethod Exists(pName As %String) as %Boolean
Return 1 if the given project text PTD document exists and 0 if it does not.
method ExportToXML(flags As %String) as %Status
Export this document to the current device in XML format
classmethod GetStream(Output pStream, pName As %String, Output pDescription As %String) as %Status
Get the content of a PTD document from global storage into a stream object
classmethod GetString(pName As %String, Output pDescription As %String, Output pStatus As %Status) as %String
Get the content of a PTD document from global storage and return it as a string
method ImportFromXML(stream As %RegisteredObject, flags As %String) as %Status
Import from the stream in XML format. Note that the line endings are normalized to CRLF (i.e. $char(13,10)) to simplify parsing.
classmethod ListClose(ByRef qHandle As %Binary) as %Status
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
method Load() as %Status
Load the PTD text from the global into a Code stream
method Save() as %Status
Save the PTD text document into the global
classmethod TimeStamp(pName As %String) as %TimeStamp
Return the timestamp of text document 'pName' in %TimeStamp format, i.e. $zdatetime($horolog,3). This is used to determine if the document has been updated on the server and so needs reloading into Studio. So the format should be $zdatetime($horolog,3), or "" if the category does not exist.

Queries

query List(Directory As %String, Flat As %Boolean, System As %Boolean)
Selects name As %String, modified As %TimeStamp, size As %Integer, directory As %String

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)