Widget

Widget[mySequence]⟹myWidget

returns a widget that is consistent with the sequence of inputs given in mySequence.

Details

Input

Output

Messages

	ColorInvalidKeys	The Color widget does not take keys `1`. Please remove these keys.
	ColorPatternValue	The value for the key Pattern must match Verbatim[ColorP] for the Color widget. Please change the value of this key.
	DateInequalityPatternValue	The value for the key Pattern matches InequalityP but is misspecified and is not evaluating. Please change the value of this key.
	DateInvalidKeys	The Date widget does not take keys `1`. Please remove these keys.
	DateMissingTimeSelectorKey	The key TimeSelector must be specified to create a Date widget. Please include this key.
	DatePatternValue	The value for the key Pattern must match Verbatim[_?DateObjectQ] or InequalityP for the Date widget. Please change the value of this key.
	DateTimeSelectorValue	The value for the key TimeSelector must match BooleanP for the Date widget. Please change the value of this key.
	EnumerationInvalidKeys	The Enumeration widget does not take keys `1`. Please change the value of this key.
	EnumerationItemsValue	The value for the key Items must be consistent with the given Pattern. The Pattern must match Alternatives@@Items. Please change the value of this key.
	EnumerationPatternValue	The value for the key Pattern must match _Alternatives for the Enumeration widget. Please change the value of this key.
	ExpressionInvalidKeys	The MultiSelect widget does not take keys `1`. Please remove these keys.
	ExpressionMissingSizeKey	The key Size must be specified to create a Expression widget. Please include this key.
	ExpressionSizeValue	The value for the key Size must match TextBoxSizeP for the MultiSelect widget. Please change the value of this key.
	FieldReferenceFieldsValue	The value for the key Fields must match {FieldP[ObjectTypes, OutputShort]..} for the Field Reference widget. Please change the value of this key.
	FieldReferenceInvalidKeys	The Field Reference widget does not take keys `1`. Please remove these keys.
	FieldReferenceObjectTypesValue	The value for the key ObjectTypes does not match {TypeP[]..}. Please change the value of this key.
	FieldReferencePatternValue	The value for the key Pattern must match _FieldReferenceP for the Field Reference widget. Please change the value of this key.
	InvalidIncrementValue	The value for the key Increment must match the Pattern key and must be either a Quantity or Null. It is currently `1`. Please change the value of this key.
	InvalidMaxValue	The value for the key Max must match the Pattern key and must be either a DateObject or Null. It is currently `1`. Please change the value of this key.
	InvalidMinValue	The value for the key Min must match the Pattern key and must be either a DateObject or Null. It is currently `1`. Please change the value of this key.
	InvalidPatternTooltipValue	The value for the key PatternTooltip must match _String. Please change the value of this key.
	InvalidType	Type `1` is not a valid widget type. Refer to WidgetTypeP to see the valid widget types.
	MissingAssociationSequence	The sequence could not be converted to an association: `1`
	MissingPatternKey	The key Pattern must be specified to create a widget.
	MissingTypeKey	The key Type must be specified to create a widget.
	MoleculeInvalidKeys	The Molecule widget does not take keys `1`. The valid set of keys is {Type, Pattern, PatternTooltip, Identifier}. Please remove these keys.
	MoleculePatternValue	The value for the key Pattern must match ListableP[_MoleculeP] for the Molecule widget. Please change the value of this key.
	MultiSelectInvalidKeys	The MultiSelect widget does not take keys `1`. Please remove these keys.
	MultiSelectItemsValue	The value for the key Items must be consistent with the given Pattern. The Pattern should match ListableP[Alternatives@@Items]. Please change the value of this key.
	MultiSelectPatternValue	The value for the key Pattern must match ListableP[_Alternatives] for the MultiSelect widget. Please change the value of this key.
	NoKeyExists	The key `1` could not be found for this type of Widget. Please call the function Keys on your widget to see a known list of keys for this given Widget type.
	NumberIncrementValue	The value for the key Increment must match the given pattern for the Number widget. Please change the value of this key.
	NumberInvalidKeys	The Number widget does not take keys `1`. Please remove these keys.
	NumberMaxValue	The value for the key Max must match the given pattern for the Number widget. Please change the value of this key.
	NumberMinValue	The value for the key Min must match the given pattern for the Number widget. Please change the value of this key.
	NumberPatternValue	The value for the key Pattern must match InequalityP for the Number widget. Please change the value of this key.
	ObjectInvalidDereferencePattern	The Object widget's field Dereference does not match its basic pattern of {((_Object\|_Model)_Field)...}. Please change the value of `1`.
	ObjectInvalidKeys	The Object widget does not take keys `1`. The valid set of keys is {Type, Pattern, ObjectTypes, ContainersToSamples, ObjectBuilderFunctions}. Please remove these keys.
	ObjectObjectBuildersValue	The value for the key ObjectBuilderFunctions must match {_Symbol...} for the Object widget. Please change the value of this key.
	ObjectObjectTypesValue	The value for the key ObjectTypes must match {TypeP[]...} for the Object widget. Please change the value of this key.
	ObjectOpenPathRoot	The OpenPath does not begin with the Root catalog object. All OpenPaths must start with Object[Catalog,"Root"]. Please change the value of the OpenPaths key.
	ObjectOpenPathsContents	The child `1` is not located in the contents field of the parent `2`. Please change the value of the OpenPaths key.
	ObjectOpenPathsValue	The value for the key OpenPaths must match {{ObjectP[Object[Catalog]]..}...} for the Object widget. Please change the value of this key.
	ObjectPatternValue	The value for the key Pattern must match Hold[_ObjectP]\|Hold[ListableP[_ObjectP]] for the Object widget. Please change the value of this key.
	PatternSetDelayed	The key Pattern must be specified as SetDelayed (:>).
	PrimitiveInvalidKeys	The Primitive widget does not take keys `1`. Please remove these keys.
	PrimitiveMissingPrimitiveKeyValuePairsKey	The Primitive widget was unable to find information for the given primitive set pattern in the global $PrimitiveSetPrimitiveLookup. Please ensure that DefinePrimitiveSet[...] has been called for your primitive set pattern.
	PrimitivePrimitiveKeyValuePairsPrimitiveSet	The key PrimitiveKeyValuePairs must be specified to create a Primitive widget if the pattern given is not a primitive set pattern registered by calling DefinePrimitiveSet[...]. Conversely, if a pattern is given that was registered via DefinePrimitiveSet[...], the PrimitiveKeyValuePairs option cannot be specified. The PrimitiveKeyValuePairs option is deprecated in favor of using DefinePrimitiveSet[...]. Please include/exclude this key or ensure that the pattern given to the widget was created by calling DefinePrimitiveSet[...].
	PrimitivePrimitiveKeyValuePairsValue	The value for the key PrimitiveKeyValuePairs must match {(_Symbol{((_Symbol\|Verbatim[Optional][_Symbol])WidgetP)..})..} for the Primitive widget. Please change the value of this key.
	PrimitivePrimitiveTypesValue	The value for the key PrimitiveTypes must match {_Symbol..} for the Primitive widget. Please change the value of this key.
	QuantityIncrementValue	The value for the key Increment must match the given pattern for the Quantity widget. Please change the value of this key.
	QuantityInvalidKeys	The Quantity widget does not take keys `1`. Please change the value of this key.
	QuantityMaxValue	The value for the key Max must match the given pattern for the Quantity widget. Please change the value of this key.
	QuantityMinValue	The value for the key Min must match the given pattern for the Quantity widget. Please change the value of this key.
	QuantityMissingUnitsKey	The key Units must be specified to create a Quantity widget. Please change the value of this key.
	QuantityPatternUnitMismatch	The units in the Unit key have unique unit dimensions of `1` but the units in the Pattern key have unique unit dimension of `2`. The Unit and Pattern keys are mismatched. Please change the values of these keys.
	QuantityPatternUnits	The unit of the `1` value in the Quantity widget (`2`) does not match the units of the Units key (`3`) in the given Pattern `4`. Please change the value of this unit.
	QuantityPatternValue	The value for the key Quantity must match InequalityP or _Alternatives for the Quantity widget. Please change the value of this key.
	StringBoxTextValue	The value for the key BoxText must match _String\|Null for the String widget. Please change the value of this key.
	StringInvalidKeys	The String widget does not take keys `1`. Please remove these keys.
	StringMissingSizeKey	The key Size must be specified to create a String widget. Please change the value of this key.
	StringSizeValue	The value for the key Size must match TextBoxSizeP for the String widget. Please change the value of this key.
	UnitOperationInvalidKeys	The UnitOperation widget does not take keys `1`. Please remove these keys.
	UnitOperationMethodInvalidKeys	The UnitOperationMethod widget does not take keys `1`. Please remove these keys.
	UnitOperationMethodMethodsKeyRequired	The Methods key is required to construct a UnitOperationMethod widget. Please provide this key.
	UnitOperationMethodWidgetKeyRequired	The Widget key is required to construct a UnitOperationMethod widget. The Widget key must match WidgetP. Please provide this key.
	UnknownUnitShortHand	Unable to expand the unit short hand `1`. Please change the value of this unit.

