Home
HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
Programming Overview and User Interface
This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
XML for Domino
The following topics cover some general guidelines for using XML in Domino applications and list all the elements, attributes, and entities in the Domino Document Type Definition (DTD):
The Domino DTD
The Domino Document Type Definition (DTD) describes the structure of DXL, the Domino version of Extensible Markup Language (XML). The DTD contains the definitions of the XML tags that you can use to validate your XML documents while converting external XML data into Domino databases or to understand any XML documents produced while exporting internal Domino databases into XML.
attachmentref (Domino DTD)
Represents a reference to a file attachment to be imported. Once the attachment is imported, it is stored as a $File item. A file that is imported as an attachmentref element is represented by a $File item if it is then exported. An attachmentref element will not display in the resulting dxl of an export operation. Each file attachment associated with a note is stored with that note as a $File item. This element enables you to import a file by reference rather than importing it as a $File item. You can define the file as an attachmentref and specify its path and file name.

HCL Domino Designer User Guide and Reference
This guide provides information on using HCL Domino Designer and programming language reference information.
- What's new in Domino Designer 14.5?
  The following features are new for developers in HCL Domino® Designer 14.5.
- What's new in Nomad Designer?
  HCL Nomad for web browsers v1.0.10 introduces the capability to design Notes databases. For more information, see HCL Nomad for web browsers User Documentation, Nomad web Designer.
- Accessibility and keyboard shortcuts
  Accessibility features assist users who have a disability, such as restricted mobility or limited vision, to use information technology content successfully.
- Application Design
  Welcome to the Application Design section of Domino® Designer Help.
- Application Management
  Welcome to the Application Management section of Domino® Designer Help.
- Domino® Query Language
  Domino® Query Language (DQL) is a facility running on a Domino server that provides a terse, shorthand syntax for finding documents. It supports a wide variety and complexity of search terms. It leverages existing design elements, avoiding the need to write detailed code to access them. DQL consolidates all methods in Domino for searching document contents.
- Composite Applications - Design and Management
  Composite applications are a key element in a service-oriented architecture (SOA) and contextual collaboration strategy. The ability to create and edit composite applications lets you easily integrate different types of components and technologies.
- DB2® Access views
  Domino® Designer includes two types of design elements to assist you in managing data contained in DB2® enabled Notes® databases:
