DicomObjects.NET.8.48 Documentation
DicomObjects Namespace / DicomImage Class / Frame Property






In This Topic
    Frame Property (DicomImage)
    In This Topic
    Controls which frame of a multi-frame image is displayed
    Syntax
    'Declaration
     
    
    Public Property Frame As System.Integer
    'Usage
     
    
    Dim instance As DicomImage
    Dim value As System.Integer
     
    instance.Frame = value
     
    value = instance.Frame
    public System.int Frame {get; set;}
    public read-write property Frame: System.Integer; 
    public function get,set Frame : System.int
    public: __property System.int get_Frame();
    public: __property void set_Frame( 
       System.int value
    );
    public:
    property System.int Frame {
       System.int get();
       void set (    System.int value);
    }

    Property Value

    The number of the frame to display
    Remarks

    Unlike other indices in DicomObjects, this is 1-based, as that is the DICOM convention - 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.

    Requirements

    Target Platforms: .NET CLR 4.8 or higher

    See Also