field (Domino DTD)

Containment Hierarchy

Contained by: <sharedfield>, %richtext.nonhot.inline;

Contains: <keywords>, <datetimeformat>, <numberformat>, <code>

Syntax

<!ELEMENT field ( keywords?, datetimeformat?, numberformat?, code* )>

Content

keywords?, datetimeformat?, numberformat?, code*

Contains optional <keyword>, <datetimeformat>, and <numberformat> elements, followed by any number of <code> elements that define actions for field events.

Attributes

<!ATTLIST field

>

alignwithparagraph

If true and if the usenotesstyle attribute equals false, aligns the field with the paragraph's baseline.

allowmultivalues

Indicates whether the field accepts multiple values.

allowtabout

Indicates whether to move focus to the next field when a user presses the Tab key.

bgcolor

Background color of a field. The value of this attribute only applies if the usenotesstyle attribute is set to 'false.' Default color is 'system.'

choicesdialog

Types of list fields available as defined in the %field.choicesdialogs; entity.

computeaftervalidation

For computed and computed-when-displayed fields, indicates whether to delay computing the field until after the field validation formulas run.

defaultfocus

For editable fields, indicates whether the field is active when you create or edit a document.

description

Help description for the field.

externaldatasource

Indicates whether the field interacts with an external data source. Default is false; it does not.

fieldhelp

Only applicable when the type attribute equals richtextlite. Text defining the purpose of the field that displays in the status bar when the field has focus.

fieldhint

Text defining the purpose of the field that displays as dimmed text in the field before it has focus.

firstdisplay

Only applicable when the type attribute equals richtextlite. Defines the type of object icon to display on the helper button of a rich text lite field initially. The options are defined in the %field.limitinput.kinds; entity.

height

Height of the field. This attribute is only used if the usenotesstyle attribute is set to false, indicating that the field is not a Notes-style field.

heighttype

Indicates the type of field being used or created. Options are defined in the %field.heights; entity. This attribute is only used if the usenotesstyle attribute is set to false, indicating that the field is not a Notes-style field.

kind

Kind of field as defined in the %field.kinds; entity.

listdisplayseparator

The types of separators that can be used between list elements for displaying them. See the %list.separators; entity for a list of available options. A field cannot contain the "none" option.

listinputseparators

The types of separators that can be used between list elements when a user enters multiple values. See the %list.separators; entity for a list of available options. NMTOKENS are name tokens that enable a user to make multiple choices.

literalize

For Formula fields only, indicates whether the formula values should be literalized or translated. For instance, you can include field names for fields containing multiple values in the formula and if you set the field to Formula > Literalize fields, instead of displaying the field names you entered, the field displays the values contained by those fields. See the topic Formula fields in Application Development with Domino Designer.

lookupeachchar

For name fields, automatically performs a lookup as the user types each character in a name.

multiline

Boolean. If true, displays multiple lines of text in one field.

name

Name assigned to the field.

onlyallow

When the type attribute equals "richtextlite," specifies which constructs or actions are allowed in the field. The list of options are defined in the %field.limitinput.values; entity.

protected

Indicates whether users with Author access are prevented from editing a field in an existing document. If a field's security options are set to Must have at least Editor access to use, the value is true.

runexitingonchange

For Date/Time fields only, indicates whether any changes to the date or time should trigger the Exiting event.

seal

Indicates whether the content of the field is encrypted so that only readers who have the encryption key can access the field. If a field's security options are set to Enable encryption for this field, the value is true.

showdelimiters

Indicates whether to display delimiters.

sign

Indicates whether the field is electronically signed to prevent documents from being tampered with, en route from one user to another. If a field's security options are set to Sign if mailed or saved in section, the value is true.

storageformat

Specifies the format to use to store the contents of a rich text field. The options are defined in the Defined entities for <field> element entity.

taborder

Numeric sequence in which fields receive focus when a user presses the TAB key.

type

Type of field as defined in the %field.types; entity.

useappletinbrowser

For Web access, indicates whether to display the field using the Java applet.

usenotesstyle

If true, indicates that the field is a Notes-style field. Otherwise, the field is a native OS style or calendar control. If the field is not a Notes-style field, the height, width, and height type of the field should be set using the height, width, and heighttype attributes.

useoscontrolinbrowser

If true, sets the Web Access property to Using Best Fit for OS for displaying rich text and rich text lite fields in a browser. If the useappletinbrowser attribute is also set to true, this attribute overrides it.

view

If choicesdialog attribute equals viewdialog, name of the view from which to retrieve the column to display as the field choices. Supply the column number and database name in the viewcolumn and viewdatabase attributes respectively.

viewcolumn

