UserOptionsExtension Class

Base implementation of interface type ctExtensionInterfaceUserSettings. Inheritant must implement at least GetParent, CreateControl, LoadData(Byte), GetSaveData(Boolean), Validate and Refresh. Override GetInterface2(ctExtensionInterface) in your extension and return your implementation of this class when requested type is ctExtensionInterfaceUserSettings. This will add your extension to CUSTOMTOOLS' User options page.

Inheritance Hierarchy

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

Syntax

public abstract class UserOptionsExtension : IExtensionInterface

Public MustInherit Class UserOptionsExtension
	Implements IExtensionInterface

The UserOptionsExtension type exposes the following members.

Constructors

	Name	Description
	UserOptionsExtension	Initializes a new instance of the UserOptionsExtension class

Properties

	Name	Description
	SetupForUser	User in which context the settings are read/saved.

Methods

	Name	Description
	CreateControl	Provide the control for your page. This is called in lazy-load manner, when the user selects this profile options extension from the tree.
	CreateSettingsControl	Create and return window handle for custom options page. Default implementation handles control lifetime and inheritant may just enjoy from CreateControl.
	Dispose	Called when the settings page is closed. Disposes the control if not disposed already. Inheriants can ignore this if also CreateSettingsControl is left in default implementation.
	GetParent	Return parent CTExtension of this user options extension.
	GetSaveData	Called after Validate. Provide the data you wish to save.
	Init	Sets SetupForUser which is used in data retrieval and save.
	LoadData	Called after CreateControl. Setup the control you created with this stored data.
	PageName	Name that is shown in user options tree. By default this is parents FriendlyName.
	ReadUserData	Helper function to read parent extension's user specific data from given profile.
	Refresh	Notification that occurs when user re-enters to this extension's user options page.
	Save	Called when user clicks OK at options and all pages have returned true on Validate. Inheriants can ignore this and just return data at GetSaveData(Boolean) when called.
	StoreUserData	Helper function to store parent extension's data to given profile.
	TabPress	Called when TAB is pressed. Handles control focusing.
	Validate	Validate settings user has made to your control. Show error message if needed.

Revision History

Date	Version	Description
-	2019 SP2	First Release