IOptionsManager interface

The IOptionsManager interface deals with the options of a system wide Preferences dialog or project centric Project Options dialog.

public interface IOptionsManager

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Remarks

A server needs to register its own options pages within the Client module of Altium Designer. The TServerModule class from the RT_ServerImplementation unit within the Altium Designer RTL has a RegisterOptionsPageClass method for you to override. You need to pass in the name of the options page and the Options Form of TOptionsForm type. Normally this form is the same as the server panel form with the controls on it.

Methods

Method	Returns	Description
GetOptionsReader	IOptionsReader	This method retrieves the IOptionsReader method which enables you to read setting values for the Options of the specified server.
GetOptionsReader_FromIniFile	IOptionsReader
GetOptionsWriter	IOptionsWriter	This method retrieves the IOptionsWriter method which enables you to write setting values for the Options of the specified server.
GetOptionsWriter_ForIniFile	IOptionsWriter
OptionsExist	bool	This method checks if the options for the specified server exist on the system wide Preference dialog.

GetOptionsReader

This method retrieves the IOptionsReader method which enables you to read setting values for the Options of the specified server.

IOptionsReader GetOptionsReader(string argServerName, string argOldSettingsPath);

Parameter	Type	Passing
argServerName	string	value
argOldSettingsPath	string	value

Returns: IOptionsReader

Extension method of IOptionsManagerHelper (using DXP;).

See also: IOptionsWriter, IOptionsReader

GetOptionsReader_FromIniFile

No description yet.

IOptionsReader GetOptionsReader_FromIniFile(string argFullPath);

Parameter	Type	Passing
argFullPath	string	value

Returns: IOptionsReader

Extension method of IOptionsManagerHelper (using DXP;).

GetOptionsWriter

This method retrieves the IOptionsWriter method which enables you to write setting values for the Options of the specified server.

IOptionsWriter GetOptionsWriter(string argServerName);

Parameter	Type	Passing
argServerName	string	value

Returns: IOptionsWriter

Extension method of IOptionsManagerHelper (using DXP;).

See also: IOptionsWriter, IOptionsReader

GetOptionsWriter_ForIniFile

No description yet.

IOptionsWriter GetOptionsWriter_ForIniFile(string argFullPath);

Parameter	Type	Passing
argFullPath	string	value

Returns: IOptionsWriter

Extension method of IOptionsManagerHelper (using DXP;).

OptionsExist

This method checks if the options for the specified server exist on the system wide Preference dialog.

bool OptionsExist(string argServerName, string argOldSettingsPath);

Parameter	Type	Passing
argServerName	string	value
argOldSettingsPath	string	value

Returns: bool

Returned by

IClient.GetOptionsManager, IClientAPI_Interface.GetOptionsManager