Users list widget

You use the Users list widget to display lists of users. You can display users of different profile types or different roles. For example, you can display only forum users and you can choose to display only their nicknames.

After you place the Users list widget on your page, you configure it which users to display.

To do this, click Edit button in the upper-right corner of the widget. The following sections describe the settings you configure in the Users list dialogue.

Select users to display

In the Content tab page, choose which users you want to display:

• All registered users
  All users are displayed in the list.

• Selected users...
  A custom selection of users is displayed. To select one or more users you want to display, click the Select button.

• Users by roles...
  A custom selection of roles is displayed. Only users belonging to the selected roles are displayed in the list. To select one or more users you want to display, click the Select button.

In Which profile type to use? section, select the profile type of the users which you want to display. For example you can display only forum users. For more information about profile types, see Administration: User profiles.

List settings

List settings define how users are listed by the Users list widget. Choose one of the following options:

• Use paging
  Sitefinity CMS divides the users into pages. In the input field, specify how many users per page to display.

• Use limit
  Sitefinity CMS displays only a limited number of users. In the input field, specify how many users to display.

• No limit and paging
  Sitefinity CMS displays all users that meet the requirements and filters you set in the Content tab.

• Sort users
  By default, the users are sorted in alphabetical order by first name. You can select a different sorting criterion:

  • First name (A-Z)
  • First name (Z-A)
  • Last name (A-Z)
  • Last name (Z-A)
  • Last created
  • Last modified
  • As set in Advanced mode
    To sort the list of users by property that is not defined in the sort dropdown menu, you must add a new sorting expression in the designer’s Advanced mode. For example, to sort users using the Nickname property of user, navigate to Advanced » Model and, for SortExpression, add Nickname ASC. As a result, in the sort dropdown menu, the As set in Advanced mode option is selected by default.

• List template
  Select the template you want to use to list users on the webpage.

• CSS classes
  Expand More options section to specify CSS file names and apply additional CSS classes to the Users list widget.

Single item settings

Single item settings define how individual users are displayed. Choose one of the following options:

• Open single item in...
  Select one of the following options:

  • Auto-generated page
    When you click a user, the user profile is displayed in an automatically generated page with the same layout as the list page.

  • Selected existing page...
    Select a page from the list of existing pages that has the desired layout. When you click on the user, the user profile is displayed in this specific page.

    NOTE: The page on which you want the user profile displayed must have a Users list widget added.

• Detail template
  Select the template you want to use to display user's details on the webpage.

• CSS classes
  Expand More options section to specify CSS file names and apply additional CSS classes to the Users list widget.

Advanced settings

In Advanced settings, you specify individual properties of the widget:

• DetailsPageId
  Gets the ID of the page you selected in the Selected exsting page... option in the Single item settings tab page.

• DetailTemplateName
  Gets the template you selected in the Detail template dropdown menu in the Single item settings tab page.

• ListTemplateName
  Gets the template you chose in the List template dropdown menu in the List settings tab page.

• OpenInSamePage
  Defines whether when you click on a user you want to open the detail view in a new window.  The default value is False.

Model settings

Model settings display all properties directly bound to the Users list widget model. Access these properties by clicking the Model button in Advanced settings.

• DetailCssClass
  Gets and sets an additional CSS class to the detail view of a user.

• DisplayMode
  Gets the value you selected in the Simple List settings tab page:

  • Paging
    This is the default option.
  • Limit
  • All

• FilterExpression
  Filters users based on an additional filter expression.

• ItemsPerPage
  Defines the number of users per page when paging is enabled. The default value is 20.

• ListCssClass
  Gets and sets an additional CSS class to the list view.

• ProfileTypeFullName
  Gets the option that you chose for profile type in the Content tab page.

• ProviderName
  If you have more than one providers added, you can use a user profile provider different than the default one. To do this, specify the name of this provider.

  NOTE: If you leave this property value empty, the default user profile provider is used.

• SelectionMode
  Gets the option that you chose for users in the Content tab page. The possible values you can chose from are:

  • AllItems
    This is the default option.
  • SelectedItems
  • FilteredItems

• SerializedAdditionalFilters
  In case users are filtered based on a role they belong to, the selected roles are serialized and populated in that field.

• SerializedSelectedItemsIds
  In case users are specifically selected, the IDs of the selected users are serialized and populated in that field. For example: ["3f47d0b8-2d22-6e58-888c-ff0000bfc4e0"]

• SortExpression
  Adds additional sorting expression for the users. The default value is FirstName ASC.