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.

Containment Hierarchy

Contained by: %richtext.hot.inline;

Contains: <associatedfiles>, %richtext.nonhot.inline;

Syntax

<!ELEMENT objectref ( associatedfiles?, (%richtext.nonhot.inline;)* )>

Content

associatedfiles?, %richtext.nonhot.inline;

Contains an optional <associatedfiles> element, followed by any one of the options in the %richtext.nonhot.inline; entity.

Attributes

<!ATTLIST objectref


version	%integer;	"2"
name	%string;	#REQUIRED
class	%string;	#IMPLIED
type	(%objectref.types;)	"embeddedobject"
savewhenchanged	%boolean;	"false"
render	%boolean;	"true"
displayformat	(%objectref.display.formats;)	"metafile"
description	%string;	#IMPLIED
classid	%string;	#REQUIRED
storageformat	(%objectref.storage.formats;)	"structstorage"
scripted	%boolean;	"false"
runreadonly	%boolean;	"false"
fittowindow	%boolean;	"false"
control	%boolean;	"false"
fitbelowfields	%boolean;	"false"
regionid	%integer;	#IMPLIED
%html.core.attrs;

class

Class name of the object.

classid

Globally unique identifier (GUID) that identifies the class of the object. This can also be referred to as a class identifier (CLSID). The GUID is a 128-bit integer that identifies an interface to an object across all computers and networks. DXL defines the class identifier using a string format, for example, {c200e360-38c5-11ce-ae62-08002b2b79ef}

control

Boolean value. If true, the object is a control.

description

Text description of the object.

displayformat

Format used to display the object and to copy its data to the clipboard. Can be any of the options in the %objectref.display.formats; entity.

fitbelowfields

Boolean value. If true, the control displays following the first layout region on the form, if layout regions exists. Default is false.

fittowindow

Boolean value. If true, sizes the control or object to fill the window when a user opens it in a document in edit mode. If any fields or layout regions exist below the object on the form, they are not visible to the user. Default is false.

name

Name of the primary $FILE item for this object; the name of the first $FILE item is not necessarily the same as the file that the object was created from if it was created from a file.

regionid

Unique ID of the <region> elements associated with the object construct in rich text.

render

Boolean value. If true, renders the object in the user interface; the object has no hide formulas or properties set to hide it from Notes client or Web users. Default is true.

savewhenchanged

Boolean value. If true, indicates that the Update object from document property is selected. This enables a user to edit the control in a document and save those changes without the object being overwritten by the original object in the database. Default is false.

scripted

Boolean value. If true, the object contains code. For example, an ActiveXPlugin control object contains code, while a Word Pro 9 Document object does not. Default is false.

storageformat

Format in which the object is stored in the database. Can by any of the options in the %objectref.storage.formats; entity.

type

Object type. Can be any of the options in the %objectref.types; entity.

version

Version number of the Object Linking and Embedding (OLE) technology used to create the object.

Defined entity for <objectref> element

The %objectref.display.formats; entity defines the style with which to display the object. Not all objects support all display formats.

Syntax:

<!ENTITY % objectref.display.formats "text | metafile | bitmap | richtext | icon ">

bitmap

Displays a bitmap to represent the object when it is inactive.

icon

Displays the object using a Notes icon. For example, if the object is being created from a file, a Notes icon of a box with the text "Package" displays.

metafile

Displays the object using the standard icon style for the file type, which includes the file name. This corresponds to the "Picture" option on the Display As drop down list on the Object Properties box.

richtext

Displays rich text to represent the object when it is inactive.

text

Displays text to represent the object when it is inactive.

The %objectref.storage.formats; entity defines the types of storage formats used to store objects. Each format consists of the following interfaces used in different combinations:


Interface	Definition
IStorage	Provides the structure of the object, by supporting and managing object storage.
IStream	Provides access to the streams, which contain the data, by allowing you to read and write data to stream objects. Streams are elements nested within a storage object.
IRootStorage	Provides a single method that switches a storage object to a different underlying file and saves the object to that file. This interface is implemented in addition to the IStorage interface for storage objects that are based on a file.

Syntax:

<!ENTITY % objectref.storage.formats "structstorage | istorageistream | structstream ">

istorageistream

OLE storage format that includes the interfaces: IStorage/IStream.

structstorage

Notes format for storing objects as an "OLE Docfile" which includes the following interfaces: RootIStorage/IStorage/IStream.

structstream

OLE storage format that includes the interfaces: IRootStorage/IStream.

The %objectref.types; entity defines the types of objects you can include in a Notes form. The two basic object types in Notes are defined in the following table:


Basic object type	Definition
Linked	These objects live in the source application, which means that they can be updated in one location and the updates are automatically picked up by any documents containing links to those objects. Linking also requires that the user opening a document containing a linked object has access to the location where the source file is stored.
Embedded	Live with the form they are embedded in. Users can modify an embedded object but must have access to the source application to view it and access to Domino Designer to edit it.

Syntax:

<!ENTITY % objectref.types "autolink | manuallink | embeddedobject ">

autolink

Linked object for which automatic launching is set up. With Domino Designer, you can instruct an object to launch automatically using the Launch tab of the Form properties box.

embeddedobject

Embedded object created using the Create - Object menu command.

manuallink

Linked object created by copying and pasting an object to and from the clipboard.