TableView Object

[Previous] [Next]

The Columns collection contains Column objects for the current view object. The Column objects specify which properties should be rendered to HTML.

Columns Collection Method

The following section describes the Add method of the Columns collection.

Add Method

The Add method creates and returns a new Column object. This method takes five required parameters and one optional parameter. The first required parameter is a string that specifies the display name for the new Column object. The second required parameter is the property tag or the name of a custom property you want to render in the new Column object. The third required parameter is a number that specifies the absolute width of the new Column object. The fourth required parameter is a Long data type that specifies the display attributes for the new Column object. (For more information on these flags, see the description of the Flags property later in this supplement.) The final required parameter is a number that specifies the index of the column after which you want the new Column object to be inserted. If this number is greater than the number of Column objects in the collection, the new Column is inserted at the end.

The one optional parameter is a Long data type that defines the property type to be rendered by the new Column object. You need to define this only for custom properties, not for predefined properties. For more information on property types, see the description of the Property property in this supplement.

Columns Collection Properties

Two properties of the Columns collection are Count and Item. The Count property returns the number of Column objects in the collection. The Item property allows you to retrieve a specific Column object by specifying either the index of the Column object or the property tag that the Column object renders.

Column Object Properties

The following sections describe the properties of the Column object. The Column object contains no methods.

Flags Property

This property returns or sets the flags that specify the display attributes for the Column object. This property takes a Long data type that has two possible values, either CdoColumnBitmap (8) or CdoColumnNotSortable (32). CdoColumnBitmap specifies that the property rendered in the columns should be displayed using a bitmap. CdoColumnNotSortable specifies that the display cannot be sorted by the property in the column.

Name Property

The Name property returns or sets the default heading for the Column object as a string. The text you specify represents the text that will be rendered for the column in the header row. You should use this property to distinguish between two columns that might render the same property but are used for different purposes.

Property Property

The Property property returns the name or property tag of the MAPI property being rendered by this Column object. The return value can be either a string for a custom property name or a Long data type that specifies the property tag.

RenderUsing Property

This property returns or sets the HTML string that determines how the column property is rendered. For more information on the RenderUsing property, see the description of the Pattern object's RenderUsing property.

Width Property

The Width property returns or sets the width for the Column object. This property is a number that represents the horizontal space for the column.