Interface IOptionsPage
This interface must be implemented to add a page to the Options dialog.
Namespace: ABB.Robotics.RobotStudio.Environment
Assembly: ABB.Robotics.RobotStudio.Environment.dll
Syntax
public interface IOptionsPage
Properties
Caption
Returns the caption of the page as displayed in the page list
Declaration
string Caption { get; }
Property Value
Type | Description |
---|---|
String |
Description
Returns a description for the page that will be displayed above it.
Declaration
string Description { get; }
Property Value
Type | Description |
---|---|
String |
GroupCaption
Returns the name of the group the page should be sorted under
Declaration
string GroupCaption { get; }
Property Value
Type | Description |
---|---|
String |
Id
Returns a unique ID for the page
Declaration
string Id { get; }
Property Value
Type | Description |
---|---|
String |
Modified
Returns true if the page contents have changed
Declaration
bool Modified { get; }
Property Value
Type | Description |
---|---|
Boolean |
PageControl
Returns the Windows Forms Control that contains the page contents
Declaration
Control PageControl { get; }
Property Value
Type | Description |
---|---|
Control |
Remarks
It is OK to let the control itself implement IOptionsPage, in that case just "return this" from this property.
Methods
Apply()
Applies changes made in the page UI
Declaration
void Apply()
HasErrors()
Returns true if there are errors in any of the input fields on the page
Declaration
bool HasErrors()
Returns
Type | Description |
---|---|
Boolean |
Reset()
Resets the page UI
Declaration
void Reset()
SetDefault()
Resets all values to their (installation) defaults
Declaration
void SetDefault()