Search Framework:
TabPage
Namespace: WealthLab.WPF
Parent: UserControl

TabPage is a user interface class derived from the WPF UserControl. It serves as the base class for custom pages that WL9 Extensions can add to the WL9 Preferences tool. A custom WL9 Extension (WL9ExtensionBase) can override its PreferencePages property to return TabPage instances. WealthLab adds these pages to the Preferences tool's tab control. Override the properties and methods below to provide the tab's text and help page, perform initialization and cleanup, and respond to changes in Expert Mode.

Members
Cleanup
public virtual void Cleanup()

Called when the tab page is closed. Override this method to perform any required cleanup, such as releasing resources or detaching event handlers. The default implementation performs no action.


HelpToken
public virtual string HelpToken

Returns the help token associated with this tab page. Override this property to specify the help page that should be opened when the user invokes Help from this tab page. By default, HelpToken returns the value of TabText.


Initialize
public virtual void Initialize()

Called when the tab page is initialized. Override this method to perform any initialization required by your tab page, such as loading settings or initializing controls. The default implementation performs no action.


SetExpertMode
public virtual void SetExpertMode(bool expertModeOn)

Called when the tab page should update its user interface to reflect the current state of WL9 Expert Mode. The expertModeOn parameter is true when Expert Mode is enabled and false when it is disabled. Override this method if your tab page contains controls or functionality that should be displayed, hidden, enabled, or disabled depending on Expert Mode. The default implementation performs no action.


TabText
public virtual string TabText

Returns the text displayed on the Preferences tool's tab for this page. Override this property to provide the appropriate tab caption. The default implementation returns "Tab Text".