Class %Projection.StudioDocument

class %Projection.StudioDocument extends %Projection.AbstractProjection

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
5		2

Summary

Methods
%ClassIsLatestVersion	%ClassName	%DispatchClassMethod	%DispatchGetModified
%DispatchGetProperty	%DispatchMethod	%DispatchSetModified	%DispatchSetMultidimProperty
%DispatchSetProperty	%Extends	%GetParameter	%IsA
%OriginalNamespace	%PackageName	CreateProjection	EndCompile
QueueClass	RemoveProjection	SetQueueFlag	getDefaultParam
getROOTDIR

Parameters

• parameter DocumentDescription;

Description of this document type

• parameter DocumentExtension;

Name of the extension for this routine type, e.g. 'ABC'

• parameter DocumentIcon = 0;

Integer to modify the icon that Studio uses to display documents of this type

• parameter DocumentType;

Type of the document, this varies how Studio views this document. Possible values include:

INT - Cache Object Script INT code

MAC - Cache Object Script MAC code

INC - Cache Object Script macro include

CSP - Cache Server Page

CSR - Cache Server Rule

JS - JavaScript code

CSS - HTML Style Sheet

XML - XML document

XSL - XML transform

XSD - XML schema

MVB - Multivalue Basic mvb code

MVI - Multivalue Basic mvi code

If no value specified then Studio will use the null parser for this document.

• parameter XMLNamespace;

Schema associated with this document type, used by Studio Assist

Methods

• classmethod CreateProjection(classname As %String, ByRef parameters As %String) as %Status

This method is called by the Class Compiler whenever an associated class has finished compiling. classname contains the name of the associated class while parameters contains an array of the projection parameters subscripted by parameter name. Also the special parameter value parameters("%qstruct") contains a merge of the qstruct array this projection is being compiled with. The modified for an incremental compile will contain a comma separated list of the methods that were modified and it will be blank for a full compile
Any errors reported by this method are reported by the Class Compiler but do not effect class compilation in any way.

• classmethod RemoveProjection(classname As %String, ByRef parameters As %String, recompile As %Boolean) as %Status

This method is called by the Class Compiler whenever an associated class is either a) about to be recompiled, or b) about to be deleted. classname contains the name of the associated class while parameters contains an array of the projection parameters subscripted by parameter name. Also the special parameter value parameters("%qstruct") contains a merge of the qstruct array this projection is being compiled with. recompile is true (1) if the associated class is about to be recompiled. The modified for an incremental compile will contain the comma separated list of methods that were modified and will be blank for a full compiler.
Any errors reported by this method are reported by the Class Compiler but do not effect class compilation in any way.


[BASEXML] > [%Projection] > [StudioDocument]		Private Storage