Click or drag to resize

PositionSelectOption Class

Adding an object of this type to a Wizard's option list creates an additional settings page that displays the data of the spectrum in question with a defined transfer function and plot style. The user can select positions in the plot using different types of markers as defined in the Type property.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.Wizard.WizardOptionsWizardOptionBase
    RelaxIS_SDK.Wizard.WizardOptionsPositionSelectOption

Namespace: RelaxIS_SDK.Wizard.WizardOptions
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63
Syntax
Copy
public class PositionSelectOption : WizardOptionBase

The PositionSelectOption type exposes the following members.

Constructors
 NameDescription
Public methodPositionSelectOption(String, String, Int32) Initializes a new object of type PositionSelectOption with the given name, caption and sorting index.
Public methodPositionSelectOption(String, String, Int32, PositionSelectOptionPositionSelectType, String, String, Int32) Initializes a new object of type PositionSelectOption with the given name, caption, sorting index, options and a fixed number of positions to select.
Public methodPositionSelectOption(String, String, Int32, PositionSelectOptionPositionSelectType, String, String, String) Initializes a new object of type PositionSelectOption with the given name, caption, sorting index, options and a datasource for the number of positions to select.
Top
Properties
 NameDescription
Public propertyCaption The caption that is mainly used to display the option in the Wizard's settings page.
(Inherited from WizardOptionBase)
Public propertyDimensions The size of this option's display control in the Wizard dialog.
(Inherited from WizardOptionBase)
Public propertyDisplayIndex The position of this option in the settings list of the Wizard dialog.
(Inherited from WizardOptionBase)
Public propertyName The internal name of the option that can be used to refer to this option in the results.
(Inherited from WizardOptionBase)
Public propertyNumberDatasource The name of the NumericOption to get the number of positions from
Public propertyNumberofPositions The number of positions the user has to select
Public propertyPlotType The internal name of the plot premade to display to the user
Public propertySortIndex The internal SortIndex used by the IOrdered interface.
(Inherited from WizardOptionBase)
Public propertyTooltip The tooltip display for this option.
(Inherited from WizardOptionBase)
Public propertyTransferFunction The internal name of the transfer function used to create the plot data
Public propertyTransferFunctionDatasource The name of either a TextOption or of a MultipleChoiceOptions to get the name of the transfer function from
Public propertyType Defines what type of markers to display to the user to select the positions
Top
Methods
 NameDescription
Public methodToCheckboxOption Helper function to get a CheckboxOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Public methodToMultipleChoiceOption Helper function to get a MultipleChoiceOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Public methodToNumericOption Helper function to get a NumericOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Public methodToPositionSelectOption Helper function to get a PositionSelectOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Public methodToSubOptionOption Helper function to get a SubOptionOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Public methodToTextOption Helper function to get a TextOption from the WizardOptionBase object.
(Inherited from WizardOptionBase)
Top
Remarks
The number of positions to select can be either defined with a constant value using the NumberOfPositions property or it can come from another NumericOption in the Wizard List by specifying the name of the NumericOption in the NumberDatasource property.
See Also