Class ExportTemplateProvider

MDO provider for the list of template files for the 'export to file' function in the Selection Task pane. These are .sxf files found in so_arc/template, as well as in the so_arc/<username> directory of the current user.

Impersonation is used if specified by the config file to access the document directories.

The file name is returned as the list item name, while the full path is in the extrainfo.
Inheritance
object
LiteralsOnlyBase
ExportTemplateProvider
Inherited Members
Namespace: SuperOffice.CRM.Lists
Assembly: SoDataBase.dll
Syntax
[MDOProviderPlugin("ExportTemplate", IsAutoDiscoverable = false)]
public class ExportTemplateProvider : LiteralsOnlyBase, ISoListProvider, ISoList

Constructors

ExportTemplateProvider(IFileAccess)

MDO provider for the list of template files for the 'export to file' function in the Selection Task pane. These are .sxf files found in so_arc/template, as well as in the so_arc/<username> directory of the current user.

Impersonation is used if specified by the config file to access the document directories.

The file name is returned as the list item name, while the full path is in the extrainfo.
Declaration
public ExportTemplateProvider(IFileAccess fileAccess)
Parameters
Type Name Description
IFileAccess fileAccess

Fields

ProviderName

MDO provider for the list of template files for the 'export to file' function in the Selection Task pane. These are .sxf files found in so_arc/template, as well as in the so_arc/<username> directory of the current user.

Impersonation is used if specified by the config file to access the document directories.

The file name is returned as the list item name, while the full path is in the extrainfo.
Declaration
public const string ProviderName = "ExportTemplate"
Field Value
Type Description
string

Methods

AddItems()

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 void AddItems()
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