- Programming Overview and User Interface
  This section contains general guidelines and examples that show where to use Java, LotusScript, and the formula language.
  - Programming Overview
    This documentation describes how to attach Java, JavaScript, LotusScript, and formula code to Domino design elements. Here are some overview topics:
  - User Interface
  - XML for Domino
    The following topics cover some general guidelines for using XML in Domino applications and list all the elements, attributes, and entities in the Domino Document Type Definition (DTD):
    - Using XML with Domino
      Domino now provides support for Extensible Markup Language, or XML. XML enables you to tag data in order to delimit it, leaving the interpretation of the data to the applications that read it. Unlike Hypertext Markup Language (HTML), which describes the appearance of data, XML describes the structure of data. This makes XML compatible with Domino, which stores data in structured documents, separate from its presentation. By using XML -- working on data separated from its presentation -- you can now generate more powerful Domino applications.
    - Reading a DTD
      A Document Type Definition (DTD) describes the content and hierarchy of Extensible Markup Language (XML) tags that are used by an organization to define data it wants to share across platforms. The DTD consist of the following:
    - The Domino DTD
      The Domino Document Type Definition (DTD) describes the structure of DXL, the Domino version of Extensible Markup Language (XML). The DTD contains the definitions of the XML tags that you can use to validate your XML documents while converting external XML data into Domino databases or to understand any XML documents produced while exporting internal Domino databases into XML.
      - Core entities
        The following are core entities:
      - Common entities
        The following are DTD entities that are referenced in other entities or in more than one element:
      - acl (Domino DTD)
        Defines the structure of an access control list (ACL) in a Domino database. The ACL is unique in that it is similar to a design note, but behaves as a separate object that holds information in a Domino database. In DXL, the ACL is treated as a root element, which enables you to manipulate it independently, without having to import or export an entire database.
      - aclentry (Domino DTD)
        Represents an acl entry in a Domino database. An aclentry can consist of a person, server, or server group that is assigned an access level to perform specific tasks in a database. The attributes of this element define the access and editing privileges a user has for a database.
      - action (Domino DTD)
        Represents an action. An action is code that consists of one or a combination of Domino actions, formula language @functions or @commands, LotusScript language or Java language programs. The developer indicates how an action can be accessed by a user; it is usually displayed as a button in an action bar in a view, form, or page, or is included in the Actions option on the menu bar.
      - actionbar (Domino DTD)
        Represents the action bar in a form, view, or page.
      - actionbarstyle (Domino DTD)
        Defines the action bar size and background properties.
      - actionbuttonstyle (Domino DTD)
        Represents the style settings for buttons in the action bar.
      - actionhotspot (Domino DTD)
        Represents an Action Hotspot. This element should contain a code element that contains the simple action, formula, LotusScript, or JavaScript code to execute when a user clicks the action hotspot. It should also contain richtext, which is the text that a user clicks to trigger the action.
      - addedtofile (Domino DTD)
      - agent (Domino DTD)
        Represents a Domino agent as a named design element. An agent is a program that runs a series of automated tasks according to a set schedule or at the request of a user. An agent consists of three components: the trigger (when it acts), the search (what documents it acts on), and the action (what it does).
      - agentdata (Domino DTD)
        Represents an agent data note. An agent data note is created and obtained via the Notes backend classes and is populated by the agent code. It can contain persistent data that is used from run to run of an agent. Agent data notes are not imported, but they can be exported for information purposes.
      - agentmodified (Domino DTD)
        Specifies the last time an agent was modified.
      - agentrun (Domino DTD)
        Specifies the last time an agent was run.
      - anchor (Domino DTD)
        Represents an anchor, which is a target location within a document. When a document link jumps to a target document, it can jump to the beginning of the document or to a specific location within it. An anchor reserves the specific location within a target document for the link to jump to.
      - appletparameters (Domino DTD)
        Represents the parameter for a Java applet.
      - appletresource (Domino DTD)
      - appletresourcefileref (Domino DTD)
        Represents a reference to a file within a Java applet resource design element.
      - area (Domino DTD)
        Represents a hotspot area on an image that a user can click to link to another database resource or a URL.
      - associatedfiles (Domino DTD)
        Additional files that are associated with the embedded or linked object. In Designer, these files are listed in the Associated Files tab of the Object Properties box. They are made up of $FILE items that are not part of the files that make up the object itself.
      - attachmentref (Domino DTD)
        Represents a reference to a file attachment to be imported. Once the attachment is imported, it is stored as a $File item. A file that is imported as an attachmentref element is represented by a $File item if it is then exported. An attachmentref element will not display in the resulting dxl of an export operation. Each file attachment associated with a note is stored with that note as a $File item. This element enables you to import a file by reference rather than importing it as a $File item. You can define the file as an attachmentref and specify its path and file name.
      - background (Domino DTD)
        Represents a background image on a form, page, or help document.
      - block (Domino DTD)
      - body (Domino DTD)
        Represents the body of a form, subform, page, or document as a design element.
      - border (Domino DTD)
        Defines border characteristics for design elements.
      - bordercaption (Domino DTD)
        Represents the border of a frame in a frameset.
      - break (Domino DTD)
        Represents a line break or a hard return in rich or plain text.
      - button (Domino DTD)
      - caption (Domino DTD)
        Represents the caption associated with an image.
      - cellbackground (Domino DTD)
        Represents a background image in a table cell.
      - cgm (Domino DTD)
        Represents a Computer Graphics Metafile, which is the International Standard for storage and exchange of two-dimensional graphical data. A cgm metafile specifies which positions the collection of elements, such as geometric components of a picture or line color details, may hold in the metafile. It provides a useful format for combining raster and vector images.
      - code (Domino DTD)
        Represents programming code.
      - column (Domino DTD)
        Represents a view column.
      - columnheader (Domino DTD)
        Represents a column header.
      - computedtext (Domino DTD)
      - control (Domino DTD)
        Represents an OLE custom control, which is a component program object that can be embedded in a form.
      - created (Domino DTD)
      - database (Domino DTD)
        Defines the structure of a Domino database.
      - databaseinfo (Domino DTD)
        Represents the time a document or design note in a Domino database was last modified.
      - databaselink (Domino DTD)
        Represents a link to a database. If the link is empty, represents a standard non-hot Notes link. If the link contains rich text, represents a hotspot link. You activate a non-hot Notes link by clicking the Notes icon in rich text that represents the link. You activate a hotspot link by clicking any part of the rich text it contains.
      - databasescript (Domino DTD)
        Represents a database script, which is code associated with database object events, such as opening or closing a database.
      - dataconnection (Domino DTD)
        Represents a connection made between a Notes field and an external data source.
      - datamodified (Domino DTD)
        Represents the date and time a document in a Domino database was last modified.
      - datechoice (Domino DTD)
        Searches a database based on date parameters.
      - datetime (Domino DTD)
        Represents date and time data. Domino <datetime> elements are represented in the following ISO8601 basic formats:
      - datetimeformat (Domino DTD)
        Represents the localization formats of datetime.
      - datetimelist (Domino DTD)
        Multiple datetime data or datetimepair data, separated by commas.
      - datetimepair (Domino DTD)
        A set of datetime data, usually representing a date range.
      - designchange (Domino DTD)
        Represents the time of the last agent design change. Changes to an agent's enabled or disabled status are not considered design changes.
      - designmodified (Domino DTD)
        Represents the time a design note in a Domino database was last modified.
      - doclink (Domino DTD)
        Represents a link to a document. If the link is empty, represents a standard non-hot Notes link. If the link contains rich text, represents a hotspot link. You activate a non-hot Notes link by clicking the Notes icon in rich text that represents the link. You activate a hotspot link by clicking any part of the rich text it contains.
      - document (Domino DTD)
        Represents a data note interpreted as a document. The DXL Exporter can interpret more of the items contained in a note when the note is transformed into DXL as a document element instead of as a note element.
      - documentset (Domino DTD)
        Represents a specified set of target documents that are manipulated by an agent.
      - embeddedcontrol (Domino DTD)
        Represents an embedded control. An embedded control is a field in a form or mail memo that has been cut and pasted or forwarded.
      - embeddeddatepicker (Domino DTD)
        Represents a datepicker embedded in a design element, such as a page, form, or subform.
      - embeddedfileuploadcontrol (Domino DTD)
        Represents an file upload control, which is a design element that enables a Web user to attach a file or object to a document.
      - embeddedfolderpane (Domino DTD)
        Represents a folder embedded in a design element, such as a page, form, or subform.
      - embeddedkeywords (Domino DTD)
        Represents embedded keywords in an embedded control.
      - embeddednavigator (Domino DTD)
        Represents a navigator embedded in a design element, such as a page, form, or subform.
      - embeddedoutline (Domino DTD)
        Represents an outline embedded in a richtext field, not added to a form as an outline design element.
      - embeddedview (Domino DTD)
        Represents a view embedded in a design element, such as a page, form, or subform.
      - enddate (Domino DTD)
        Specifies the date on which to stop executing a piece of agent code.
      - endtime (Domino DTD)
        Specifies the time at which to stop executing a piece of agent code.
      - entrydata (Domino DTD)
        Represents a single column cell of data for a row in a view.
      - eoutlinebackground (Domino DTD)
        Represents the background properties of an embedded outline.
      - field (Domino DTD)
        Represents a field on a form.
      - fieldchoice (Domino DTD)
        Represents a field within a modifybyformaction or modifybyfield search. The content of the element, either made up of a simple or complex data type, is the value of the field.
      - file (Domino DTD)
        Represents a file object attached to or embedded in a Notes document.
      - filedata (Domino DTD)
        Represents the content of a file attachment.
      - fileitemref (Domino DTD)
        References a $FILE item by name. The root building block of the notes that exist in a Notes database is called an item. An item of type $FILE is an item that is associated with some kind of note attachment.
      - folder (Domino DTD)
        Represents a folder.
      - font (Domino DTD)
        Represents a font in rich text.
      - form (Domino DTD)
        Represents a form.
      - formchoice (Domino DTD)
        Represents a search based on the form used to create documents.
      - formfieldschoice (Domino DTD)
        Represents a search based on the form used to create documents and specific values of fields within those documents.
      - formula (Domino DTD)
        Represents an @function or @command in the formula language.
      - frame (Domino DTD)
        Represents the individual areas that make up a frameset.
      - frameset (Domino DTD)
        Represents a frameset design element. A frameset contains one or more <frame> elements or another <frameset> element, which is also referred to as a "nested" frameset, as opposed to a "toplevel" frameset. A toplevel frameset is the frameset that contains the %named.design.note.prolog; and %note.epilog; entities. The optional code element contains the window title of the toplevel frameset.
      - fulltextsettings (Domino DTD)
        Defines the settings used to perform a full text search on a Domino database.
      - gif (Domino DTD)
        Represents a Graphics Interchange Format (GIF) image.
      - globals (Domino DTD)
        Contains the global LotusScript code for an element.
      - helpaboutdocument (Domino DTD)
        Represents an About This Database Help document.
      - helpusingdocument (Domino DTD)
        Represents a Using This Database Help document.
      - horizrule (Domino DTD)
        Represents a horizontal rule, which is vertical line in rich text. By default, a rule line is .073" thick and helps to visually separate different areas of a form or page.
      - imagemap (Domino DTD)
        Represents an imagemap that contains a graphic that has a hotspot area allocated as a circle, polygon, or rectangle within the graphic content.
      - imageref (Domino DTD)
        Represents a reference to an image resource.
      - imageresource (Domino DTD)
        Represents an image resource. An image resource is an image file stored as a shared resource, enabling it to be used in more than one design element.
      - item (Domino DTD)
        Represents an item in a note. Items store the content of a note. Every Domino note contains a set of items determined by the note class. All form notes, for example, contain the same set of items, though the values of the items differ from form note to form note. Likewise, view notes contain the same set of items. Documents, however, contain different items, depending on the form that was used to create them. An example of an item is the $Revisions item, which contains a list of time stamps that record when revisions were made to a note. This item is common to most notes, regardless of its class type. Each item has a name, type, one or more flags, a length, and a value.
      - itemdata (Domino DTD)
        Contains the raw data for an item, encoded in Base64 as specified by MIME. This is utilized on export when the DTD does not yet support an item type, or when an option is selected to output items as uninterpreted data. For itemdata elements of type TYPE_OBJECT (file attachments, for instance), this element also contains the object data which is stored elsewhere in a Notes database.
      - java (Domino DTD)
        Represents code written in the Java programming language.
      - javaapplet (Domino DTD)
      - javaarchive (Domino DTD)
        Represents a Java Archive Resource (.JAR) file.
      - javaproject (Domino DTD)
        Represents a container for multiple Java sources, resources, archives, and references to Java script libraries.
      - javaresource (Domino DTD)
        Represents a Java resource: a class or image file, for instance.
      - javascript (Domino DTD)
        Represents code written in the JavaScript language.
      - jpeg (Domino DTD)
        Represents a Joint photographic Experts Group (JPEG) image.
      - keyword (Domino DTD)
        Represents a keyword in an embedded control.
      - keywords (Domino DTD)
        Represents a Notes list field.
      - lastaccessed (Domino DTD)
        Represents the date and/or time a note was last accessed.
      - lastindexed (Domino DTD)
        Represents the date and time at which a full text search was last indexed.
      - launchsettings (Domino DTD)
        Represents the settings that define how a database is launched in Notes and on the Web.
      - layout (Domino DTD)
        Represents the layout of label and image entries in an embedded outline.
      - logentry (Domino DTD)
        Represents the change history of the access control list in a Domino database.
      - lotusscript (Domino DTD)
        Represents code in the LotusScript language.
      - modified (Domino DTD)
        Represents the date and/or time a note was modified.
      - modifybyformaction (Domino DTD)
        Represents a simple action that modifies the fields in a specified form.
      - name (Domino DTD)
        Represents a name used in authorization.
      - namedelementlink (Domino DTD)
        Represents a link to a named design element. If the link is empty, represents a standard non-hot Notes link. If the link contains rich text, represents a hotspot link. You activate non-hot Notes links by clicking the Notes icon that represents the link in rich text. You activate hotspot links by clicking any part of the rich text they contain.
      - namedelementref (Domino DTD)
        Represents a reference to a design element (that is not a hypertext link).
      - nativeimage (Domino DTD)
        A GIF or JPEG image imported as a picture element.
      - nonxmlchar (Domino DTD)
        Holds a hexadecimal version of characters that are not defined as being in the range that makes up Char, which stands for character, an atomic unit of text. Char is defined as any Unicode character excluding the surrogate blocks, FFFE and FFFF; it includes the following:
      - note (Domino DTD)
        Defines the structure of a note in a Domino database. A note is usually represented as a document element or as a defined design element, such as a form or view. Exporting or importing note elements in DXL is for advanced users. More data is interpreted when you access a note as a design element, such as a form or view, than when you access it as a note element.
      - noteinfo (Domino DTD)
        Contains identity information for a note.
      - notesbitmap (Domino DTD)
        Represents a proprietary Notes bitmap image. Images stored in an NSF file are comprised of base64 content, which is a series of CD (composite data) records representing a bitmap.
      - noteslaunch (Domino DTD)
        Controls the launch behavior of a database when it opens in a Notes client.
      - number (Domino DTD)
        Parsed character number. Represents a number field in a form or document.
      - numberformat (Domino DTD)
        Represents the localization formats of numbers.
      - numberlist (Domino DTD)
        Multiple number data, separated by commas. Represents a numberlist field in a form or document.
      - object (Domino DTD)
        A data object, such as a file attachment, which is stored separately from the item data in a Notes database.
      - objectref (Domino DTD)
        Represents a reference to an object or control in rich text. This element defines how the object is rendered by the Notes client. The actual data making up the object is stored in a number of $FILE items; the name attribute identifies the first of these items.
      - page (Domino DTD)
        Represents a page as a named design element.
      - par (Domino DTD)
      - pardef (Domino DTD)
      - parstyle (Domino DTD)
        Represents the style of a paragraph. In Designer, this element is set and edited using the Paragraph Styles tab of the Text Properties box.
      - picture (Domino DTD)
        Represents a picture or an image in rich text.
      - point (Domino DTD)
        Represents the position of a point in a two-dimensional space using the Cartesian coordinates, x and y.
      - popup (Domino DTD)
        Represents a formula or text pop-up hotspot.
      - popuptext (Domino DTD)
        Text to display in the pop-up box of a Text Pop-up hotspot.
      - profiledocument (Domino DTD)
        You can create a profile document using a profile form. On the profile form, specify the field values to store in the profile document based on your design needs. You can create one document for a database or multiple documents that are differentiated by a key you specify. Profile documents are different from standard documents because they are invisible in views, they are not included in the document count for a database, and they are cached while the database containing them is open. This makes profile documents useful for storing database-wide data, such as environment variable information, or per-user data, such as user preference information. In either case, because profile documents are cached, you can quickly retrieve information stored in them.
      - region (Domino DTD)
        Represents a region of rich text that follows an element that spans across multiple paragraphs of rich text. DXL handles large spans of rich text by breaking it into multiple elements. The first element is the construct, an actionhotspot element, for example, that exists in the rich text. The remaining paragraphs or areas of rich text are broken into region elements that are identified by unique ids.
      - revised (Domino DTD)
        Represents the date and/or time a note was revised.
      - revisions (Domino DTD)
        Represents a list of the dates and times that a note was revised. This information is stored in the $Revisions item of a Notes form, which is created the first time a document is edited.
      - richtext (Domino DTD)
        Represents a series of paragraphs, sections, tables, subforms, and blocks of text.
      - richtextdata (Domino DTD)
        Represents uninterpreted rich text data.
      - role (Domino DTD)
        Represents a role defined in the Access Control List (ACL) of a Domino database. A role is a title, such as [Web user], that a designer can create and associate specific database access privileges with. The role can then be conferred on a person or group in the ACL to extend that person or group's access to a specific database.
      - run (Domino DTD)
      - rundata (Domino DTD)
        Specifies the data stored in an agent log.
      - runlog (Domino DTD)
        Represents a log of information from the last run of an agent.
      - scriptlibrary (Domino DTD)
        Represents a script library that can contain LotusScript, Java, or JavaScript code.
      - search (Domino DTD)
        Represents a search query used to select a document set.
      - schedule (Domino DTD)
        Represents a schedule that triggers the execution of agent code.
      - section (Domino DTD)
      - sectiontitle (Domino DTD)
        Represents the title of a section.
      - sendbcc (Domino DTD)
        List of recipients to receive blind carbon copies of a mail message, specified in the in the BlindCopyTo field of a memo.
      - sendcc (Domino DTD)
        List of recipients to receive carbon copies of a mail message, specified in the CopyTo field of a memo.
      - sendmailaction (Domino DTD)
        Represents a mail message produced by a simple action.
      - sendnewsletteraction (Domino DTD)
        Represents a newsletter mail message produced by a simple action.
      - sendreplyaction (Domino DTD)
        Represents a reply message produced by a simple action.
      - sendsubject (Domino DTD)
        Represents the subject of a mail message, specified in the Subject field of a memo.
      - sendto (Domino DTD)
        The list of recipients of an e-mail message, specified in the To field of a memo.
      - servlet (Domino DTD)
        Represents a Java servlet design element. Its code element contains a javaproject element which contains the individual files that comprise the servlet.
      - sharedactionref (Domino DTD)
        Represents a reference or pointer to a shared action. All shared actions in a database are represented by a single form note. What appears in the design element action bar is actually a reference to this form note containing the shared action code.
      - sharedactions (Domino DTD)
        Represents a shared action. A shared action is an action that is stored as a shared resource in a database, enabling it to be used by more than one form or view.
      - sharedfield (Domino DTD)
        Represents a shared field as a named design element. A shared field is a field stored as a shared resource, enabling it to be used in more than one form.
      - sharedfieldref (Domino DTD)
        Represents a reference or a pointer to a shared field on a form.
      - sharedlibraryref (Domino DTD)
        References a shared script library.
      - simpleaction (Domino DTD)
        Represents Notes simpleaction code.
      - span (Domino DTD)
        Identifies a region of richtext that shares the same text properties.
      - sparefont (Domino DTD)
        Represents font that is a style not defined by the user.
      - startdate (Domino DTD)
        Specifies the date that a piece of agent code is scheduled to begin executing.
      - starttime (Domino DTD)
        Specifies the time that a piece of agent code is scheduled to start executing.
      - subform (Domino DTD)
        Represents a subform as a named design element. A subform is a shared resource that saves several form elements as a single object. For instance, you can create a subform that contains fields that display a company logo or copyright information and can insert the subform into several different forms that require this standard information.
      - subformref (Domino DTD)
        Represents a reference or a pointer to a subform.
      - sublevel (Domino DTD)
        Represents a sublevel entry in an embedded outline. A sublevel entry is an entry that defines a specific topic organized as part of a more general, toplevel entry. You create a sublevel entry by indenting the entry during outline creation. By indenting and outdenting entries you set up the hierarchical structure for the outline, which simplifies navigation for the user.
      - table (Domino DTD)
        Represents a table in rich text.
      - tablecell (Domino DTD)
        Represents a cell in a table.
      - tablecolumn (Domino DTD)
        Represents a column in a table.
      - tablerow (Domino DTD)
        Represents a row in a table.
      - tablerowstyle (Domino DTD)
        Color and font for tab labels and captions.
      - text (Domino DTD)
        Parsed character data in a string format, including the breaks present in the string.
      - textlist (Domino DTD)
        Multiple text data, separated by commas.
      - textproperties (Domino DTD)
        One or more textproperty elements, which are rich text properties that you can reference using property IDs.
      - textproperty (Domino DTD)
      - title (Domino DTD)
        Represents title of an embedded outline.
      - toplevel (Domino DTD)
        Represents a toplevel entry in an embedded outline. A toplevel entry is an entry that defines a general topic containing several related entries under it. You create a toplevel entry by outdenting the entry during outline creation. By outdenting and indenting entries you set up the hierarchical structure for the outline, which simplifies navigation for the user.
      - trigger (Domino DTD)
        Represents a trigger that executes an agent.
      - twistieimage (Domino DTD)
        Represents a twistie, which is an image that a user can click to expand or collapse an outline entry.
      - updatedby (Domino DTD)
        Defines a list of people who have updated a design note. This value is stored in the $Updatedby item in a document. The item returns Anonymous as the user if:
      - urllink (Domino DTD)
        Represent a link to a URL, either literal or computed, but not both. If the link is empty, represents a standard non-hot Notes link. If the link contains rich text, represents a hotspot link. You activate a non-hot Notes link by clicking the Notes icon in rich text that represents the link. You activate a hot spot link by clicking any part of the rich text it contains.
      - view (Domino DTD)
        Represents a view as a named design element.
      - viewbackground (Domino DTD)
        Represents the background of a view.
      - viewentries (Domino DTD)
        Defines the structure of a view in a Domino database.
      - viewentry (Domino DTD)
        Represents a row in a view. Every row in a view represents a document (except totals, category, or conflict rows). Each column in a view displays specific data pulled from that document.
      - viewlink (Domino DTD)
        Represents a link to a view. If the link is empty, represents a standard non-hot Notes link. If the link contains rich text, represents a hotspot link. You activate a non-hot Notes link by clicking the Notes icon in rich text that represents the link. You activate a hotspot link by clicking any part of the rich text it contains.
      - wassignedby (Domino DTD)
        Indicates that the note was signed by the specified user. Signatures are not emitted by the DXL Exporter, nor created by the DXL Importer. The signature information can only be considered valid if one can assure that the DXL has not been modified. You can use the Administrator client to sign notes after importing DXL, if necessary.
      - weblaunch (Domino DTD)
        Controls the launch behavior when a database is opened on the Web.
      - word (Domino DTD)
        Represents a single word used for searching a database.
    - Org.W3C.DOM package
      The documentation for the org.w3c.dom package covers the following Java interfaces:
    - Org.XML.SAX package
      The documentation for the org.xml.sax package covers of the following Java interfaces:
  - JSP Custom Tag Libraries
    A JavaServer Page (JSP) is a HTML Web page that contains code which executes application logic to generate dynamic content. The page is created at the time it is requested. JSP pages are compiled into servlets; the code they contain is executed by the server. For more information on JSPs, see the Sun Microsystems Web site: http://java.sun.com/products/jsp/.
  - Programming Domino for Web Applications
    You should be aware of certain procedures, restrictions, and enhancements available to you when using Domino Designer to program Web applications. This section describes the following areas:
