Provides access to a document. This tag should contain tags that build the JSP interface, such as the formula, item, richtext, select, and textarea tags, and the action and validation tags listed below.

Note To access an existing document, you must specify the document's unique id in the unid attribute of the form tag. Otherwise a new document is created.

Note If a page containing this tag is included in another page using the <jsp:include> action tag, the hypertext link that the validhref attribute creates will not function.

To perform client-side validation on user input, set the clientvalidate attribute of this tag to "true", set the clientvalidate attribute of the input tag to "onsubmit" or "onblur", and include one of the following validation tags to specify the type of validation to perform:

validatecc, validatedate, validatelength, validatepattern, validaterange, validaterequired, validatesummary, validatewith. These tags validate user input by either requiring a field to be filled or testing that an entered value conforms to a specified format, length, pattern or falls within a specified range. Be sure the name attribute of the input tag and validation tag are equal to indicate which Web control input to validate.

Note If you do not include one of these validation tags, no validation is performed.

The action tags include: deleteattachment tag, deletedoc, docnavimg, editdoc, newdoc, nextdoc, prevdoc, saveclosedoc, savedoc These tags work in conjunction with a hidden field on the form named das_op. An action tag sets the value of das_op to one of the supported actions and then calls the form.performSubmit() method. This method ensures that submission of all the controls on the form occurs before the form itself is submitted. The following table identifies the operation codes you use in the das_op field to set its value equal to an action:

Operation code	Operation it performs on the server	Corresponding tag
S	Saves the current document and continues to display the current page.	savedoc
SC	Saves the current document and navigates to the page specified in the validhref attribute.	saveclosedoc
D	Deletes the current document.	deletedoc
DA	Deletes the selected attachment. This operation only works in the context of an attachmentlist tag.
W	Creates a new document.	newdoc
N	Displays the next document in the view or database as the current page.	nextdoc
P	Displays the previous document in the view or database as the current page.	prevdoc
E	Switches the current form into edit mode.	editdoc

Note If you are using client-side JavaScript to control form submission, you must use the form.performSubmit() method instead of form.submit() or the richtext and attachments controls will not function properly.

To save a document created with a form, either:

• Use the savedoc or saveclosedoc action tags in the context of the form tag.
• Specify a value for the id attribute and write a scriptlet in the context of the form that calls the <id>.save() method.

To create a new response to the current document, use the newdoc tag and set the asresponse attribute equal to true.

To delete the current document, use the deletedoc tag.

Contexts

Valid in:

None required; db, or session

authors, created, ifdbrole, ifdocauthor, ifdocreader, input, item, formula, select, dbselect, richtext, textarea, newdoc, nextdoc, prevdoc, savedoc, saveclosedoc, editdoc, docnavimg, unid, responses, setitem, ifauthor, ifdepositor, ifdesigner, ifeditor, lastaccessed, lastmodified, ifmanager, ifnoaccess, nodocument, parentlink, ifreader, attachments, deletedoc, formlink, user, validateCC, validateDate, validateLength, validateRange, validateRequired, validatePattern, validateSummary, validateWith

<domino:form
id="name of object variable"
name="name of the form"
clientvalidate="true|false"
counter="parameter name"
unid="unique id of the document to be edited/displayed/responded to"
editmode="display|edit|delete"
dbname="name of the database to use"
dbserver="name of the server that contains dbname"
user="login information"
password="password associated with user"
viewname="name of the view to use for navigation"
validhref="link to go to if the form is validated and document is saved"
responseto="true|false"
schema="Domino form name"
host="CORBA server name"
debug="true|false"
onfailure="inline|exception"
time="true|false"
The standard HTML tag attributes listed below>

clientvalidate

If true, generates client-side validation for any validation tags contained on the form before submitting the form to the server. If you set this attribute to true, you must also include a validation tag that specifies the type of validation to perform. (Netscape 4.x always displays the text in the body of a validation tag in the status bar.) Default is false. Optional.

Name to assign to the pseudo-query parameter used to trick browser caches into thinking that each call to the page is different. Default is formcounter. Optional.

Name of the database to find or create the document in. Optional.

Name of the server hosting the database. Optional.

Instructs the form of the mode in which to display the navigation tags. Must be one of the following:

Value	Action:
display	Generates a text area in read mode, the text cannot be edited.
edit	Generates an HTML control that can be edited.
delete	Programmatically deletes the document.

The value you provide in this attribute determines whether the input, richtext, select, and textarea tags generate HTML controls or merely display the data. For an existing document, default is display. For a new document, default is edit. Optional.

Name of the Domino CORBA (Common Object Request Broker Architecture) server to use to host the back-end classes. If specified, forces a CORBA session. If not specified, a Domino server must be running locally on the same machine that is running the JSP Web container. Default is null which creates a local, non-CORBA, session. Optional.

If you specify an id name, creates a variable that contains the associated lotus.domino.Document object. The variable created is only available within the body of the form tag. If not specified, no programmatic access to the Document object is available. However, you can still access items of the object using the item tag. This attribute value is also passed through to the generated HTML. Optional.

Name to assign to the form. Used internally to name the form within the page context. Required.

Password of the user specified in the user attribute. Default is null. Optional.

If true, the new document is created as a response to the document having the unique id supplied in the unid attribute. Optional.

Name of a Domino form in the database to use as a schema. The schema sets the initial values of a new document; it runs centralized validations and field post-processing before a document is saved. If you set this attribute equal to a form in the database, you can access the document via the Notes client view after it has been handled by the JSP. If you do not specify a valid form as the schema, clicking a document edited or created using a JSP in a Notes client view returns the error, "Cannot locate Default form." Optional.

Universal ID of the document to display and edit in the form or to create a response document for. If not specified, the form tag creates a new document. Document UNIDs contain several characters; the easiest way to specify the unid would be to pass it as a page parameter and have it picked up automatically. Specifying this attribute pinpoints a specific document in a view. Once a specific document is isolated, you can use the nextdoc and prevdoc tags to navigate through a view or document collection. Optional.

Login information for the session. If this tag is being used in the context of a session tag, this attribute is ignored. Optional.

Used in conjunction with the saveclosedoc tag; specifies the Uniform Resource Identifier (URI) to which to pass the request as a GET if the form passes validation and is properly saved. The value of this attribute determines the destination of the jump performed by the saveclosedoc tag. If successful, the page specified displays. If unsuccessful, the current page redisplays. NOTE: The form data is not posted to this new URI. Optional.

Name of the view that the document is being processed in. This attribute is used as a reference for navigation between documents. The document collection from which the prevdoc and nextdoc tags retrieve next and previous pages is determined by this attribute. If not specified, the default order of documents in the database is used in navigation. Optional.

HTML Attributes

Domino supports the following HTML tag attributes. See the Common HTML tag attributes section for their definitions.

accept

accept_charset

class

dir

lang

language

onclick

ondblclick

ondragstart

onhelp

onkeydown

onkeypress

onkeyup

onmousedown

onmousemove

onmouseout

onmouseover

onmouseup

onreset

onselectstart

onsubmit

style

target

title

The Domtags tag library

Glossary