DataColumnProperties.Propagate Method (ImportContext, Boolean, IDataFormatter, DataType)

DataColumnProperties Propagate Method (ImportContext, Boolean, IDataFormatter, DataType)

TIBCO Spotfire 6.5 API Reference

Create a new collection of column properties where all the properties that are defined in the DataPropertyRegistry with the DataPropertyAttributesIsPropagated are forwarded.

Namespace: Spotfire.Dxp.Data
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 14.10.7525.5058 (14.10.7525.5058)

Syntax

C++

Copy to Clipboard Print

public DataColumnProperties Propagate(
	ImportContext importContext,
	bool propagateUnknownProperties,
	IDataFormatter suggestedFormatter,
	DataType resultType
)

public DataColumnProperties Propagate(
	ImportContext importContext,
	bool propagateUnknownProperties,
	IDataFormatter suggestedFormatter,
	DataType resultType
)

Parameters

importContext: Type: Spotfire.Dxp.Data.Import ImportContext
The import context.

propagateUnknownProperties: Type: System Boolean
A setting which defined if properties that are not defined in the DataPropertyRegistry should be propagated.

suggestedFormatter: Type: Spotfire.Dxp.Data.Formatters IDataFormatter
The suggested IDataFormatter for the resulting property collection.

resultType: Type: Spotfire.Dxp.Data DataType
The DataType that should be used for the resulting property collection.

Return Value

Type: DataColumnProperties
A new collection of properties where the propagatable properties are propagated.

Exceptions

Exception	Condition
System ArgumentNullException	importContext is null. -or- suggestedFormatter is null. -or- resultType is null.

Remarks

The suggestedFormatter is just a suggestion and heuristics are applied to determine if the suggestedFormatter or the original formatter should be used. If a specific formatter should be set then set this formatter after the propagation has been done.

Version Information

Supported in: 6.5, 6.0, 5.5, 5.0, 4.5