Examples

Basic Examples (7)

Create a Multiselect widget:

Create an Enumeration widget:

Create an Molecule widget:

Create an String widget:

Returns $Failed if a Widget cannot be created from the provided inputs (Pattern must be provided as SetDelayed):

Returns $Failed if a Widget cannot be created from the provided inputs (the Min value is invalid):

Returns $Failed if a Widget cannot be created from the provided inputs (the Size key is required for the String Widget):

Additional Examples (19)

Create a Date widget:

Create a Field Reference widget:

Create a MultiSelect widget:

Create an Color widget:

Create an Expression widget:

Create an Number widget:

Create an Quantity widget:

Create an Quantity widget, using short hand syntax for the units:

Create an Quantity widget, using short hand syntax for the units with an Alternatives:

Create an Quantity widget, using short hand syntax for the units with an Alternatives and a CompoundUnit:

Create an Quantity widget, with a simple unit:

Create a Object widget (PreparedContainer defaults to True when Object[Container] or one of their subtypes is given as a valid object to select):

Create a Object widget (PreparedSample defaults to True when Object[Sample] or one of their subtypes is given as a valid object to select):

Create a Primitive widget (the Widget function recursively will evaluate if there are nested Widgets) -- using the old PrimitiveKeyValuePairs way:

Create a Quantity widget with alternative units and an alternatives pattern:

