tWidgetConfigPropSettings

See Also: tWidgetDef, tWidgetConfigPropSetting, tWidgetConfigPropSettings, Declaring Variables, Struct

Purpose

tWidgetConfigPropSettings is a structured type that is used to represent settings of a cWebWidget configurable prop. These are mostly relevant when using the cWebWidgetConfigurationWizardStandard.

Type Declaration

Struct tWidgetConfigPropSettings
    String sOptLabel
    String sOptDescription
    Integer eControlType      // 0 = form, 1 = combo, 2 = slider, 3 = checkbox. Use above enum
    Boolean bOptValidateValue
    Integer iOptMinValue
    Integer iOptMaxValue
    Integer iOptStepSize
    String[] asOptValues
End_Struct

Struct Members

sOptLabel

When using the cWebWidgetConfigurationWizardStandard class, this defines the label the generated input control will have.

sOptDescription

When using the cWebWidgetConfigurationWizardStandard class, this defines the control's alt text.

eControlType

When using the cWebWidgetConfigurationWizardStandard class, this enum (prefixed with “WCT_”) defines what control (Form, Combo, Slider, or Checkbox) will be created.

bOptValidateValue

When using the cWebWidgetConfigurationWizardStandard class, this defines whether the entered value should be validated against a list or range of valid values.

iOptMinValue

When using the cWebWidgetConfigurationWizardStandard class, if the value is numeric, this defines the minimum the value should be when validated.

iOptMaxValue

When using the cWebWidgetConfigurationWizardStandard class, if the value is numeric, this defines the maximum the value should be when validated.

iOptStepSize

When using the cWebWidgetConfigurationWizardStandard class, if the value is numeric, this defines the steps in the range of values (min & max) the value can be when validated. This also determines the slider step size if the chosen control type is a slider.

asOptValues

When using the cWebWidgetConfigurationWizardStandard class, this defines a list of possible values to match against during validation.

Syntax

Use WebWidgetStructs.pkg
:
tWidgetConfigPropSettings {variableName}

Declaring Variables

To declare tWidgetConfigPropSettings variables, use the name of the type (tWidgetConfigPropSettings) followed by the variable name.

tWidgetConfigPropSettings wcpsSettingsOne

See struct variables for more details on instantiating struct types.