DocumentNodeCreateRuntimePropertyT Method

Spotfire 14.3 API Reference
Creates a RuntimePropertyT.

Namespace:  Spotfire.Dxp.Framework.DocumentModel
Assembly:  Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
protected void CreateRuntimeProperty<T>(
	PropertyName propertyName,
	out RuntimeProperty<T> field,
	StatelessDependencyDeclarer dependencyDeclarer,
	StatelessPropertyComputer<T> propertyComputer
)

Parameters

propertyName
Type: Spotfire.Dxp.Framework.DocumentModelPropertyName
The name of the property.
field
Type: Spotfire.Dxp.Framework.DocumentModelRuntimePropertyT
The field that the RuntimePropertyT will be assigned to. This shall be a readonly field.
dependencyDeclarer
Type: Spotfire.Dxp.Framework.DocumentModelStatelessDependencyDeclarer
A delegate that declares the properties that the created RuntimeProperty depends on.
propertyComputer
Type: Spotfire.Dxp.Framework.DocumentModelStatelessPropertyComputerT
A delegate that computes the value of the RuntimeProperty.

Type Parameters

T
The Type of the values held by the runtime property. This must be an immutable type.
Remarks
A runtime property is a property in the document model whose value is computed based on the values of other properties. The value of a runtime property is computed when the value is asked for. The result of the computation is kept so that it need not be recomputed if it is needed again.

The value in the runtime property is invalidated (that is cleared) when any property that the runtime node depends on is changed.

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

DocumentNode Class
Spotfire.Dxp.Framework.DocumentModel Namespace
Spotfire.Dxp.Framework.DocumentModelRuntimePropertyT