IOptionsPage interface
The IOptionsPage interface represents the page of controls in the system wide Preferences dialog. For example, in Altium Designer, the controls on this page in the Preferences dialog are mapped from the controls on a server panel of this server. The controls on a page is represented by the TOptionsForm object and its IOptionsPage interface.
public interface IOptionsPage
Namespace: DXP · Assembly: Altium.SDK.Interfaces
Remarks
The server module (TServerModule class) has the RegisterOptionsPageClass method which takes in the TOptionsForm object. The IOptionsPage interface represents this TOptionsForm object.
The TOptionsForm class has methods that you need to override to implement the OptionsPage, OptionsManager, OptionsReader and OptionsWriter interfaces.
ClearModified
DoSetStateControls
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| Modified | bool | get; set |
Modified
No description yet.
bool GetModified();
void SetModified(bool argValue);
Type: bool · Access: read/write
Methods
| Method | Returns | Description |
|---|---|---|
| GetNotificationCode | int | Each server that handles Option notifications to its server panel and the system wide Preferences dialog in Altium Designer will have its own Notification code which could be a value of 100 upwards. |
| GetStateControls | void | This method |
| OptionsFormDataManager | IOptionsFormDataManager | |
| PostEditControls | void | |
| SetDefaultState | void | This method sets the controls on a page within the system wide Preferences dialog to their default values. |
| SetStateControls | void | This method updates the controls on the form from a data structure in a server module. |
| TryApplyFormOptions | bool |
GetNotificationCode
Each server that handles Option notifications to its server panel and the system wide Preferences dialog in Altium Designer will have its own Notification code which could be a value of 100 upwards.
int GetNotificationCode();
Returns: int
A server module will have a TOptionsForm object registered and this object will have a GetNotificationCode method overridden. This server module will have its own notification code value. Ensure these notification codes are unique.
GetStateControls
This method
void GetStateControls();
Returns: nothing (void)
OptionsFormDataManager
No description yet.
IOptionsFormDataManager OptionsFormDataManager();
Returns: IOptionsFormDataManager
Extension method of IOptionsPageHelper (using DXP;).
PostEditControls
No description yet.
void PostEditControls();
Returns: nothing (void)
SetDefaultState
This method sets the controls on a page within the system wide Preferences dialog to their default values.
void SetDefaultState();
Returns: nothing (void)
The SetDefaultState method is overridden in a server's TOptionsForm object.
SetStateControls
This method updates the controls on the form from a data structure in a server module.
void SetStateControls();
Returns: nothing (void)
TryApplyFormOptions
No description yet.
bool TryApplyFormOptions();
Returns: bool
Returned by
IServerOptions.CreateOptionsPageByName, IVcsProvider.GetOptionPage, IPartProvider.GetOptionsPage, ISupplier.GetOptionsPage
Examples
Used in the SDK examples: Ciiva, Extension_Preference.