AddIn.PersistenceManagerRegistrar.AddFieldRename Method

AddIn PersistenceManagerRegistrar AddFieldRename Method

TIBCO Spotfire 6.0 API Reference

Adds a binding for the field with the specified originalFieldName in a class of the specified originalAssemblyName and originalTypeName of a PersistenceVersion less than the specified majorUpperVersion and minorUpperVersion. If the class or struct containing the originalFieldName is being deserialized as the specified boundType, value of the field is deserialized and bound to the specified newFieldName.

Namespace: Spotfire.Dxp.Application.Extension
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public void AddFieldRename(
	string originalAssemblyName,
	string originalTypeName,
	int majorUpperVersion,
	int minorUpperVersion,
	Type boundType,
	string originalFieldName,
	string newFieldName
)

public void AddFieldRename(
	string originalAssemblyName,
	string originalTypeName,
	int majorUpperVersion,
	int minorUpperVersion,
	Type boundType,
	string originalFieldName,
	string newFieldName
)

Parameters

originalAssemblyName: Type: System String
Name of the assembly of the serialized class.

originalTypeName: Type: System String
Name of the type of the serialized class.

majorUpperVersion: Type: System Int32
The upper exclusive bound of the major version of the serialized class.

minorUpperVersion: Type: System Int32
The upper exclusive bound of the minor version of the serialized class.

boundType: Type: System Type
The Type of the class or struct being deserialized required for the field rename to be made.

originalFieldName: Type: System String
Name of the field in the serialized class.

newFieldName: Type: System String
The name of the field as expected by the deserialization code of the specified boundType.

Remarks

Use this class to add support for backwards compatibility with respect to name changes of fields in a class or struct.