Click or drag to resize
TOPICA Basic Class ProfileCollection

[This is preliminary documentation and is subject to change.]

The ProfileCollection class is a collection of Profile objects.

ProfileCollection properties

Property

Type

Description

ToString

String

Returns a string representation for debugging etc.

ToLines

String

Returns a string representation of the Profile objects in the collection, each line containing the string representation of one Profile object. The lines are separated by Newline.

Count

Integer

Number of objects in the collection.

Item

Profile

See description of indexing below.

ProfileCollection indexing

Index type

Description

Integer

Zero-based:

EmployeeUser.Profiles[0] returns the first Profile related to the Employee user.

String

Look-up by profile name.

May be used to test the logged in Employee user's profiles (= access rights).

Example

Description

EmployeeUser.Profiles["SystemAdministrator"]

Returns a Profile named "SystemAdministrator", if the logged in Employee user has a profile by that name - null if the user does not have this permission.

IsNotNull(EmployeeUser.Profiles["SystemAdministrator"])

Returns true iff the Employee user has the Profile named "SystemAdministrator".