Create a String widget:

Using the Alternatives shorthand to make a Quantity widget will group units appropriately:

Messages (62)

ColorInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Color Widget:

ColorPatternValue (1)

The value for the key Pattern must match Verbatim[ColorP] for the Color widget:

DateInequalityPatternValue (1)

Returns $Failed if the inequality pattern is misspecified:

DateInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Date Widget:

DateMissingTimeSelectorKey (1)

The key TimeSelector must be specified to create a Date widget:

DatePatternValue (1)

The value for the key Pattern must match Verbatim[_?DateObjectQ] for the Date widget:

DateTimeSelectorValue (1)

The value for the key TimeSelector must match BooleanP for the Date widget:

EnumerationInvalidKeys (1)

Returns $Failed if keys are given to Widget[...] that do not match the enumeration widget type:

EnumerationItemsValue (1)

The value for the key Value must be consistent with the given Pattern. The Pattern must match Alternatives@@Items:

EnumerationPatternValue (1)

The value for the key Pattern must match _Alternatives for the Enumeration widget:

ExpressionInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Expression Widget:

ExpressionMissingSizeKey (1)

The key Size must be specified to create a Expression widget:

ExpressionSizeValue (1)

The value for the key Size must match Word|Line|Paragraph for the MultiSelect widget:

FieldReferenceFieldsValue (1)

The value for the key Fields must match {FieldP[OutputShort]..} for the Field Reference widget:

FieldReferenceInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Field Reference Widget:

FieldReferenceObjectTypesValue (1)

The value for the key ObjectTypes must match {TypeP[]..} for the Field Reference widget:

FieldReferencePatternValue (1)

The value for the key Pattern must match _FieldReferenceP for the Field Reference widget:

