Class %Projection.StudioDocument

class %Projection.StudioDocument extends %Projection.AbstractProjection

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
6		2

Summary

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

Subclasses
%IPM.StudioDocument.Projection

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 DocumentNew = 0;

Set to new to make Studio automatically adding a 'new XYZ' item for this document type

• parameter DocumentType;

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

INT - ObjectScript INT code

MAC - ObjectScript MAC code

INC - ObjectScript 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 is always blank.
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 is always blank.
Any errors reported by this method are reported by the Class Compiler but do not effect class compilation in any way.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search