LoadPresState Method

Visual Basic
C#
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Shared Function LoadPresState( _
   ByVal stream As Stream, _
   ByVal page As ImGearRasterPage, _
   ByVal pageDisplay As IImGearPageDisplay, _
   ByVal options As ImGearPresStateOptions _
) As ImGearMetadataHead

'Usage
 
Dim stream As Stream
Dim page As ImGearRasterPage
Dim pageDisplay As IImGearPageDisplay
Dim options As ImGearPresStateOptions
Dim value As ImGearMetadataHead
 
value = ImGearDICOM.LoadPresState(stream, page, pageDisplay, options)

public static ImGearMetadataHead LoadPresState( 
   Stream stream,
   ImGearRasterPage page,
   IImGearPageDisplay pageDisplay,
   ImGearPresStateOptions options
)

public: static ImGearMetadataHead* LoadPresState( 
   Stream* stream,
   ImGearRasterPage* page,
   IImGearPageDisplay* pageDisplay,
   ImGearPresStateOptions options
)

public:
static ImGearMetadataHead^ LoadPresState( 
   Stream^ stream,
   ImGearRasterPage^ page,
   IImGearPageDisplay^ pageDisplay,
   ImGearPresStateOptions options
)

Parameters

stream: Stream, containing presentation state object.
page: Page to apply Presentation State to.
pageDisplay: PageDisplay to apply Presentation State to.
options: Options structure, tells which settings need to be applied.

Return Value

New instance of ImageGear.Core.ImGearMetadataHead class object, containing metadata loaded from the Presentation State object.

This method loads Presentation State object from a stream and applies settings, found in this object, to the page and to the pageDisplay. Specifically:

Adjusts page's ImGearDICOMDisplaySettings class member using VOI, Modality and Presentation LUTs, found in the Presentation State DataSet.
Sets image rectangle and orientation of the pageDisplay;
Adds annotation objects to the pageDisplay.

All previous settings and annotations of the page and pageDisplay are discarded.

This method also returns all metadata found in the Presentation State object.

C#

ImGearMetadataHead presStateOrigMetadata;
using (FileStream fileContent = new FileStream(fileName, FileMode.Open))
{
    ImGearPresStateOptions opts = new ImGearPresStateOptions();
    presStateOrigMetadata =
        ImGearDICOM.LoadPresState(fileContent, (ImGearRasterPage)igPage, igPageView.Display, opts);
}

Visual Basic

Dim presStateOrigMetadata As ImGearMetadataHead
Using fileContent = New FileStream(fileName, FileMode.Open)
    Dim opts As ImGearPresStateOptions = New ImGearPresStateOptions()
    presStateOrigMetadata = ImGearDICOM.LoadPresState(fileContent, igPage, igPageView.Display, opts)
End Using

Reference

ImGearDICOM Class
ImGearDICOM Members
ImGearRasterPage Class
ImGearPresStateOptions Structure
IImGearPageDisplay Interface