CheckboxOption Class

Adding an object of this type to a Wizard's option list creates a checkbox with a specific text to the settings that the user can check or uncheck.

Inheritance Hierarchy

SystemObject
RelaxIS_SDK.Wizard.WizardOptionsWizardOptionBase
RelaxIS_SDK.Wizard.WizardOptionsCheckboxOption

Namespace: RelaxIS_SDK.Wizard.WizardOptions
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.24.6

Syntax

public class CheckboxOption : WizardOptionBase

Public Class CheckboxOption
	Inherits WizardOptionBase

Dim instance As CheckboxOption

The CheckboxOption type exposes the following members.

Constructors

	Name	Description
	CheckboxOption(String, String, Int32)	Initializes a new object of type CheckBoxOption with the given name, caption and Sorting Index.
	CheckboxOption(String, String, Int32, Boolean)	Initializes a new object of type CheckBoxOption with the given name, caption, Sorting Index and default value.

Properties

	Name	Description
	Caption	The caption that is mainly used to display the option in the Wizard's settings page. (Inherited from WizardOptionBase)
	DefaultValue	Determines if the checkbox is checked or unchecked by default
	Dimensions	The size of this option's display control in the Wizard dialog. (Inherited from WizardOptionBase)
	DisplayIndex	The position of this option in the settings list of the Wizard dialog. (Inherited from WizardOptionBase)
	Name	The internal name of the option that can be used to refer to this option in the results. (Inherited from WizardOptionBase)
	SortIndex	The internal SortIndex used by the IOrdered interface. (Inherited from WizardOptionBase)
	Tooltip	The tooltip display for this option. (Inherited from WizardOptionBase)

Methods

	Name	Description
	ToCheckboxOption	Helper function to get a CheckboxOption from the WizardOptionBase object. (Inherited from WizardOptionBase)
	ToMultipleChoiceOption	Helper function to get a MultipleChoiceOption from the WizardOptionBase object. (Inherited from WizardOptionBase)
	ToNumericOption	Helper function to get a NumericOption from the WizardOptionBase object. (Inherited from WizardOptionBase)
	ToPositionSelectOption	Helper function to get a PositionSelectOption from the WizardOptionBase object. (Inherited from WizardOptionBase)
	ToSubOptionOption	Helper function to get a SubOptionOption from the WizardOptionBase object. (Inherited from WizardOptionBase)
	ToTextOption	Helper function to get a TextOption from the WizardOptionBase object. (Inherited from WizardOptionBase)

Remarks

You can define the default check-state by using the DefaultValue property.