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.