- Formula Language
  This section documents the formula language.
- LotusScript® Language
  Welcome to the LotusScript® Language section of Domino® Designer Help.
- LotusScript/COM/OLE Classes
- Java/CORBA Classes
  This section documents the Java/CORBA classes.
- Connectors
  Connectors provide native access to a wide variety of DBMS products, ODBC, the platform File system, Enterprise Resource Planning systems, and Transaction Processing systems.
- Javadoc™ for Domino® Designer related APIs
  As part of providing additional Java™ reference documentation, Domino® Designer ships with a help plugin that contains Javadoc™ for additional Domino Designer related APIs.

attachmentref (Domino DTD)

Represents a reference to a file attachment to be imported. Once the attachment is imported, it is stored as a $File item. A file that is imported as an attachmentref element is represented by a $File item if it is then exported. An attachmentref element will not display in the resulting dxl of an export operation. Each file attachment associated with a note is stored with that note as a $File item. This element enables you to import a file by reference rather than importing it as a $File item. You can define the file as an attachmentref and specify its path and file name.

A note can have several $File items associated with it. The picture icon of a file attachment that displays in the rich text of a note is merely a reference to the attachment, which is actually stored in the $File item.

Containment Hierarchy

Contained by: %richtext.hot.inline;

Contains: %richtext.nonhot.inline;

Syntax

<!ELEMENT attachmentref ( #PCDATA | %richtext.nonhot.inline; )*>

Content

#PCDATA | %richtext.nonhot.inline;

Contains either plain text or any of the options of the %richtext.nonhot.inline; entity.

Attributes

<!ATTLIST attachmentref


name	%string;	#IMPLIED
displayname	%string;	#IMPLIED
caption	%string;	#IMPLIED
path	%string;	#IMPLIED
regionid	%integer;	#IMPLIED

caption

File name or other text appended to the attachment icon to identify it, if any. You can use this attribute as a way to reference the attachment if the attachment's icon is missing or does not include the file name.

displayname

The name displayed with the attachment icon. If no display name is provided, the display name is derived from the specified path or name attribute values.

name

The name of the attachment that this attachment reference refers to. If no path attribute is specified, the note must contain a $FILE item representing an attachment with the specified name.

path

The pathname of a file to attach. If no path attribute is specified, the name attribute must be specified. You cannot roundtrip (export, then import) this attribute.

regionid

Unique ID of the <region> element associated with the attachment reference construct.