form (Domino DTD)

Represents a form.

Containment Hierarchy

Contained by: %design.elements;, %named.element.link.types;

Contains: %named.design.note.prolog;, <globals>, <code>, <actionbar>, <background>, <body>, %note.epilog;

Syntax

<!ELEMENT form ( %named.design.note.prolog;, globals?, code*, actionbar?, background?, body, %note.epilog; )>

Content

%named.design.note.prolog;, globals?, code*, actionbar?, background?, body, %note.epilog;

Contains any one of the contents of %named.design.note.prolog; entity, an optional <globals> element, any number of <code> elements, optional <actionbar> and <background> elements, followed by a <body> element and any one of the contents of the %note.epilog; entity.

Attributes

<!ATTLIST form

%named.design.note.attrs;

%link.color.attrs;

%reading.order.attrs;

bgcolor

%color;

#IMPLIED

inherit

%boolean;

"false"

mailable

%boolean;

"false"

type

(%form.types;)

"document"

recalc

%boolean;

"false"

storeform

%boolean;

"false"

editonopen

%boolean;

"false"

anonymous

%boolean;

"false"

nofieldexchange

%boolean;

"false"

versions

(%form.versions;)

"none"

manualversion

%boolean;

"false"

inheritdoc

(%form.inheritdocs;)

"none"

inheritdocfield

%string;

#IMPLIED

contextpane

(%form.contextpanes;)

"hide"

mergeconflicts

%boolean;

#IMPLIED

conflictaction

%form.conflictactions;

"createconflicts"

dataconnection.metadataname

%string;

#IMPLIED

dataconnection.resourcename

%string;

#IMPLIED

signdocuments

%boolean;

"false"

%form.focus.attrs;

>

anonymous

Indicates whether the form is anonymous to protect the anonymity of the author or editor.

conflictaction

Indicates how to handle form replication conflicts. See the %form.conflictactions; entity for a list of options.

contextpane

Options used when a field inherits values from another document, as defined by the %form.contextpanes; entity.

dataconnection.metadataname

Name of the metadata object to extract external data from by default when external data connections are enabled.

dataconnection.resourcename

Name of the Data Connection Resource in the database to use by default when external data connections are enabled.

editonopen

Indicates whether to automatically put documents created using this form into edit mode when opened.

inherit

Indicates whether the form design is inherited from the database template.

inheritdoc

Inherits a parent or related document as defined in the %form.inheritdocs; entity.

inheritdocfield

Value of a field that inherits values from a parent document. The default value is the name of the field in the parent document that contains the value you want to inherit.

mailable

Indicates whether the Mail Send dialog appears when a document is closed, to give users the option of mailing it.

manualversion

Indicates whether the user can manually create a new version of the document by choosing File - Save as New Version.

mergeconflicts

Indicates whether the form merges replication conflicts into a single document. This attribute was deprecated in version 6.0. Use conflictaction instead.

nofieldexchange

Indicates whether a field can be used to exchange data with other Notes application. For more details, see the topic Exchanging data using Notes/FX in Application Development with Domino Designer.

recalc

Indicates whether the form automatically recalculates fields whenever a field value changes.

signdocuments

Boolean. If true, indicates that documents can be signed.

storeform

Indicates whether to store the form in the document.

type

Type of response document (if any) that this form creates. See the %form.types; entity for a list of options.

versions

Version tracking method as defined by the %form.versions; entity.

Defined entities for <form> element

The %form.conflictactions; entity defines how to handle form replication conflicts.

Syntax:

<!ENTITY % form.conflictactions "createconflicts | donotcreateconflicts | mergeconflicts | mergenoconflicts ">

createconflicts

If a replication conflict of a form occurs, a replication conflict document appears as a response to the document that triggered the replication conflict.

donotcreateconflicts

Does not record the replication conflict of a form using a response document.

mergeconflicts

If a replication conflict of a form occurs, saves the edits to each field in a single document. If two users edit the same field in the same document, saves one document as a main document and the other as a response document, marked as a replication conflict.

mergenoconflicts

If a replication conflict of a form occurs, saves the edits to each field in a single document. If two users edit the same field in the same document, one user's edits get saved and the other's do not. No replication conflict response documents display in the view.

The %form.contextpanes; entity defines the different ways to display the context pane.

Syntax:

<!ENTITY % form.contextpanes "hide | link | parent ">

hide

Does not display the context pane.

link

Displays the document linked to in the doclink in the context pane.

parent

Displays the parent document in the context pane.

The %form.inheritdocs; entity defines the different ways an entire selected document can be inherited into a rich text field.

Syntax:

<!ENTITY % form.inheritdocs "none | link | richtext | collapsed ">

collapsed

Inherits selected document as collapsible rich text.

link

Inherits selected document as a link.

none

Does not inherit selected document.

richtext

Inherits selected document as rich text.

The %form.types; entity lists the types of response documents a form creates.

Syntax:

<!ENTITY % form.types "document | response | responsetoresponse ">

document

Document form.

response

Main response form.

responsetoresponse

Response to Response form used in a discussion thread.

The %form.versions; entity defines the different ways you can maintain a history of changes to a document.

Syntax:

<!ENTITY % form.versions "none | newresponse | oldresponse | newsibling ">

newresponse

New versions become responses; the original document is the parent.

newsibling

New versions become siblings; all documents are equal in the view hierarchy.

none

Does not maintain history of changes.

oldresponse

Prior versions become responses; the new document is the parent.

Example