Platform SDK: CDO 1.2.1

Formats Property (RenderingApplication Object)

The Formats property returns a single Format object or a Formats collection. Read-only.

Syntax

Set objFormats = objRendApp.Formats

Set objFormat = objRendApp.Formats(index)

Set objFormat = objRendApp.Formats(name)

objFormats
Object. The Formats collection of this rendering application.
objRendApp
Required. The RenderingApplication object.
objFormat
Object. An individual Format object belonging to this rendering application’s Formats collection.
index
Integer. An index into the rendering application’s Formats collection.
name
String. The reference name of a special-purpose Format object in the collection.

Data Type

Object (Format or Formats collection)

Remarks

Each format in the collection corresponds to a single property, except for special-purpose formats, which do not represent specific properties. Every property to be rendered can be represented by at most one Format object.

The collection of rendering formats returned by the Formats property is inherited by all rendering objects created by the CreateRenderer method. Each format corresponds to one property to be rendered.

If a Format object is to be accessed with the index parameter, the value of index must be between 1 and the size of the rendering application’s Formats collection. This size is available in the collection’s Count property.

Although the Formats property itself is read-only, the collection it returns can be accessed in the normal manner through its Add method, and the properties on its member Format objects retain their respective read/write or read-only accessibility.