In This Topic ▼

annObject Property

Summary

Gets or sets the annotation object being loaded or saved.

Syntax

TypeScript

JavaScript

Object.defineProperty(AnnSerializeObjectEventArgs.prototype, 'annObject', 
	get: function(), 
	set: function(value) 
)

annObject: AnnObject;

Property Value

The annotation object being loaded or saved.

Remarks

If this object is triggered with the AnnDeserializeOptions.DeserializeObject event, then the value of this property contains null and the object type name being saved is in TypeName. You have the following course of action:

Do nothing. Leave the value of AnnObject as null. This will instruct AnnCodecs to try and create the object from TypeName. If the codecs fails to do that for any reason, the DeserializeObjectError error will occur.
Create the object manually. Set the value of AnnObject to a new instance of the object type in TypeName. The AnnCodecs will use this object instance to load the rest of the properties and add it to the container. This is useful in situations when an object cannot be created by the framework.
Set the value of SkipObject to true. This will instruct AnnCodecs to skip this object and continue to the next. This is useful if in scenarios when you do not want to load certain object types or objects with certain properties.
In any of the scenarios above, you can set the Error property to an error object to stop loading the annotation objects and cause AnnCodecs to throw the error and returns.

If this object is triggered with the AnnDeserializeOptions.DeserializeObjectError event, then the value of this property is null and means AnnCodecs could not create the instance of an object of type TypeName. If it is possible to create AnnObject yourself in this situation, then set its instance to AnnObject to allow the codecs object to continue loading its properties. Another option is to set SkipObject to true to instruct AnnCodecs to ignore the error, skip loading this object and continue to the next.

If this object is triggered with the AnnSerializeOptions.SerializeObject event, then the value of this property is null and is not used.

Example

For an example, refer to AnnSerializeOptions and AnnDeserializeOptions.

Requirements

Target Platforms