skipObject Property

Summary

Gets or sets a value that indicate whether to skip loading or saving an annotation object.

Syntax
TypeScript
JavaScript
Object.defineProperty(AnnSerializeObjectEventArgs.prototype, 'skipObject', 
	get: function(), 
	set: function(value) 
) 
skipObject: boolean; 

Property Value

true to skip loading or saving an annotation object; otherwise, false. The default value is false.

Remarks

If this object is triggered with the AnnDeserializeOptions.DeserializeObject event, then you can 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.

If this object is trigged with the AnnDeserializeOptions.DeserializeObjectError event, then you can set the value of this property to true to instruct AnnCodecs to ignore the error, skip loading this object and continue to the next.

If this object is trigged with the AnnSerializeOptions.SerializeObject event, then you can set the value of this property to true to skip loading the object in AnnObject with type in TypeName and continue to the next.

Example

For an example, refer to AnnSerializeOptions and AnnDeserializeOptions.

Requirements

Target Platforms

Help Version 20.0.2020.3.31
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly