Events widget

You use the Events widget to display events on your website pages. You select what content to display and then specify how events are listed and displayed individually. The widget provides options to filter the displayed events based on various criteria.

PREREQUISITES: You created at least one event item. For more information, see Create events.

Select events to display

In the Content tab page, choose which events you want to display. Choose between the following options:

  • All events
    All events that are uploaded and published will be displayed in the list.
  • Events by date... You can filter the displayed events, depending on their start and end date. Select one or more of the following:
    • upcoming events...
      Shows events witch starts in the future. You can additionally restrict event start by clicking Select button.
    • current events
      Only events that are currently in progress will be displayed.
    • past events...
      Shows events witch end is in the past. You can additionally restrict event end by choosing one of the predefined time intervals or choosing Custom range… to select a more specific time interval.
  • Selected events...
    A custom selection of events is displayed. To select one or more events, click the Select button.

Under Narrow selection you can further specify which events to display by choosing one of the following:

  • All published events
    This is selected by default and displays all events selected in the previous step.
  • Filtered events by...
    You can narrow the displayed events, using categories, tags and calendar. Select one or more of the following:
    • Calendar...
      Select events from which calendar will be displayed.
    • Categories...
      Select categories from which to display events.
    • Tags...
      Select the tags by which to narrow down events that are displayed.

NOTE: You can select more than one filter and narrow down results using combinations of filters, for example by both categories and calendar.

List settings

List settings define how events are listed by the Events widget. Choose one of the following options:

  • Use paging
    Sitefinity divides the events into pages. In the input field, specify how many events per page to display.
  • Use limit
    Sitefinity CMS displays only a limited number of events. In the input field, specify how many events to display.
  • No limit and paging
    Sitefinity CMS displays all events that meet the requirements and filters you set in the Content tab.
  • Sort events
    By default, events are listed by start date and oldest are on top. You can select a different sorting criterion:
    • Last published on top
    • Last modified on top
    • By Title (A-Z)
    • By Title (Z-A)
    • By start date (oldest on top)
    • By start date (newest on top)
    • As set manually
    • As set in Advanced mode To sort the list of events 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 events using the Content property of the event, navigate to Advanced » Model and, for SortExpression, add Content 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 events on the webpage.
  • CSS classes Expand More options section to specify CSS file names and apply additional CSS classes to the Events widget. This CSS class will be applied while widget is in list mode.

Single item settings

Single item settings define how individual events 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 event, it 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 event, it is displayed in this specific page.

      NOTE: The page on which you want the event displayed must have a Events widget added.

  • Detail template
    Select the template you want to use to display the event's details on the webpage.
  • CSS classes Expand More options section to specify CSS file names and apply additional CSS classes to the Events 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 existing 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 event's title to open the detail view in the same page. The default value is True.

Model settings

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

  • ContentViewDisplayMode
    By default, a single content item is displayed in Detail view. This property enables you to configure whether single content items are displayed in Detail or in List view by entering Detail or List, respectively.
  • AllowCalendarExport
    Enables buttons for exporting events to Outlook, ICal, Google Calendar.
  • DetailCssClass
    Gets and sets an additional CSS class to the detail view of a event.
  • DisplayMode
    Gets the value you selected in the Simple List settings tab page:
    • Paging
      This is the default option.
    • Limit
    • All
  • ItemsPerPage
    Defines the number of events per page when paging is enabled. The default value is 20.
  • ListCssClass
    Gets and sets an additional CSS class to the list view.
  • NarrowSelectionMode
    Gets the option that you chose for events under Narrow selection by... in the Content tab page. Enter one of the following:
    • AllItems
      This is the default value.
    • FilteredItems
  • ProviderName
    If you have more than one providers added, you can use a events 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 events provider is used.

  • SelectionMode
    Gets the option that you chose for which events to display in the Content tab page.
    Enter one of the following:
    • AllItems
      This is the default option.
    • FilteredItems
    • SelectedItems
  • SerializedAdditionalFilters
    In case events are filtered based on a start date, end date, the values of the selected filter criteria are serialized and populated in this field.
  • SerializedNarrowSelectionFilters
    In case events are filtered from the Narrow selection area, the values of the selected filter criteria are serialized and populated in that field.
  • SerializedSelectedItemsIds
    In case events are specifically selected, the IDs of the selected events are serialized and populated in that field. For example, ["3f47d0b8-2d22-6e58-888c-ff0000bfc4e0"]
  • SortExpression
    Adds additional sorting expression for the events. The default value is EventStart ASC.
  • UrlKeyPrefix
    Gets or sets the URL key prefix. Used when building or evaluating URLs for paging and filtering.

Tags

MVC

Was this article helpful?