Skip to main content


class CSPX.LoginForm extends %Library.RegisteredObject, %CSP.Util.AutoForm

IRIS specific login form.

Property Inventory

Method Inventory


parameter DOMAIN = Ensemble;
Use our own domain for localization


property Password as %CSP.Util.Passwd (CAPTION = "@Ensemble:Password@Password", MAXLEN = 40);
Property methods: PasswordDisplayToLogical(), PasswordGet(), PasswordIsValid(), PasswordLogicalToDisplay(), PasswordLogicalToOdbc(), PasswordNormalize(), PasswordSet()
property User as %String (CAPTION = "@Ensemble:Username@Username", MAXLEN = 40);
User name
Property methods: UserDisplayToLogical(), UserGet(), UserIsValid(), UserLogicalToDisplay(), UserLogicalToOdbc(), UserNormalize(), UserSet()


classmethod CreateInstance(ByRef pID As %String) as AutoForm
Inherited description: Create an instance of the AutoForm object using the provided ID value(s). This is overridden by subclasses.
The default implementation will perform an OpenId if the AutoForm is a persistent object.
classmethod OnDefineButtons(ByRef pButtons As FormButton)
define standard Login buttons
method OnSubmit(ByRef pID As %String, pSubmit As %String) as %Status
Inherited description: This callback is called when this form is submitted. pID is the ID value associated with the form. The default implementation will perform a Save if the AutoForm is a persistent object.
pSubmit is the name of the submit button (i.e., $AUTOFORM_SAVE).

Inherited Members

Inherited Methods

FeedbackOpens in a new tab