Class PreferenceKeyProvider

MDO Provider that retrieves a list of preference keys corresponding to a given section

Inheritance
object
LiteralsOnlyBase
PreferenceKeyProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("PreferenceKey")]
[MDOAdditionalInfo("Preference section name, optionally followed by ;excludesystemwide to exclude preferences that belong in the System Settings gui", "Functions")]
public class PreferenceKeyProvider : LiteralsOnlyBase, ISoListProvider, ISoList
Remarks

Preferences are described in the prefdesc table. This provider will retrieve descriptions for all keys grouped under a given section, passed in as the additionalInfo to the constructor.

Use the UserPreferenceStrings class to avoid (mis)coding preference section and key names as strings.

Each item contains the programmatic key name in the extraInfo field.

Constructors

PreferenceKeyProvider()

MDO Provider that retrieves a list of preference keys corresponding to a given section

Declaration
public PreferenceKeyProvider()
Remarks

Preferences are described in the prefdesc table. This provider will retrieve descriptions for all keys grouped under a given section, passed in as the additionalInfo to the constructor.

Use the UserPreferenceStrings class to avoid (mis)coding preference section and key names as strings.

Each item contains the programmatic key name in the extraInfo field.

Fields

ProviderName

MDO Provider that retrieves a list of preference keys corresponding to a given section

Declaration
public const string ProviderName = "PreferenceKey"
Field Value
Type Description
string
Remarks

Preferences are described in the prefdesc table. This provider will retrieve descriptions for all keys grouped under a given section, passed in as the additionalInfo to the constructor.

Use the UserPreferenceStrings class to avoid (mis)coding preference section and key names as strings.

Each item contains the programmatic key name in the extraInfo field.

Methods

AddItemsAsync(CancellationToken)

Subclass contract: use the RawRootItems and RawHeadingItems properties to add items to your literals-only list. The base class will then perform any search or flattening required.

Declaration
protected override Task AddItemsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
Overrides
Remarks

Lists that only contain literals can be either flat or grouped. If you create a grouped list and the caller specifies a forceFlatList attribute, the base class will do the flattening for you.

Examples

This example shows a typical implementation of a literal list, in this case the date interval list from the Filter dialog:

[MDOProviderPlugin( "FilterFutureDate" )]
public class FilterFutureDateList : LiteralsOnlyBase
{
	protected override void AddItems()
	{
		RawRootItems.Add( new SoListItem( 1, "[SR_DATE_RANGE_3MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 2, "[SR_DATE_RANGE_4MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 3, "[SR_DATE_RANGE_6MONTHS]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 4, "[SR_DATE_RANGE_1YEAR]", string.Empty, string.Empty ) );
		RawRootItems.Add( new SoListItem( 5, "[SR_DATE_RANGE_2YEAR]", string.Empty, string.Empty ) );
	}
}

Note that using a search in this case yields unexpected results. The search is performed on the raw items, which contains resource tags - and that is not what you actually want to search against. So resources + search do not go together.

Implements

Extension Methods