BinElementInfo Class

From RemObjects Wiki
Jump to: navigation, search

This is a Library topic for Data Abstract for .NET
This page is generated from external data, please do not update

NamespacesInterfacesClassesEnumsImplements

Contents

Overview

The BinElementInfo class, derived from the StreamElementInfo class, is streamed in Bin2StreamReader\Bin2StreamWriter format. It helps to process stream content into a list of structure units described with a name, a type (either delta or table) and an offset in the stream where the object placed. It allows to review the stream structure without reading its full content.

The BinElementInfo class is used by the BinDataStreamer.


Location


Properties

ElementType     (declared in StreamElementInfo)

Represents the current element type. Can be either Dataset or Delta.



Prism:   property ElementType: StreamElementType read write
C#:   StreamElementType ElementType { get; set; }
VB:   Property ElementType As StreamElementType


Fields     (declared in StreamElementInfo)

Gets the SchemaField collection associated with the current StreamElementInfo object.



Prism:   property Fields: SchemaFieldCollection read
C#:   SchemaFieldCollection Fields { get; }
VB:   Property ReadOnly Fields As SchemaFieldCollection


Key     (declared in StreamElementInfo)

Gets the lower-cased Name value prefixed with t# if the ElementType equals Dataset or d# if the ElementType equals Delta.

This value is used to uniquely identify an object in the DataStreamer's data stream.



Prism:   property Key: String read
C#:   String Key { get; }
VB:   Property ReadOnly Key As String


Offset

Gets or sets an offset of the full data of the streamed object within a stream.



Prism:   property Offset: Int64 read write
C#:   Int64 Offset { get; set; }
VB:   Property Offset As Int64


Instance Methods

constructor (Object, INameChangeNotification)

Calls the base constructor that reads the next element with help of the Read(aSource: Object) method.


Oxygene:   constructor(aSource: Object; aNameChangeNotification: INameChangeNotification)
C#:   constructor(Object aSource, INameChangeNotification aNameChangeNotification)
VB:   Sub New (aSource As Object, aNameChangeNotification As INameChangeNotification)


Parameters:

  • aSource:
  • aNameChangeNotification:


constructor (String, StreamElementType, INameChangeNotification)   protected     (declared in StreamElementInfo)

Creates a new instance of the StreamElementInfo class and sets the ElementType property.


Oxygene:   constructor(name: String; elementType: StreamElementType; notification: INameChangeNotification)
C#:   constructor(String name, StreamElementType elementType, INameChangeNotification notification)
VB:   Sub New (name As String, elementType As StreamElementType, notification As INameChangeNotification)


Parameters:

  • name:
  • elementType:
  • notification:


constructor (String, StreamElementType, Int64, INameChangeNotification)

Creates a class instance with a specified name and type and sets its offset.


Oxygene:   constructor(aName: String; anElementType: StreamElementType; anOffset: Int64; aNameChangeNotification: INameChangeNotification)
C#:   constructor(String aName, StreamElementType anElementType, Int64 anOffset, INameChangeNotification aNameChangeNotification)
VB:   Sub New (aName As String, anElementType As StreamElementType, anOffset As Int64, aNameChangeNotification As INameChangeNotification)


Parameters:

  • aName: String name of the element
  • anElementType: Element type
  • anOffset: Offset of the streamed object within the stream
  • aNameChangeNotification: Instance of INameChangeNotification, default nil


Read

Reads the next BinElementInfo item from the DelphiStreamReader and sets its ElementType,Name and Offset'.


Oxygene:   method Read(source: Object)
C#:   void Read(Object source)
VB:   Sub Read(source As Object)


Parameters:

  • source:


ReadAndApplySchema   protected

Reads an element from the DelphiStreamReader and applies a read schema to the destination DataTable. Raises an exception (DAException) if the schema for the specified table cannot be found. Restores the DelphiStreamReader position after reading.

Disabled in SilverLight applications.


Oxygene:   method ReadAndApplySchema(source: Object; element: BinElementInfo; destination: DataTable)
C#:   void ReadAndApplySchema(Object source, BinElementInfo element, DataTable destination)
VB:   Sub ReadAndApplySchema(source As Object, element As BinElementInfo, destination As DataTable)


Parameters:

  • source:
  • element:
  • destination:


Write

Writes the element to the specified DelphiStreamWriter.


Oxygene:   method Write(source: Object)
C#:   void Write(Object source)
VB:   Sub Write(source As Object)


Parameters:

  • source:


See Also


Product: RemObjects Data Abstract
Available Editions: Data Abstract for .NET, Delphi and Xcode

GlossaryArticlesFeaturesLibrarySamples

Personal tools
Namespaces

Variants
Actions
Navigation
products
platforms
special
Toolbox