Platform SDK: CDO 1.2.1

LinkPattern Property (ObjectRenderer Object)

The LinkPattern property returns or sets a rendering source that determines how a link is rendered. Read/write.

Syntax

objObjectRend.LinkPattern

Data Type

String

Remarks

The LinkPattern property supplies rendering information for a link to the object currently specified in the DataSource property. The link is rendered by the RenderLink method. It can use the complete HTTP syntax or simply render a URL.

The LinkPattern property determines the appearance of the link in the HTML output. The following table shows which substitution tokens can be used. Note that their interpretations are not the same as for a Pattern object’s RenderUsing property.

Substitution token Attribute of object being linked
%classpath% A special-purpose format with the name “classpath” for rendering a message object’s message class.
%obj% The object’s unique identifier, expressed as a hexadecimal string.
%<formatname>% Any user-defined or system-defined named format.

Setting LinkPattern generates a Format object with the name “message_Link” and adds it to the object renderer’s Formats collection. This named format is for internal use only. You should always use the combination of RenderLink and LinkPattern to render any link.