DicomObjects Reference
DicomObjects Reference / DicomImage Object / Frame Property
In This Topic
    Frame Property
    In This Topic
    Description
    Controls which frame of a multi-frame image is displayed
    Property type
    Read-write property
    Syntax
    Visual Basic
    Public Property Frame As Integer
    Remarks

    Like all indices in DicomObjects, this is 1-based - i.e. the range is from 1 to FrameCount.
    If set to a value higher than FrameCount, this property is reduced modulo FrameCount, to bring it within range.  Cine sequences may therefore be run repeatedly simply by incrementing Frame continuously. Alternatively, to allow multi-frame images to “play” autonomously, the CineMode property may be used.

    Frame only returns sensible values for images up to 32k frames – for larger images use LongFrame.

    See Also