DsPdfJS API - v9.1.0
    Preparing search index...

    Class EmbeddedFileStream

    Represents embedded file stream in PDF.

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Accessors

    checkSum creationDate id mimeType modificationDate om size

    Methods

    free getStream rebind

    Constructors

    Accessors

    • get checkSum(): Uint8Array<ArrayBufferLike> | null

      Gets or sets a 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream. Checksum calculated automatically when EmbeddedFileStream is created.

      Returns Uint8Array<ArrayBufferLike> | null

    • set checkSum(value: Uint8Array<ArrayBufferLike> | null): void

      Gets or sets a 16-byte string that is the checksum of the bytes of the uncompressed embedded file. The checksum is calculated by applying the standard MD5 message-digest algorithm to the bytes of the embedded file stream. Checksum calculated automatically when EmbeddedFileStream is created.

      Parameters

      • value: Uint8Array<ArrayBufferLike> | null

      Returns void

    • get creationDate(): PdfDateTime | null

      Gets or sets the date and time when the embedded file was created.

      Returns PdfDateTime | null

    • set creationDate(value: PdfDateTime | null): void

      Gets or sets the date and time when the embedded file was created.

      Parameters

      Returns void

    • get id(): number

      Gets the reference to the object.

      Returns number

    • get mimeType(): string | null

      Gets or sets the file's MIME type.

      Returns string | null

    • set mimeType(value: string | null): void

      Gets or sets the file's MIME type.

      Parameters

      • value: string | null

      Returns void

    • get modificationDate(): PdfDateTime | null

      Gets or sets the date and time when the embedded file was last modified.

      Returns PdfDateTime | null

    • set modificationDate(value: PdfDateTime | null): void

      Gets or sets the date and time when the embedded file was last modified.

      Parameters

      Returns void

    • get size(): number | null

      Gets or sets the size of the embedded file, in bytes.

      Returns number | null

    • set size(value: number | null): void

      Gets or sets the size of the embedded file, in bytes.

      Parameters

      • value: number | null

      Returns void

    Methods

    • Detaches the object from the ObjectManager and deallocates its memory, if possible.

      Returns void

    • Gets the Uint8Array containing content of this EmbeddedFileStream, stream should be disposed after usage. NOTE! Method can return null if this EmbeddedFileStream is empty.

      Returns Uint8Array<ArrayBufferLike> | null

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods