Example

Represents programming code.

Containment Hierarchy

Contained by: <action>, <agent>, <area>, <actionhotspot>, <appletparameters>, <appletresource>, <button>, <bordercaption>, <column>, <computedtext>, <databasescript>, <embeddedview>, <embeddednavigator>, <field>, <folder>, <form>, <frameset>, <globals>, <imageref>, <javaapplet>, <page>, <pardef>, <picture>, <popup>, <scriptlibrary>, <section>, <sectiontitle>, <subform>, <subformref>, <view>, %link.computed.content;

Contains: %code.types;

Syntax

<!ELEMENT code ( %code.types; )>

Content

%code.types;

Contains any of the coding language options in the %code.types; entity (the <formula>, <lotusscript>, <javaproject>, <simpleaction>, and <javascript> elements).

<!ATTLIST code

event	%string;	#REQUIRED
for	%tokens;	#IMPLIED
enabled	%boolean;	#IMPLIED

>

enabled

Boolean. Applies in only those places in the Notes UI where you do not have the option to select a check box to enable code, for example, in a hide when formula for a paragraph. When the code is valid, defaults to true.

Name of a built-in event or a user-defined LotusScript function.

List of keywords from the %code.for.tokens; entity. This attribute identifies where the code is executed in those instances where Web and Notes client execution are both possible.

The %code.databasescript.lotusscript.or.formula.events; entity lists the types of events that trigger LotusScript or Formula language code through a databasescript. This entity is used in the following entity: %code.lotusscript.or.formula.events;

Syntax:

<!ENTITY % code.databasescript.lotusscript.or.formula.events "querydocumentdelete | querydocumentundelete| postdocumentdelete | querydroptoarchive| postdroptoarchive ">

The %code.events; entity lists the types of events that trigger code execution.

Syntax:

<!ENTITY % code.events "%code.formula.events; | %code.lotusscript.events;| %code.lotusscript.or.formula.events; | %code.javascript.events; ">

The %code.for.tokens; entity lists the keyword token options of the for attribute. These keyword tokens indicate if the code is intended for use on the Web or in the Notes client. You only need to specify this attribute in those events where Lotus Domino Designer enables you to write code that can be triggered in either. The default in such events is web.

Syntax:

<!ENTITY % code.for.tokens "web | client ">

The %code.formula.events; entity lists the different events that trigger formula language code execution. This entity is used in the %code.events; entity.

Syntax:

<!ENTITY % code.formula.events "defaultvalue | inputtranslation | inputvalidation | windowtitle | webqueryopen | webquerysave | hidewhen | value | selection | htmlattributes | htmlhead | htmlbody | targetframe | helprequest | form | alternatehtml | showsinglecategory | label | displayvalue ">

alternatehtml

Alternate text to display if the user's browser cannot execute the code. For example, if a Java applet cannot be run by the user's browser, this text would describe the applet and inform the user that their browser's capabilities do not support it.

Provides an initial value for a field.

Determines the value that displays for an action checkbox.

Defines which form to open from a view.

Executes when Help is selected.

Hides the object if the formula you provide is true.

Specifies characteristics for the associated HTML object. Applies to fields.

Information that resides in the HTML Body tag for an object. Applies to forms and pages.

Information that resides in the HTML Head tag for an object. Applies to forms and pages.

Converts the data entered in the field to make the field conform to a specified format.

Checks the data entered in the field against criteria that you specify.

Specifies the label to display on an action button.

Selects the documents that appear in a view.

In embedded views, limits the documents displayed in the view to those contained in one category. The category is defined by a formula or text.

Defines which frame in a frameset the result of a command should display in.

Specifies the contents of a computed field.

Executes before a Web document is displayed.

Executes before a Web document is saved.

Generates the text that appears in the title bar of documents using the form.

Syntax:

<!ENTITY % code.javascript.events "onClick | onDblClick | onMouseDown | onMouseUp | onMouseOver | onMouseMove | onMouseOut | onKeyPress | onKeyDown | onKeyUp | onFocus | onBlur | onLoad | onUnload | onSubmit | onReset | onChange | onError | onHelp | onSelect | Queryopen | Queryrecalc | Postrecalc | Querymodechange | Postmodechange | Postsave | Querysend | Postsend | library">

