C

QueryReferenceIdEventArgs

Show Usages
Event arguments for the query-reference-id event.
Inheritance Hierarchy

Remarks

Event handling code should inspect the value property and decide whether to set the referenceId and/or referenceType property in order to handle the event.

See Also

API

query-reference-id

Members

No filters for this type

Constructors

QueryReferenceIdEventArgs

(context: IWriteContext, value: any)
Creates a new instance.
The handled property is set to false, the referenceId is set to null.

Parameters

context: IWriteContext
The current write context that can be used by the event handler for additional information.
value: any
The referenced object instance.

Properties

context

: IWriteContext
readonly
Gets the current write context that can be used by the event handler for additional information.
readonlyfinal

handled

: boolean
readonly
Gets whether the last event handler invocation has actually handled the event.
This property is set implicitly by referenceId.
readonlyfinal

See Also

API
referenceId

referenceId

: string
Gets or sets the reference id that should be evaluated by the event handler.
Setting this property to a non-null string automatically sets handled to true.
final

See Also

Developer's Guide
API
handled

referenceType

: GraphMLReferenceType
Gets or sets the type of the reference being queried.
Setting this property automatically sets handled to true. By default this property is EXTERNAL so values that are given a referenceId are treated as external references that are not serialized to the GraphML. Setting this property to INTERNAL and specifying a referenceId will make the reference mechanism use the provided reference but will cause it to serialize the value to the GraphML, nevertheless.
conversionfinal

See Also

API
referenceId, handled

value

: any
readonly
Gets the reference value that is encapsulated by this instance.
readonlyfinal