HandleSerializationEventArgs

Show Usages

The event arguments used by handle-serialization to let registered serialization code perform the serialization of items.

Inheritance Hierarchy

Remarks

If the event handler determines that it can serialize the item, it should use the writer for output and mark the event as handled so that other code will not perform serialization, too.

Members

No filters for this type

Constructors

HandleSerializationEventArgs

(

context: IWriteContext

item: any

serializationType?: Constructor

)

Initializes a new instance of the HandleSerializationEventArgs class using the provided context to write the item using the given type for serialization.

Parameters

context: IWriteContext: The context to use for writing.
item: any: The item to serialize.
serializationType?: Constructor: The type that should be used for serialization, which needs to be a super type or interface of the item. If omitted, the type is inferred from the item.

Properties

context

: IWriteContext

readonly

Gets the context to be used for writing.

readonlyfinal

Property Value

The context.

handled

: boolean

Gets or sets a value indicating whether this HandleSerializationEventArgs is handled.

Setting this property to true indicates to the event source that the item has been successfully serialized using the writer and no other code needs to handle the serialization request anymore.

final

Property Value

true if this event has been handled; false otherwise.

item

: any

readonly

Gets the item that should be serialized.

readonlyfinal

Property Value

The item.

sourceType

: Constructor

readonly

Gets the type in the inheritance of the item that should be used for serialization.

readonlyfinal

Property Value

The type of the serialization or null if the type should be inferred from the item.

writer

: IXmlWriter

readonly

Gets the writer for writing the XML output.

readonlyfinal

Property Value

The writer that writes the GraphML XML.

Methods

replaceItem

(item: any, serializationType: Constructor)

Replaces the item using a substitute for serialization.

This method can be used to replace the item and sourceType property so that the serialization chain can be traversed with a substituted item. If this method has been called, the handled property should not be set to true.

final

Parameters

item: any: The substitute to assign to the item property.
serializationType: Constructor: The serialization type to assign to the sourceType property.