CalculationSettingsValidateSettings Method

Spotfire 14.3 API Reference
Validates the suggested columns, filtering selections and marking selections with respect to the current Settings and Results. In particular this means checking for circular references. This method is meant to be called from a dialog before allowing the user to set up dependencies that would cause errors. If the implementer forgets to do this the framework will run the same check before trying to calculate but without any chance for the user to modify their choices.

Namespace:  Spotfire.Dxp.Application.Calculations
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax

C#
public CalculationSettingsValidationResult ValidateSettings(
	IEnumerable<DataColumn> dependentColumns,
	IEnumerable<DataFilteringSelection> dependentFilteringSelections,
	IEnumerable<DataMarkingSelection> dependentMarkingSelections
)

Parameters

dependentColumns
Type: System.Collections.GenericIEnumerableDataColumn
Suggested dependencycolumns
dependentFilteringSelections
Type: System.Collections.GenericIEnumerableDataFilteringSelection
Suggested DataFilteringSelection:s
dependentMarkingSelections
Type: System.Collections.GenericIEnumerableDataMarkingSelection
Suggested DataMarkingSelection:s

Return Value

Type: CalculationSettingsValidationResult
A CalculationSettingsValidationResult object containing any errors or warnings that was the result of the check. These can then be displayed to the user so they can modify their choices.
Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8
See Also

Reference