ExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS Class

Base class for Export related integrations/extensions. This class utilizes the GenericExportHandlerT, E, I and common settings extensions with it. It also provides capabilities to custom source lookuplists and search groups, and also implements caching of settings.

Inheritance Hierarchy

SystemObject
  CTExtensionsCTExtension
    CTBuiltInExtension
      CTExtensions.ExportCoreExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE
        CTExtensions.ExportCoreExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS

Namespace: CTExtensions.ExportCore
Assembly: CTInterface (in CTInterface.dll) Version: 25.0

Syntax

Copy

public abstract class ExportBase2<MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS> : ExportBase<FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE>, 
	ISupportsExtendedSettings
where MAIN : ExportBase2<MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS>
where EXPORTHANDLER : new(), EventExtension, IGenericExportHandler
where FIELDSETTINGSTYPE : new(), ExtendedExportFieldSettings
where EXPORTSETTINGSTYPE : new(), ExtendedExportSettings<FIELDSETTINGSTYPE>
where PROFILESETTINGSTYPE : new(), SettingsObject
where USERSETTINGSTYPE : new(), SettingsObject
where LOOKUPLISTHANDLER : new(), LookupListHandler<MAIN, LOOKUPLISTSETTINGS>
where LOOKUPLISTSETTINGS : new(), LookupListSettings
where SEARCHGROUPHANDLER : new(), SearchGroupHandler<MAIN, SEARCHGROUPSETTINGS>
where SEARCHGROUPSETTINGS : new(), SearchGroupSettings

Public MustInherit Class ExportBase2(Of MAIN As ExportBase2(Of MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS), EXPORTHANDLER As {New, EventExtension, IGenericExportHandler}, FIELDSETTINGSTYPE As {New, ExtendedExportFieldSettings}, EXPORTSETTINGSTYPE As {New, ExtendedExportSettings(Of FIELDSETTINGSTYPE)}, PROFILESETTINGSTYPE As {New, SettingsObject}, USERSETTINGSTYPE As {New, SettingsObject}, LOOKUPLISTHANDLER As {New, LookupListHandler(Of MAIN, LOOKUPLISTSETTINGS)}, LOOKUPLISTSETTINGS As {New, LookupListSettings}, SEARCHGROUPHANDLER As {New, SearchGroupHandler(Of MAIN, SEARCHGROUPSETTINGS)}, SEARCHGROUPSETTINGS As {New, SearchGroupSettings})
	Inherits ExportBase(Of FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE)
	Implements ISupportsExtendedSettings

Type Parameters

MAIN: Type of you Extension
EXPORTHANDLER
FIELDSETTINGSTYPE: Custom type derived from ExtendedExportFieldSettings representing Export Profile Field settings.
EXPORTSETTINGSTYPE: Custom type derived from ExportSettingsBaseFIELDSETTINGSTYPE representing Export Profile settings. Use Dummy when not needed.
PROFILESETTINGSTYPE: Custom type derived from SettingsObject representing Profile settings. Use Dummy when not needed.
USERSETTINGSTYPE: Custom type derived from SettingsObject representing User settings. Use Dummy when not needed.
LOOKUPLISTHANDLER
LOOKUPLISTSETTINGS
SEARCHGROUPHANDLER
SEARCHGROUPSETTINGS

The ExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS type exposes the following members.

Constructors

	Name	Description
	ExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS	Initializes a new instance of the ExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS class

Top

Properties

	Name	Description
	ExportHandler	Accessor for the Export Handler The setter ONLY allows nullifying this.
	LookupListHandler	Accessor for the LookupListHandler The setter ONLY allows nullifying this.
	ProfileSettings	Use this instead of GetProfileSettings to access cached settings, to avoid unnecessary database calls. The setter ONLY allows nullifying this.
	SearchGroupHandler	Accessor for the SearchGroupHandler The setter ONLY allows nullifying this.
	UserSettings	Use this instead of GetUserSettings to access cached settings, to avoid unnecessary database calls. The setter ONLY allows nullifying this.

Top

Methods

	Name	Description
	ClearCaches	Clears cached settings. Automatically called on Options close.
	ExportSettings	Use this to obtain cached settings for given export profile, to avoid unnecessary database calls.
	GetEventExtensions	Default implementation provides the ExportHandler, LookupListHandler and SearchGroupHandler. (Overrides ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPEGetEventExtensions)
	GetExtendedExportSettings	Explicit implementation of GetExtendedExportSettings(CTExportProfile). Returns what ever ExportSettings(CTExportProfile) returns.
	GetInterface2	Overrides the base to provide object guards also for LookupListHandler and SearchGroupHandler. (Overrides ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPEGetInterface2(ctExtensionInterface))
	Hook	Calls base class Hook(CTInterface) and registers to OnOptionsClosedNotify2 to call ClearCaches automatically. (Overrides ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPEHook(CTInterface))
	Log	Compared to LogToFile(String), this function calls Log(String) which then logs to PDM Task Log if available or calls LogToFile(String) if not.
	OnOptionsClosedNotify	Event Handler for options closing.
	SupportedExtendedExportFieldSettings	Override to add support for common export field features, by returning Property Names from IExtendedExportFieldSettings.
	SupportedExtendedExportSettings	Override to add support for common export features, by returning Property Names from IExtendedExportSettings.
	Translate(Int32, String)	Public accessor for built-in translations.
	Translate(String, Int32, String)	Public accessor for built-in translations.
	UnHook	Calls base class UnHook(CTInterface) and unregisters from OnOptionsClosedNotify. (Overrides ExportBaseFIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPEUnHook(CTInterface))

Top

Reference

CTExtensions.ExportCore Namespace