import StringSelectorMulti from './gui/data-items/StringSelectorMulti.jsx'

public class | source

StringSelectorMulti

Extends:

gui/data-items/StringSelector.js~StringSelector → StringSelectorMulti

The purpose of StringSelectorMulti is to store a list of string values given a fixed selection of choices. It will write to your tool's XML configuration the text of the "value" of the chosen options with a delimiter between them. It works with an "optionList" property which is an array of objects with "value" and "label" properties to provide user displayable text for each choice, independent of the value which will be stored in the tool's XML configuration.

Constructor Summary

Public Constructor
public	constructor(dataName: string, dataItemProps: object) Constructor

Member Summary

Public Members
public	getDelimiter: string: * Function that returns the current delimiter used in persistence of the data items value to the tool's XML configuration.
public	setDelimiter(delimiter: string): * Function that changes the current delimiter used in persistence of the data items value to the tool's XML configuration.

Public Constructors

public constructor(dataName: string, dataItemProps: object) source

Constructor

Params:

Name	Type	Attribute	Description
dataName	string		The name of the data item.
dataItemProps	object	optional	An object of properties such as hidden, disabled, suppressed etc.
dataItemProps.delimiter	string	optional default: ','	The delimiter used to separate the values in the string persisted to the tool's XML configuration.

Public Members

public getDelimiter: string: * source

Function that returns the current delimiter used in persistence of the data items value to the tool's XML configuration.

Return:

string

The current delimiter.

public setDelimiter(delimiter: string): * source

Function that changes the current delimiter used in persistence of the data items value to the tool's XML configuration.