TabDefinition Class Properties
In this section, we discuss the TabDefinition class properties. The properties are discussed in alphabetical order.
Description
This property returns a reference to an AssignedPagelet Collection for this TabDefinition object.
This property is read-only.
Related Links
Description
This property returns a reference to an AvailableCategory Collection for this TabDefinition object.
This property is read-only.
Related Links
Description
This property returns a reference to an AvailablePagelet Collection for this TabDefinition object.
This property is read-only.
Related Links
Description
This property returns an Attribute Collection containing the AttributeValues for this TabDefinition object.
This property is read-only.
Related Links
Description
This property returns the author (PeopleSoft user ID) for this TabDefinition object as a string.
This property is read-only.
Description
This property specifies whether the author of the TabDefinition has access to the TabDefinition. This property takes a Boolean value. The default value for this property is True.
This property is read-write.
Description
This property indicates whether the tab layout is for two or three columns. This property takes a string value.
The values for this property are:
|
Value |
Description |
|---|---|
|
2 |
Two-column table |
|
3 |
Three-column table |
This property is read-write.
Description
This property returns the creation date for this TabDefinition object as a string.
This property is read-only.
Description
This property returns or sets the description for this TabDefinition object as a string.
The length of this property is 256 characters.
This property is translatable.
This property is read-write.
Description
This property returns a reference to a DynamicCategory Collection for this TabDefinition object.
This property is read-only.
Related Links
Description
This property returns the help system identifier for this tab. It enables the help system to provide tab-specific help. This property takes a string value.
This property is read-write.
Description
This property returns the HTML text associated with this tab definition as a string.
This property is read-only.
Description
This property hides all pagelet action bar images for all pagelets used on this tab. This property overrides any properties for the pagelets used on this tab. This property takes a Boolean value: True, hide images, False, display images
This property is read-write.
Description
This property indicates whether the user can change the tab's default number of columns. This property takes a Boolean value: True, the user can change the tab columns, False, the columns can't be changed by the user.
This property is read-write.
Description
This property indicates whether the tab's label can be changed by the user. This property takes a Boolean value: True, the user can change the label, False, the user can't.
This property is read-write.
Description
This property returns or sets the label for this TabDefinition object as a string.
The length of this property is 30 characters.
This property is translatable.
This property is read-write.
Description
This property indicates whether the user can change when and how the tab displays. This property takes a string value.
The values are:
|
Value |
Description |
|---|---|
|
4OPT |
The user can choose to add this tab to their homepage. It doesn't show up by default. |
|
3DEF |
The user sees this tab the first time they log in, however, they can remove this tab if they'd like. |
|
2REQ |
The user can't remove this tab from their homepage. However, they are allowed to change its sequence or order on the page. |
|
1FIX |
The user can't remove this tab or change its position on the page. |
This property is read-write.
Description
This property returns the name for this TabDefinition object as a string. The name is a unique identifier for each TabDefinition object.
Every TabDefinition name must be unique in the portal, not just in the parent folder.
This property is read-only.
Description
This property returns or sets the owner ID of the TabDefinition object as a string.
This property is read-write.
Description
This property returns or sets the PeopleSoft product for this TabDefinition object as a string.
The length of this property is 4 characters.
This property is read-write.
Description
This property indicates whether a TabDefinition is generally accessible, that is, if it is always included in the general TabDefinition collection. This property takes a Boolean value.
The default value for this property is False.
This property is read-write.
Description
This property returns an absolute URL. If the TabDefinition has a ContentProvider associated with it, the URI from the ContentProvider is concatenated with the URL from the TabDefinition. If there is no ContentProvider, this property returns the text in the URL property.
This property is read-only.
Related Links
Description
The sequence number is used when returning a collection. The default order of the returned TabDefinitions is based on the sequence number. Use this property to reorder TabDefinitions. This property takes a number value.
If there are duplicates in the sequence number, the TabDefinitions are returned alphabetically.
The length of this property is 4 characters.
This property is read-write.
Description
This property defines the style sheet to use for this tab. This property takes a string value. This property is 30 characters long.
If no style sheet is specified, the default style sheet PSSTYLEDEF is used.
This property is read-write.
Description
This property returns or sets the date this TabDefinition is valid from as a string.
This property is read-write.
Description
This property returns or sets the date this TabDefinition is valid until as a string.
This property is read-write.
Note: The portal registry API never uses the ValidTo and ValidFrom fields to determine what to return in a collection. You must check for these values in your application.