UpdateAnnotationBox Method

public void UpdateAnnotationBox( 
   string annotationBoxInstanceUid,
   int annotationPosition,
   string text
)

'Declaration
 
Public Sub UpdateAnnotationBox( _
   ByVal annotationBoxInstanceUid As String, _
   ByVal annotationPosition As Integer, _
   ByVal text As String _
) 

'Usage
 
Dim instance As DicomPrintScu
Dim annotationBoxInstanceUid As String
Dim annotationPosition As Integer
Dim text As String
 
instance.UpdateAnnotationBox(annotationBoxInstanceUid, annotationPosition, text)

public void UpdateAnnotationBox( 
   string annotationBoxInstanceUid,
   int annotationPosition,
   string text
)

ObjectiveC Syntax

 function Leadtools.Dicom.DicomPrintScu.UpdateAnnotationBox( 
   annotationBoxInstanceUid ,
   annotationPosition ,
   text 
)

public:
void UpdateAnnotationBox( 
   String^ annotationBoxInstanceUid,
   int annotationPosition,
   String^ text
) 

Parameters

annotationBoxInstanceUid

The SOP Instance UID of the Annotation Box to be updated. The method will fail if this is a null reference (Nothing in Visual Basic) or if an empty string is specified. The method GetAnnotationBoxInstanceUid returns the SOP Instance UID of a particular Annotation Box.

annotationPosition

The Value of the Attribute Annotation Position (2030,0010).

text

The Value of the Attribute Text String (2030,0020). If this is set to a null reference (Nothing in Visual Basic), the Attribute will not be included in the request to the Print SCP and hence will not be updated.

When the Print SCP is requested to create a Film Box, and if an Annotation Display Format ID is specified, the Print SCP will also create one or more Annotation Boxes, based on the Annotation Display Format ID. This will happen only if the Basic Annotation Box SOP Class is supported on the Association. This method updates a particular Annotation Box. The Annotation Box specified (by the SOP Instance UID) must belong to the current (last created) Film Box.

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 UpdateAnnotationBox is successful, the Annotation Box was updated successfully, with either a Success or Warning status code in the response of the Print SCP.

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
CreateFilmBox Method
GetAnnotationBoxesCount Method
GetAnnotationBoxInstanceUid Method
FreeAnnotationBoxesInstanceUids Method
GetLastOperationStatus Method