Click or drag to resize
UserOptionsExtension Methods

The UserOptionsExtension type exposes the following members.

Methods
  NameDescription
Public methodCreateControl
Provide the control for your page. This is called in lazy-load manner, when the user selects this profile options extension from the tree.
Public methodCreateSettingsControl
Create and return window handle for custom options page. Default implementation handles control lifetime and inheritant may just enjoy from CreateControl.
Public methodDispose
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.
Public methodGetParent
Return parent CTExtension of this user options extension.
Public methodGetSaveData
Public methodInit
Sets SetupForUser which is used in data retrieval and save.
Public methodLoadData
Called after CreateControl. Setup the control you created with this stored data.
Public methodPageName
Name that is shown in user options tree. By default this is parents FriendlyName.
Public methodReadUserData
Helper function to read parent extension's user specific data from given profile.
Public methodRefresh
Notification that occurs when user re-enters to this extension's user options page.
Public methodSave
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.
Public methodStoreUserData
Helper function to store parent extension's data to given profile.
Public methodValidate
Validate settings user has made to your control. Show error message if needed.
Top
See Also