RenderProperty Method (ContainerRenderer Object)

RenderProperty Method (ContainerRenderer Object)

Important  The Collaboration Data Objects (CDO) 1.2.1 Rendering objects are not installed by or supported for use with Exchange Server 2003 or later.

The RenderProperty method renders the designated property of the parent of the object specified by the DataSource property.

Syntax

strHTML = objContRend.RenderProperty(varProperty [, varboolRaw] [, varResponseObject**] )**

strHTML

On successful return, contains a string with the HTML hypertext representing the specified property. However, if the varResponseObject parameter is supplied, RenderProperty returns a value of Empty.

objContRend

Required. The ContainerRenderer object.

varProperty

Required. Variant (Long or String). The property tag for the predefined property, or the custom name of the user-defined property, that is to be rendered.

varboolRaw

Optional. Boolean. Reserved. Do not use.

varResponseObject

Optional. Object. An Active Server response object used to accumulate HTML output to send to the browser. This parameter is used primarily in ASP applications. If varResponseObject is not supplied, the output is written to strHTML.

Remarks

The container object specified by the DataSource property does not expose any renderable properties. The RenderProperty method renders a property on the parent object of the container object. The correspondence of these objects is as follows:

Container object in DataSource

Parent object whose properties are rendered by RenderProperty

AddressEntries collection

AddressList

Messages collection

Folder

Recipients collection

Message

The individual properties that can be rendered with the RenderProperty method are indicated in the parent object property descriptions.

The varProperty parameter designates the property to be rendered. The parameter can be a long integer designating the property by property tag, or a string designating it by custom name. In both cases it corresponds to the Property property of the Format object controlling the property to be rendered.

If the varProperty parameter is a custom name, it can optionally be prefixed with a GUID string identifying its property set. In this case, the GUID should be enclosed in braces. For more information and examples, see Using Named Properties.

See Also

Concepts

ContainerRenderer Object