UserListOptions class
namespace: Serenity.Abstractions assembly: Serenity.Net.Core
Options for listing users with IUserListService.
public class UserListOptions
Public Members
| name | description |
|---|---|
| UserListOptions() | The default constructor. |
| ContainsText { get; set; } | Gets or sets a text that the username or the display name of the users should contain. The username is compared the way the users are looked up by it, which is by its normalized form when the application keeps one, and the display name the way the database compares text, so it is case insensitive with the usual collations. All users match when it is blank. |
| IncludeInactive { get; set; } | Gets or sets whether to list the users that are disabled too, which is false by default. The users that are deleted are never listed, unless they are asked for with UserIds or Usernames. |
| Take { get; set; } | Gets or sets the maximum number of users to list, ordered by username. All users are listed when it is zero or less. |
| UserIds { get; set; } | Gets or sets the identifiers of the users to list, e.g. to show the usernames of the users that the records of another table refer to, which may be in another database, so they can't be joined. Only these users are listed when it is set, whether they are active or not, as they are asked for by who they are. The ones that are not found or are not valid identifiers are left out. It is no restriction when it is null, and an empty list lists nobody. If Usernames is set too, the users of either are listed. |
| Usernames { get; set; } | Gets or sets the usernames of the users to list, e.g. to show their display names. They are compared the way the users are looked up by their usernames, so the case is ignored when the application does so. Only these users are listed when it is set, whether they are active or not, as they are asked for by who they are. It is no restriction when it is null, and an empty list lists nobody. If UserIds is set too, the users of either are listed. |
See Also
- Source: UserListOptions.cs