Class AllPreferenceKeysProvider

MDO Provider that retrieves all preference keys

Inheritance
object
LiteralsOnlyBase
AllPreferenceKeysProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.BusinessLogic.dll
Syntax
[MDOProviderPlugin("AllPreferenceKeys")]
public class AllPreferenceKeysProvider : LiteralsOnlyBase, ISoListProvider, ISoList
Remarks

All preferences that are not sections are returned, grouped alphabetically. If addidionalInfo is OrderBySection, it is first grouped alphabetically by section. Preferences that have list of values are bolded.

Constructors

AllPreferenceKeysProvider()

MDO Provider that retrieves all preference keys

Declaration
public AllPreferenceKeysProvider()
Remarks

All preferences that are not sections are returned, grouped alphabetically. If addidionalInfo is OrderBySection, it is first grouped alphabetically by section. Preferences that have list of values are bolded.

Fields

ProviderName

MDO Provider that retrieves all preference keys

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

All preferences that are not sections are returned, grouped alphabetically. If addidionalInfo is OrderBySection, it is first grouped alphabetically by section. Preferences that have list of values are bolded.

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