These code events options execute when:

library

it onThe JavaScript script library is activated. Unlike LotusScript or Java, a JavaScript script is not attached to specific objects, nor can specific classes created in a JavaScript script be accessed from any agent or servlet.

The object loses the input focus.

The content of an object has changed.

You press and release the mouse button.

You press and release the mouse button two times consecutively.

An error occurs on loading.

You give focus to an object.

You press the F1 key while the browser is the active window.

You press a key.

You press and release an alphanumeric key.

You release a key.

The browser loads the object.

You press the mouse button down.

You move the mouse over an object.

You move the mouse outside the boundaries of an object.

You move the mouse pointer onto an object.

You release the mouse button.

You reset a form.

You select text in a text area or an input type text object.

Before a form is submitted.

Before the browser unloads the object.

After a document is changed to read or edit mode.

After a database, view, folder, or document is recalculated.

After a document is saved.

After a document is sent.

Before a document is changed to read or edit mode.

Before a view, folder or document is opened.

Before a view, folder or document is recalculated.

Before a document is sent.

Syntax:

<!ENTITY % code.javascript.sections " jsheader ">

jsheader

Header information for JavaScript events.

Syntax:

<!ENTITY % code.lotusscript.events "initialize | terminate | entering | exiting | onchange | objectexecute ">

These code event options execute when:

entering

Focus enters a field.

Focus exits a field.

A database, view, folder, document, object, or agent is being loaded.

An action, button, or hotspot is activated by an OLE2 server that is FX/Notesflow enabled.

A user changes a field in edit mode.

A database, view, folder, document, object, or agent is being closed.

Syntax:

<!ENTITY % code.lotusscript.events "action | onhelp | queryopen | queryrecalc | postopen | querymodechange | querysend | postsend | postmodechange | postrecalc | querysave | postsave | queryclose | click | regiondoubleclick | queryopendocument | queryaddtofolder | querydragdrop | querypaste | postdragdrop | postpaste | onload | onunload | onsubmit | queryentryresize | postentryresize | %code.databasescript.lotusscript.or.formula.events; ">

These code event options execute as follows:

action

When a user selects an action from the Actions menu or clicks an action button in the action bar.

When you select an action, button, or hotspot.

When a user presses the F1 key for context-sensitive Help.

After the current document is opened, but before the user has input focus.

Before the current document is saved.

Before the current document is closed.

After a drag and drop operation in a database script or calendar folder or view.

After a calendar view entry is resized.

After a document is changed to read or edit mode.

After a database, view, folder, or document is opened.

After a paste operation in a folder or view.

After a document is refreshed and its values are recalculated.

After a document is saved.

After a document is sent.

Before a document is added to a folder.

Before a database, view, folder, or document is closed.

Before a drag and drop operation in a database script or calendar view or folder.

Before a calendar view entry is resized.

Before a document is changed to read or edit mode.

Before a view, folder, or document is opened.

Before a document is loaded in a folder or view.

Before a paste operation in a folder or view.

Before a view, folder, or document is recalculated.

Before a document is saved.

Before a document is sent.

When a region in a calendar view or folder is double-clicked.

Syntax:

<!ENTITY % code.lotusscript.sections " options | declarations ">

These section options specify areas where you can write:

declarations

Non-executable LotusScript statements.

LotusScript statements, such as Option, Use, UseLSX, and Const.

Syntax:

<!ENTITY % code.sections " %code.lotusscript.sections; | %code.javascript.sections; ">

The %code.types; entity represents the coding languages that are supported by Lotus Notes. This entity contains the <formula>, <lotusscript>, <javascript>, <javaproject>, and <simpleaction> elements.

Syntax:

<!ENTITY % code.types " formula | javascript | lousscript | javaproject | simpleaction+ ">

Example
Example
See Also

The Domino DTD

Glossary