Click or drag to resize

XmlStreamDeserializationInfo Class

Deserializes objects from an XML stream.
Inheritance Hierarchy
SystemObject
  Altaxo.Serialization.XmlXmlStreamDeserializationInfo

Namespace: Altaxo.Serialization.Xml
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
Syntax
C#
public class XmlStreamDeserializationInfo : IXmlDeserializationInfo, 
	IDisposable

The XmlStreamDeserializationInfo type exposes the following members.

Constructors
 NameDescription
Public methodXmlStreamDeserializationInfo Initializes a new instance of the XmlStreamDeserializationInfo class.
Top
Properties
 NameDescription
Public propertyCurrentElementNameReturns the name of the current XML element.
Public propertyPropertyDictionary Gets the property dictionary. This is a dictionary where some string/value pairs could be stored, and used during or after deserialization
Top
Methods
 NameDescription
Public methodAnnounceDeserializationEnd Announces that deserialization of the document hierarchy has reached the current stage.
Public methodAnnounceDeserializationHasCompletelyFinished Announces that deserialization has completely finished.
Public methodBeginReading(Stream) Begins reading from the specified stream.
Public methodBeginReading(String) Begins reading from the specified XML text.
Public methodBeginReading(XmlReader) Begins reading from the specified XML reader.
Public methodCloseArrayCloses the current array scope.
Public methodCloseElementCloses the current element.
Public methodDisposePerforms application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
Public methodEndReading Ends reading and detaches the current XML reader.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
Public methodGetArray(Single)Deserializes an array of Single values from the current node.
Public methodGetArray(DateTime, Int32)Deserializes an array of DateTime values.
Public methodGetArray(Double, Int32) Deserializes an array of double value. The xml node must be opened before with OpenArray
Public methodGetArray(Int32, Int32) Deserializes an array of integer values from the current XML element.
Public methodGetArray(String, Double) Deserializes an array of double values. The array is allocated automatically.
Public methodGetArray(String, Int32)Deserializes an array of Int32 values.
Public methodGetArray(String, Int32)Deserializes an array of nullable strings.
Public methodGetArray(BitArray, BitArray, Int32) Gets an array of nullable booleans.
Public methodGetArrayOfPrimitiveTypeBase64 Reads an array of primitive values encoded as Base64 into the provided destination array.
Public methodGetArrayOfPrimitiveTypeBinHex Reads an array of primitive values encoded as BinHex into the provided destination array.
Public methodGetArrayOfStringsReads an array of strings from a named element.
Public methodGetArrayOfValuesTReads an array of values of type T.
Public methodGetBaseValueEmbeddedReads an embedded base value for a derived instance.
Public methodGetBaseValueEmbeddedOrNullDeserializes the embedded base type.
Public methodGetBaseValueStandaloneReads a standalone base value for a derived instance.
Public methodGetBooleanReads a boolean value from the current element content.
Public methodGetBoolean(String)Reads a named boolean child element.
Public methodGetCharReads a named char child element.
Public methodGetDateTimeReads a named DateTime child element.
Public methodGetDoubleReads a Double from the current element content.
Public methodGetDouble(String)Reads a named Double child element.
Public methodGetElementAsOuterXmlGets the outer XML of a named element.
Public methodGetEnum(String, Type)Reads a named enum value of the given type.
Public methodGetEnumT(String)Reads a named enum value of type T.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetInt32Reads an Int32 from the current element content.
Public methodGetInt32(String)Reads a named Int32 child element.
Public methodGetInt32AttributeReads an Int32 attribute of the current element.
Public methodGetInt64Reads a named Int64 child element.
Public methodGetMemoryStreamReads a named MemoryStream child element.
Public methodGetNodeContentGets the inner text content of the current node.
Public methodGetNodeNameRetrieves the name of the current node.
Public methodGetNullableBooleanReads a named nullable boolean child element.
Public methodGetNullableDoubleReads a named nullable Double child element.
Public methodGetNullableEnumTReads a named nullable enum value of type T.
Public methodGetNullableInt32Reads a named nullable Int32 child element.
Public methodGetNullableStructTReads a nullable struct value.
Public methodGetPropertyOrDefaultT Gets a property value from the property dictionary identified by the provided key string. If the property does not exist in the dictionary, the default value is returned.
Public methodGetSingleReads a Single from the current element content.
Public methodGetSingle(String)Reads a named Single child element.
Public methodGetStringReads a string from the current element content.
Public methodGetString(String)Reads a named string child element.
Public methodGetStringAttributeReads a string attribute of the current element.
Public methodGetStringAttributeOrNullReads a string attribute or returns null if missing.
Public methodGetTimeSpanReads a named TimeSpan child element.
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodGetValue(String, Object)Reads a value of unknown type.
Public methodGetValueT(String, Object)Reads a value of type T.
Public methodGetValueOrNull(Object) Reads a value from the current element using its Type attribute and returns for undefined values.
Public methodGetValueOrNull(String, Object)Reads a value of unknown type or returns null.
Public methodGetValueOrNullT(String, Object)Reads a value of type T or returns null.
Public methodGetValueOrOuterXml Intended for lazy loading. Tries to get the deserialized value. If the type is unknown (this can happen if (especially for addin DLLs) a DLL is not loaded yet), the outer XML node is returned as string value, so it can be deserialized later.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Public methodOpenArrayOpens the current array and returns its element count.
Public methodOpenArray(String)Opens a named array element and returns its element count.
Public methodOpenElementOpens the current element.
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Events
 NameDescription
Public eventAfterDeserializationHasCompletelyFinished Occurs after (!) the deserialization process has completely finished, and the dirty flag of the document was cleared. This callback is intended to activate the data sources of the document, which should be suspended during the deserialization process.
Public eventDeserializationFinished This event is called if the deserialization process of all objects is finished and the deserialized objects are sorted into the document. Then the application should call AllFinished, which fires this event. The purpose of this event is to resolve the references in the deserialized objects. This resolving process can be successfully done only if the objects are put in the right places in the document, so that the document paths can be resolved to the right objects.
Public eventStatic memberInstanceCreated Occurs when a new instance of this class is created. Argument is the created instance. This event is hold weak, thus you can safely add your handler without running in memory leaks.
Top
See Also