Leadtools.Dicom	Requires Medical product license \| Send comments on this topic. \| Back to Introduction - All Topics \| Help Version 16.5.9.25
GetAnnotationBoxInstanceUid Method
See Also

Leadtools.Dicom Namespace > DicomPrintScu Class : GetAnnotationBoxInstanceUid Method

Visual Basic (Declaration)
Visual Basic (Usage)
C#
C++/CLI

index: The index of the Annotation Box whose SOP Instance UID is to be retrieved. This should be a number from 0 to the count of Annotation Boxes minus 1. The method GetAnnotationBoxesCount returns the count of Annotation Boxes.

index: The index of the Annotation Box whose SOP Instance UID is to be retrieved. This should be a number from 0 to the count of Annotation Boxes minus 1. The method GetAnnotationBoxesCount returns the count of Annotation Boxes.

Returns the SOP Instance UID of the specified Basic Annotation Box SOP Instance.

Syntax

Visual Basic (Declaration)
Public Function GetAnnotationBoxInstanceUid( _ ByVal index As Integer _ ) As String

Visual Basic (Usage)	Copy Code
`Dim instance As DicomPrintScu Dim index As Integer Dim value As String value = instance.GetAnnotationBoxInstanceUid(index)`

C#
public string GetAnnotationBoxInstanceUid( int index )

C++/CLI
public: String^ GetAnnotationBoxInstanceUid( int index )

Parameters

index: The index of the Annotation Box whose SOP Instance UID is to be retrieved. This should be a number from 0 to the count of Annotation Boxes minus 1. The method GetAnnotationBoxesCount returns the count of Annotation Boxes.

Return Value

The SOP Instance UID of the specified Annotation Box. If an invalid index is passed, the method will return a null reference (Nothing in Visual Basic).

Example

For an example, refer to DicomPrintScu.Associate(String,Int32,String,String,DicomPrintScuPrintManagementClassFlags).

Remarks

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 returns the SOP Instance UID of a particular Annotation Box.

Requirements

Target Platforms: Microsoft .NET Framework 3.0, Windows XP, Windows Server 2003 family, Windows Server 2008 family