Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [apptools] >  [core] >  [Form]
Private  Storage   

abstract class apptools.core.Form

The representation of the stored classes for viewing and editing

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 25


Summary

Methods
BlockUI ButtonBack ButtonMake ButtonRef
DrawTable GetJsonProp GetObj GetPropVal
GetPropertyDefinition GetSubclassOf GetValueByIdField GetValueByName
GetValueProperty ObjectDelete ObjectNew ObjectSave
ObjectSaveAsNew SelectField SelectFieldYesNo SelectObj
Show ShowProp UikitNote WebCompShowCheckbox
WebCompShowFiles


Parameters

• parameter PREFIXFIELD = "appfield";
prefix the field name of the object

Methods

• classmethod BlockUI(mode=1, msg="...Loading")
To block or unblock the screen do ##class(apptools.core.Form).BlockUI(1,"Loading form")
• classmethod ButtonBack(value={$$$aText("Back", "")}, onclick="window.history.back();", id="appButtonBack")
Display back button
• classmethod ButtonMake(value="", onclick="", id, title="")
Withdraw button
• classmethod ButtonRef(value={$$$aText("Begin", "")}, onclick="top.document.location.reload();", id="appButtonRef")
Bring the first button
• classmethod DrawTable(matrix, cols="", rows="") as %Status
Display a table from a matrix do ##class(apptools.core.Form).DrawTable(.matrix)
• classmethod GetJsonProp(obj, propName, gn, out)
To obtain the extended properties of the field object
• classmethod GetObj(Par) as %Status
To get the object from the argument
• classmethod GetPropVal(obj, propName, gn, nameAttr)
Get all property values
• classmethod GetPropertyDefinition(obj, gn)
To list the properties of a class
• classmethod GetSubclassOf(super="apptools.core.Form")
To get all descendants for a class
• classmethod GetValueByIdField(class, id, NameField, ByRef Val, ExtProp=0) as %Status
get parameter value by identifier ExtProp=1 to extended properties, for example for the type of file if ##class(apptools.core.Form).GetValueByIdField("apptools.core.Parameter","15","ImageFile",.Val,1) zwrite Val
• classmethod GetValueByName(class, name, NameField="Value", ByRef Val, ExtProp=0, field="Name") as %Status
get parameter value by name ExtProp=1 to extended properties, for example for the type of file if ##class(apptools.core.Form).GetValueByName("apptools.core.Parameter","TestFiles","Value",.Val,1) zwrite Val
• classmethod GetValueProperty(obj, NameField, ByRef Val) as %Status
s Val="value" d ##class(apptools.core.Form).GetValueProperty(obj, "FileKP1",.Val)
• classmethod ObjectDelete(Param="", Ref=0)
Keep object default
• classmethod ObjectNew(Param="")
To create a new object by default
• classmethod ObjectSave(Param="", Ref=0)
Save the default object
• classmethod ObjectSaveAsNew(Param="")
To create the object as new
• classmethod SelectField(KeyList="", ONCHANGE="", ValueList="", gnRet, order=1, idSelect="selectmenu", dfltKey="", width=500, NoWrite=0, attr="") as %Status
The output fields of type select do ##class(apptools.core.Form).SelectField($lb("",0,1),"alert(1);",$lb("","No","Yes"),.gn,,"test","0",50,1,"title='help!'")
• classmethod SelectFieldYesNo(idSelect="selectmenu", dfltKey="") as %Status
The output type field select Yes or no do ##class(apptools.core.Form).SelectFieldYesNo("test","0")
• classmethod SelectObj(sql, ONCHANGE="", ValueList="", gnRet, idSelect="selectmenu") as %Status
To objects in the selector for small samples Return in the same row or in the global sql query ONCHANGE = js function on the event in the ONCHANGE salestore ValueList = list of fields for the output Value gnRet - return the array by reference
• classmethod Show(obj, Mode=0, PrefixIdDIV="", orderProp="")
Show object Obj - the class instance Mode = 0 safe mode Mode = 1 edit mode with all buttons Mode = "1,WithoutSave,WithoutDel,WithCreate,WithoutRef" edit mode without buttons Mode = "1,ShowFieldName" - show the field names
• classmethod ShowProp(obj, propName, gn, PrefixIdDIV, Mode)
Write the string object properties
• classmethod UikitNote(msg, status="warning")
To list the properties of a class
• classmethod WebCompShowCheckbox(obj, ByRef pr, Mode, %id, %val, ByRef ext)
Display checkbox
• classmethod WebCompShowFiles(obj, ByRef pr, Mode, %id, %val, ByRef ext)
Display component Files


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.