PersistenceVersionAttribute Class

TIBCO Spotfire 6.0 API Reference

Used to markup the persistence version of a class in order to support the writing of backwards compatible classes.

Inheritance Hierarchy

System Object
System Attribute
Spotfire.Dxp.Framework.Persistence PersistenceVersionAttribute

Namespace: Spotfire.Dxp.Framework.Persistence
Assembly: Spotfire.Dxp.Framework (in Spotfire.Dxp.Framework.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface, AllowMultiple = false, 
	Inherited = false)]
public sealed class PersistenceVersionAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets.Class|AttributeTargets.Struct|AttributeTargets.Enum|AttributeTargets.Interface, AllowMultiple = false, 
	Inherited = false)]
public sealed class PersistenceVersionAttribute : Attribute

Remarks

During deserialization of a DocumentNode, the persistence version of the serialized type can be retreived by calling GetPersistedVersion(SerializationInfo, StreamingContext, String). By inspecting this object, the deserialization code can determine what values to expect in the serialized format and thus what to deserialize.

Make sure to increment the persistence version of a class whenever the fields that it serializes change in any way. This includes addition and removal the serialized fields as well as changes of name and type.