If the choicesdialog attribute equals viewdialog, column number for the column from which to retrieve the field choices. Supply the view and database names in the view and viewdatabase attributes respectively.

viewdatabase

If the choicesdialog attribute equals viewdialog, name of the database from which to retrieve the column to display as the field choices. Supply the view name and column number in the view and viewcolumn attributes respectively.

width

Width of the field. This attribute is only used if the usenotesstyle attribute is set to false, indicating that the field is not a Notes-style field.

Defined entities for <field> element

The %dataconnectionfield.types; entity defines the types of data connection fields that can exist on a form. This entity is used in the %datasource.attrs; entity.

Syntax:

<!ENTITY % dataconnectionfield.types " key | data " >

data

A field that displays data extracted from a third-party, external data source.

key

A field that holds a value used to perform back-end lookups in external databases.

The %datasource.attrs; entity defines the attributes of a field that interacts with an external data source.

Syntax:

<!ENTITY % datasource.attrs "

">

dataconnectionfield

Specifies whether the field you are creating is a key or data field. See the %dataconnectionfield.types; entity for more details.

dataconnectionresource

Name of the data connection resource. A data connection resource is a shared resource that you must create in Domino Designer and associate with a Notes field before a data source connection can be made between that field and a field or object in an external database.

externalname

Name of the field in the third-party data source that this field interacts with.

metadataname

Name of the metadata object. Metadata defines the data structure of the data being accessed. See the %dataconnection.object.types; entity for a list of the data structures that Notes/Domino can access.

storelocally

Indicates whether to store the data extracted from an external data source in the local NSF database file. By default, the data remains stored in the external database. A designer has to set this to true to display the field in a view.

The %field.choicesdialogs; entity lists the options for generating a list, when defining a list field.

Syntax:

<!ENTITY % field.choicesdialogs "none | addressbook | acl | view ">

acl

Displays names from a list of people, servers, groups, and roles in the Access Control List of a database.

addressbook

Displays a list of names from a Personal Address Book or Domino Directory Names dialog box.

none

Generates no choice list for Names and Readers fields, supplies the name of the form author for an Authors field, and displays a list of choices or a formula entered by the designer for a dialog list field.

view

Displays names from a dialog box containing entries from a column in a view.

The %field.heights; entity defines the different height settings that a non-Notes-style field can have.

Syntax:

<!ENTITY % field.heights "fixed | dynamic | proportional ">

dynamic

Increases the size of the field dynamically up to three lines in length. If an entry is longer than three lines, displays scroll bars automatically.

fixed

Enables you to edit the width (in inches).

proportional

Makes the height proportional to the width.

The %field.limitinput.actions; entity lists the types of actions you can trigger from the helper button of a rich text lite field.

Syntax:

<!ENTITY % field.limitinput.actions " help | clear ">

The %field.limitinput.kinds; entity lists the types of object icons you can display on the helper button of a rich text lite field.

Syntax:

<!ENTITY % field.limitinput.kinds "picture | sharedimage | attachment | view | datepicker | sharedapplet | text | object | calendar | inbox ">

The %field.limitinput.values; entity lists the types of object icons you can display on or actions you can trigger from the helper button of a rich text lite field.

Syntax:

<!ENTITY % field.limitinput.values "%field.limitinput.kinds; | field.limitinput.actions ">

The %field.storageformat.type; entity defines the optional formats for storing the contents of a rich text field.

Syntax:

<!ENTITY % field.storageformat.type " htmlmime ">

htmlmime

Specifies to store rich text data as HTML or MIME.

The %field.types; entity lists the types of fields.

Syntax:

<!ENTITY % field.types "text | number | datetime | richtext | keyword | names | authors | readers | password | formula | timezone | richtextlite | color ">

authors

Lists the users who can edit the documents that they created.

color

A field that displays a color picker.

datetime

A date/time field.

formula

A field that contains an @function or @command formula.

keyword

Presents a list of keywords for entry into the field, as a result of a formula or a list of constants. The Dialog List field is a keyword field that can also display a list of choices from the address dialog, view dialog, or ACL.

mimepart

A field that holds data formatted in Multipurpose Internet Mail Extensions (MIME). Mail messages made up of Notes Richtext data are translated into MIME before being sent via SMTP (Simple Mail Transfer Protocol) to recipients with mail files outside the Domino Directory.

names

A computed or editable field that lists usernames.

number

A number field.

password

A text field that displays text characters as a string of asterisks (*) to hide the content of the field. This type is often used for field in which users enter their passwords.

readers

Lists the users who can read the documents created from a form.

richtext

A rich text field.

richtextlite

A rich text field that a user can paste a limited number of objects into; a helper icon listing the available element types displays beside this field.

text

A text field.

timezone

A field that displays a drop-down list of all available world time zones.

Example