Class BinaryLargeObject

Represents a value of datatype Spotfire.Dxp.Data.DataType.Binary. The inner representation of the data is not accessible directly, instead a Spotfire.Dxp.Data.BinaryLargeObject is created from a byte stream and the data is retrieved through a byte stream.

Since

2.0

Hierarchy (view full)

Methods

Cast GetHashCode ToString TryCast Equals

Default capability

CompareTo Dispose Equals GetByteStream Create

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

CompareTo

  • CompareTo(other): number

  • Compares the bytes in this binary object with the other binary object.

    Parameters

    Returns number

    Returns 0 if the binary object are equal.

    Since

    2.0

Dispose

  • Dispose(): void

  • Disposes this object and frees any resources held by it.

    Returns void

    Since

    2.0

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

  • Equals(other): boolean

  • Compares the bytes in this binary large object with the other binary large object.

    Parameters

    Returns boolean

    Returns true if the bytes in the objects are equal; otherwise false.

    Since

    2.0

GetByteStream

  • GetByteStream(): Stream

  • Returns a stream from where the byte representation of the object can be retrieved.

    Returns Stream

    A new stream.

    Since

    2.0

StaticCreate

  • Create(stream): BinaryLargeObject

  • Creates a BinaryLargeObject by reading data from a stream. Starts reading binary data from the current position of the stream and stops at the end of the stream. When done, the position in the stream is at the end of the stream.

    Parameters

    • stream: Stream

      The input stream.

    Returns BinaryLargeObject

    The newly created BinaryLargeObject.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability