CTObjectDataHandlerE, O, S Class

This is a generic abstraction that simplifies custom data sourcing CT core objects needing both ObjectEditGuard and EventExtension. It handles caching and basic interractions with CT's core. This class is designed to be specialized further within CT Core into handlers such as LookupListHandlerE, S and SearchGroupHandlerE, S.

Inheritance Hierarchy

SystemObject
  CTExtensions.ExportCore.EXTsEventExtension
    CTExtensions.ExportCore.EXTsEventExtensionE
      CTExtensions.ExportCore.CTObjectDataCTObjectDataHandlerE, O, S
        CTExtensions.ExportCore.EXTsLookupListHandlerE, S
        CTExtensions.ExportCore.EXTsSearchGroupHandlerE, S

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

Syntax

Copy

public abstract class CTObjectDataHandler<E, O, S> : EventExtension<E>, 
	ICTObjectOwner<E, O, S>, ICTObjectOwner
where E : CTExtension
where O : 
where S : new(), CTObjectTaggedSettings<O>

Public MustInherit Class CTObjectDataHandler(Of E As CTExtension, O As , S As {New, CTObjectTaggedSettings(Of O)})
	Inherits EventExtension(Of E)
	Implements ICTObjectOwner(Of E, O, S), ICTObjectOwner

Type Parameters

E: Extension type
O: CT Core object type
S: Settings object that inherits CTObjectTaggedSettingsO.

The CTObjectDataHandlerE, O, S type exposes the following members.

Constructors

	Name	Description
	CTObjectDataHandlerE, O, S	Initializes a new instance of the CTObjectDataHandlerE, O, S class

Top

Properties

	Name	Description
	Parent	Parent Extension
	Type	Type of the guarded object must be provided by the inheritant. Must not change once provided.

Top

Methods

	Name	Description
	ApplyEdit	Occurs when user applies changes to Owned CT Core object at Options. If you cancel the apply by returning false, you should also display a message for user.
	ClearCaches	Clears the cache. Should be called e.g. when user exists the Options. ExportBase2MAIN, EXPORTHANDLER, FIELDSETTINGSTYPE, EXPORTSETTINGSTYPE, PROFILESETTINGSTYPE, USERSETTINGSTYPE, LOOKUPLISTHANDLER, LOOKUPLISTSETTINGS, SEARCHGROUPHANDLER, SEARCHGROUPSETTINGS calls this automatically.
	CreateEditGuard	This function create new instance of CTObjectGuardE, O, S. Can be overridden to provide specialized version.
	CreateNewCTObject	Use CT API to create new core object of type O. Name is already ensured to be unique.
	CreateNewSettings	Creates and initialises new settings object of type S. This object is not owned after created. To create new owned object, call this first and then call CreateOwnedObject(S, String). If you want to add new settings object to existing core object, then after calling this, set the existing object to CTObject of S and call StoreSettingsAndSaveObject(S) for it.
	CreateOwnedObject	Creates new lookuplist for the settings if it doesn't have. Given baseName is used as basis but unique name is obtained with number in parenthesis if it's in use.
	DeleteObject	Delete the object
	EnterEdit	Occurs when user attempts to edit Owned CT Core object at Options. If you prevent access by returning false, you should also display a message for user.
	GetAll	Retuns all objects of type O from CT API. Uses cache. If you want to refresh the cache, call ClearCaches first.
	GetAllFromCTAPI	Use CT API to retrieve ALL Core Objects of type O.
	GetEditGuard	Gets the Edit Guard. Initializes and cached it, if not initialized already.
	GetEventExtension	This calls is the event extension.
	GetExtenionData	Get the extension data from the core object.
	GetOwned	Returns settings for all existing objects that are owned. An object is considered to be owned if it has stored data. To remove ownership, use RemoveOwnership(O). Settings has the object in question tagged to CTObject. Uses cache. If you want to refresh the cache, call ClearCaches first.
	GetUniqueName	Gets unique lookuplist name for the base name, by adding a number to parenthesis until unique name is found.
	Init	EventExtension Init, called by the system. Can be overridden but inheritant must first call: C# Copy base.Init(parent); (Overrides EventExtensionEXTTYPEInit(EXTTYPE))
	PreDelete	Occurs when user attempts to delete Owned CT Core object at Options. If you prevent deletion by returning false, you should also display a message for user.
	RemoveOwnership	Removes ownership of the given list.
	RenameObject	Rename the object.
	SetExtensionData	Set the extension data for the core object.
	StoreSettingsAndSaveObject	Saves the lookuplist and serializes the settings into it.

Top

Fields

	Name	Description
	moEditGuard	The object edit guard that handles core GUI interactions.

Top

Revision History

Date	Version	Description
-	2025 SP1	First Release

Reference

CTExtensions.ExportCore.CTObjectData Namespace