TabDefinition Collection Methods

This section describes the TabDefinition collection methods in alphabetical order.

Syntax

DeleteItem(TabDefinitionName)

Description

The DeleteItem method deletes the TabDefinition object identified by TabDefinitionName from the TabDefinition Collection.

Note: The portal registry classes execute some methods "interactively", that is, as they happen. The item won't be marked for deletion, then actually deleted later. The item is deleted from the database as soon as the method is executed.

Parameters

Field or Control	Definition
`TabDefinitionName`	Specify the name of a TabDefinition existing in the TabDefinition collection.

Returns

A Boolean value: True if the TabDefinition was deleted, False otherwise.

Example

If Not &MyColl.DeleteItem("TabDefnTest") Then 
   /* do error processing */
End-If;

Syntax

First()

Description

The First method returns the first TabDefinition object in the TabDefinition collection.

Parameters

None.

Returns

A TabDefinition object.

Example

&MyTabDefinition = &MyCollection.First();

Syntax

InsertItem(TabDefinitionName)

Description

The InsertItem method inserts the TabDefinition object identified by TabDefinitionName into the TabDefinition Collection.

Note: The portal registry classes execute some methods "interactively", that is, as they happen. The item won't be marked for insertion, then actually inserted later. The item is inserted into the database as soon as the method is executed.

Parameters

Field or Control	Definition
`TabDefinitionName`	Specify the name of an existing permission list.

Returns

A reference to the new TabDefinition object if the method executed successfully, NULL otherwise.

Example

&MyTabDef = &MyColl.InsertItem("Empl_Homepage");

If Not &MyTabDef Then 
   /* do error processing */
End-If;

Syntax

ItemByName(Name)

Description

The ItemByName method returns the TabDefinition object with the name Name.

Parameters

Field or Control	Definition
`Name`	Specify the name of an existing TabDefinition within the TabDefinition collection. If you specify an invalid name, the object is NULL.

Returns

A TabDefinition object if successful, NULL otherwise.

Example

&MyTebDefn = &MyColl.ItemByName("Empl_Homepage");

Syntax

Next()

Description

The Next method returns the next TabDefinition object in the TabDefinition collection. You can use this method only after you have used the First method: otherwise the system doesn’t know where to start.

Parameters

None.

Returns

TabDefinition object.

Example

&MyTabDefinition = &MyCollection.Next();