Studio.ExampleDocument
stream class Studio.ExampleDocument extends %Studio.AbstractDocument
Method Inventory
Methods
Compile the document
Delete the document 'name' which includes the document extension
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)
$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
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.
Unlock the current document, default method just unlocks the ^ROUTINE global with the name of the document
Inherited Members
Inherited Properties
- %Location
- AtEnd
- Attributes
- Code
- CompileTime
- Generated
- Id
- LastModified
- LineTerminator
- Locked
- Name
- Size
- TimeStamp
- UpToDate
Inherited Methods
- %AddToSaveSet()
- %CheckUnique()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %Delete()
- %DeleteExtent()
- %DeleteId()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Exists()
- %ExistsId()
- %Extends()
- %GetParameter()
- %GetSwizzleObject()
- %Id()
- %IsA()
- %IsModified()
- %IsNull()
- %KillExtent()
- %LOBPrefetch()
- %LocationSet()
- %LockStream()
- %New()
- %NormalizeObject()
- %ObjectIsNull()
- %ObjectModified()
- %ObjectSize()
- %Oid()
- %Open()
- %OpenId()
- %OriginalNamespace()
- %PackageName()
- %ReleaseLock()
- %Reload()
- %RemoveFromSaveSet()
- %RollBack()
- %Save()
- %SerializeObject()
- %SetModified()
- %UnlockStream()
- %ValidateObject()
- AtEndGet()
- AtEndSet()
- Clear()
- CompileDocument()
- CompileTime()
- CompileTimeGet()
- CopyFrom()
- CopyFromAndSave()
- DeleteAttribute()
- DeleteStream()
- ExportToXML()
- FindAt()
- Flush()
- GetAttribute()
- GetAttributeList()
- GetOther()
- GetPrevious()
- GetStreamId()
- ImportFromXML()
- InputFromDevice()
- IsCharacter()
- IsDefinedAttribute()
- IsEnabled()
- IsGenerated()
- IsMapped()
- IsNull()
- IsUpToDate()
- ItemList()
- LastModifiedGet()
- LineTerminatorSet()
- ListClose()
- LocalizeDescription()
- LockName()
- MoveTo()
- MoveToEnd()
- NextAttribute()
- OpenStream()
- OutputToDevice()
- OutputToDeviceAt()
- Read()
- ReadLine()
- ReadLineIntoStream()
- ReadSQL()
- Rewind()
- SaveAs()
- SaveStream()
- Search()
- SearchRegex()
- SerializeToSyncSet()
- SetAttribute()
- SetAttributeList()
- SizeGet()
- StreamOIDIsNull()
- SyncStreamIn()
- TimeStampGet()
- TranslateExportName()
- UnlockName()
- UpToDateGet()
- Write()
- WriteLine()