CreateOverlayBox Method

public void CreateOverlayBox( 
   DicomDataSet overlay,
   DicomOverlayBoxParameters parameters
)

'Declaration
 
Public Sub CreateOverlayBox( _
   ByVal overlay As DicomDataSet, _
   ByVal parameters As DicomOverlayBoxParameters _
) 

'Usage
 
Dim instance As DicomPrintScu
Dim overlay As DicomDataSet
Dim parameters As DicomOverlayBoxParameters
 
instance.CreateOverlayBox(overlay, parameters)

public void CreateOverlayBox( 
   DicomDataSet overlay,
   DicomOverlayBoxParameters parameters
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.CreateOverlayBox( 
   overlay ,
   parameters 
)

public:
void CreateOverlayBox( 
   DicomDataSet^ overlay,
   DicomOverlayBoxParameters^ parameters
) 

Parameters

overlay

A DicomDataSet object that contains the Overlay data for the Image Overlay Box to be created. The object is assumed to contain the Overlay Pixel Data Sequence (2040,0020). If this parameter is set to a null reference (Nothing in Visual Basic) or if the Sequence is not present, the method will fail.

parameters

A DicomOverlayBoxParameters object that specifies the parameters of the Image Overlay Box to be created. The method will fail if this is set to a null reference (Nothing in Visual Basic).

The method will not return until it receives the response of the Print SCP, or an error occurs. The method GetLastOperationStatus can be used to obtain the status code specified in the response of the Print SCP. If the method CreateOverlayBox is successful, the Image Overlay Box was created successfully, with either a Success or Warning status code in the response of the Print SCP.

The method can be used to create one or more Image Overlay Boxes. Having an Image Overlay Box created, the method GetOverlayBoxInstanceUid can be used to obtain its SOP Instance UID, which in turn can be used to reference the Image Overlay Box from Image Boxes. Refer to the method UpdateImageBox.

The methods UpdateOverlayBox and DeleteOverlayBox can be used to update and delete Image Overlay Boxes, respectively.

The parameter parameters specifies the parameters to be used when creating the Image Overlay Box. The properties DicomOverlayBoxParameters.OverlayOriginRow and DicomOverlayBoxParameters.OverlayOriginColumn in the passed object will always be used to specify the Overlay Origin (6000,0050); these can be negative. If a string property, in the passed object, is a null reference (Nothing in Visual Basic), then the corresponding Attribute will not be included in the request to the Print SCP. Also, if the property DicomOverlayBoxParameters.MagnifyToNumberOfColumns is negative, the corresponding Attribute will not be included in the request.

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

DicomPrintScu Class
DicomPrintScu Members
GetOverlayBoxInstanceUid Method
UpdateOverlayBox Method
DeleteOverlayBox Method
GetDefaultOverlayBoxParameters Method
GetLastOperationStatus Method
UpdateImageBox Method