Interface IArchiveExtender
This interface defines an Archive Extender: A class that adds columns to an existing query. This interface is defined as the sum of its parents: IArchiveProviderDoesExtend for the actual extension part, IArchiveProviderHasColumns for the property of adding columns to the final result; IArchiveProviderExtensible because extenders are themselves extensible and should be able to form chains; and SuperOffice.Factory.IPlugin because extenders are added as plugins to their parents by the factory mechanism. Some extra functionality is also defined, that is an extension of the strict properties
Inherited Members
Namespace: SuperOffice.CRM.ArchiveLists
Assembly: SoDataBase.dll
Syntax
public interface IArchiveExtender : IArchiveProviderDoesExtend, IArchiveProviderHasColumns, IArchiveProviderExtensible, IPluginProperties
DisplayNamePrefix
Read-only property that returns the current display name prefix. Prefixes are set using SetPrefixes(String, String).
Declaration
string DisplayNamePrefix { get; }Property Value
| Type | Description |
|---|---|
| String |
NamePrefix
Read-only property that returns the current name prefix. Prefixes are set using SetPrefixes(String, String).
Declaration
string NamePrefix { get; }Property Value
| Type | Description |
|---|---|
| String |
Methods
SetLocalAbsolutePrefixes(String, String)
Set the prefixes for all columns provided by this extender; the prefixes are absolute, not recursed, and with no added delimiters
Declaration
void SetLocalAbsolutePrefixes(string namePrefix, string displayNamePrefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | namePrefix | Name prefix to set; null if no prefix should be set |
| String | displayNamePrefix | Display name prefix to set; null if no display name prefix should be set |
SetPrefixes(String, String)
Set the prefixes for all columns provided by this extender (and its children, prefixes are set recursively down the chain of extenders).
Declaration
void SetPrefixes(string namePrefix, string displayNamePrefix)Parameters
| Type | Name | Description |
|---|---|---|
| String | namePrefix | Name prefix to set; null if no prefix should be set |
| String | displayNamePrefix | Display name prefix to set; null if no display name prefix should be set |