InvalidIncrementValue (1)

Returns $Failed if the Increment value is misspecified:

InvalidMaxValue (1)

Returns $Failed if the Max value is misspecified:

InvalidMinValue (1)

Returns $Failed if the Min value is misspecified:

InvalidPatternTooltipValue (1)

Returns $Failed if a Widget cannot be created from the provided inputs (the value for PatternTooltip must match _String):

InvalidType (1)

Returns $Failed if a Widget cannot be created from the provided inputs (Type must match WidgetTypeP):

MissingPatternKey (1)

Returns $Failed if a Widget cannot be created from the provided inputs (the Pattern key must be provided):

MissingTypeKey (1)

Returns $Failed if a Widget cannot be created from the provided inputs (the Type key must be provided):

MoleculeInvalidKeys (1)

Returns $Failed if there is a key that does not belong to a Molecule Widget:

MoleculePatternValue (1)

Returns $Failed if there is a pattern that does not belong to a Molecule Widget:

MultiSelectInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the MultiSelect Widget:

MultiSelectItemsValue (1)

The value for the key Items must be consistent with the given Pattern. The Pattern should match ListableP[Alternatives@@Items]:

MultiSelectPatternValue (1)

The value for the key Pattern must match ListableP[_Alternatives] for the MultiSelect widget:

NoKeyExists (1)

When trying to de-reference a key that does not exist in the Widget, $Failed is returned:

NumberIncrementValue (1)

The value for the key Increment must match the given pattern for the Number widget:

NumberInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Number Widget:

NumberMaxValue (1)

The value for the key Max must matchthe given pattern for the Number widget:

NumberMinValue (1)

The value for the key Min must match the given pattern for the Number widget:

NumberPatternValue (1)

The value for the key Pattern must match InequalityP|Span[InequalityP,InequaltiyP] for the Number widget:

ObjectInvalidDereferencePattern (1)

Returns $Failed if the Dereference field does not match its basic pattern:

ObjectInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Object Widget:

ObjectObjectBuildersValue (1)

The value for the key ObjectBuilders must match {_Symbol...} for the Object widget:

ObjectObjectTypesValue (1)

The value for the key ObjectTypes must match {TypeP[]..} for the Object widget:

ObjectOpenPathRoot (1)

Each OpenPath must begin with Object[Catalog,"Root"]:

ObjectOpenPathsContents (1)

The OpenPath must be valid. Every child Object[Catalog] must be a member of its parent Object[Catalog]'s Contents field:

ObjectOpenPathsValue (1)

The value for the key OpenPaths must match {{ObjectP[Object[Catalog]]..}...} for the Object widget:

ObjectPatternValue (1)

The value for the key Pattern must match _ObjectP for the Object widget:

PatternSetDelayed (1)

Returns $Failed if a Widget cannot be created from the provided inputs (Pattern must be provided as SetDelayed):

PrimitiveInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Primitive Widget:

PrimitiveMissingPrimitiveKeyValuePairsKey (1)

The key PrimitiveKeyValuePairs must be specified to create a Primitive widget:

PrimitivePrimitiveKeyValuePairsValue (1)

The value for the key PrimitiveKeyValuePairs must match {(_Symbol{(_SymbolWidgetP)..})..} for the Primitive widget:

PrimitivePrimitiveTypesValue (1)

The value for the key PrimitiveTypes must match {_Symbol..} for the Primitive widget:

QuantityIncrementValue (1)

The value for the key Increment must match _?QuantityQ|Null for the Quantity widget:

QuantityInvalidKeys (1)

Returns $Failed if there are keys that do not belong to the Quantity Widget:

QuantityMaxValue (1)

The value for the key Max must match _?QuantityQ|Null for the Quantity widget:

QuantityMinValue (1)

The value for the key Min must match _?QuantityQ|Null for the Quantity widget:

QuantityMissingUnitsKey (1)

The key Units must be specified to create a Quantity widget:

QuantityPatternUnitMismatch (1)

Returns $Failed if part of the units in the Units key have been left out of the Pattern. In the following example, the developer has let the user specify a quantity with units Mole or Gram but the pattern only matches on Mole: