SetStringValue(DicomElement,string) Method

Summary

Sets the string value(s) of a Data Element.

Syntax

C++/CLI

Java

public bool SetStringValue( 
   DicomElement element, 
   string value 
)

public boolean setStringValue(DicomElement element, String value)

public: 
bool SetStringValue(  
   DicomElement^ element, 
   String^ value 
)

Parameters

element
An item in the Data Set.

value
Character string that contains the string value to set.

Return Value

true if the string value(s) were set successfully. false if could not set the string value(s) of the Data Element.

Remarks

This overload of SetStringValue differs from other versions (SetStringValue) in that it is missing the last argument (DicomCharacterSetType). This overload is affected by the value(s) in the Specific Character Set (0008,0005) Attribute.

The following DICOM Value Representations are affected by Attribute Specific Character Set (0008,0005)

SH (Short String)
LO (Long String)
ST (Short Text)
LT (Long Text)
UT (Unlimited Text)
PN (Person Name)

If element is one of these Value Representations and the string cannot be represented using the standard character set (ASCII characters), then this overload attempts to encode the string using one or character sets stored in the Specific Character Set Attribute (0008,0005). Before calling this method with unicode strings, make sure that the Specific Character Set Attribute of the DicomDataSet contains values for any character set that is necessary. For example, when encoding a japanese string the following are some of the possible values for specific character:

"ISO_IR 192" (Unicode in UTF-8)
"ISO_IR 13" (Japanese, single-byte, no code extensions)
"\ISO 2022 IR 87" (Default, JIS X 0208)
"ISO 2022 IR 13\ISO 2022 IR 87" (JIS X 0201, JIS X 0208)

For more information, see Part 3 section 'C.12.1.1.2 Specific Character Set' of the DICOM Specification. This method can be called only if the Value Representation of the Data Element is:

For more information about Value Representations, refer to Default Value Representation Table.

Example

using Leadtools; 
using Leadtools.Dicom; 
 
 
/// 
private void DicomSetStringValueTest() 
{ 
   DicomEngine.Startup(); 
 
   DicomDataSet ds = new DicomDataSet(); 
   string japaneseText1 = "亜美"; 
   string japaneseText2 = "千香子"; 
   string[] japaneseStrings = { japaneseText1, japaneseText2 }; 
   DicomElement element; 
 
   // Example 1 - uses Specific Character Set Attribute (0008,0005) to set one string 
   ds.Reset(); 
   element = ds.InsertElement(null, false, DicomTag.PatientName, DicomVRType.PN, false, 0); 
   ds.InsertElementAndSetValue(DicomTag.SpecificCharacterSet, "ISO_IR 192");     // Unicode in UTF-8 
   ds.SetStringValue(element, japaneseText1); 
   string result = ds.GetStringValue(element, 0); 
   Debug.Assert(result == japaneseText1); 
 
   // Example 2 - uses Specific Character Set Attribute (0008,0005) to set two strings 
   ds.Reset(); 
   element = ds.InsertElement(null, false, DicomTag.OtherPatientNames, DicomVRType.PN, false, 0); 
   ds.InsertElementAndSetValue(DicomTag.SpecificCharacterSet, "ISO_IR 192");     // Unicode in UTF-8 
   ds.SetStringValue(element, japaneseStrings); 
   Debug.Assert(ds.GetStringValue(element, 0) == japaneseStrings[0]); 
   Debug.Assert(ds.GetStringValue(element, 1) == japaneseStrings[1]); 
 
   // Example 3 - pass in a DicomCharacterSet and set one string 
   ds.Reset(); 
   element = ds.InsertElement(null, false, DicomTag.PatientName, DicomVRType.PN, false, 0); 
   ds.SetStringValue(element, japaneseText1, DicomCharacterSetType.UnicodeInUtf8); 
   result = ds.GetStringValue(element, 0); 
   Debug.Assert(result == japaneseText1); 
 
   // Example 4 -- pass in a DicomCharacterSet and set two strings 
   ds.Reset(); 
   element = ds.InsertElement(null, false, DicomTag.OtherPatientNames, DicomVRType.PN, false, 0); 
   ds.SetStringValue(element, japaneseStrings, DicomCharacterSetType.UnicodeInUtf8); 
   Debug.Assert(ds.GetStringValue(element, 0) == japaneseStrings[0]); 
   Debug.Assert(ds.GetStringValue(element, 1) == japaneseStrings[1]); 
 
   // Example 5 -- uses Specific Character Set Attribute (0008,0005) to set one string using IntPtr 
   ds.Reset(); 
   GCHandle pinnedArray = GCHandle.Alloc(japaneseText1, GCHandleType.Pinned); 
   IntPtr pointer = pinnedArray.AddrOfPinnedObject(); 
   element = ds.InsertElement(null, false, DicomTag.PatientName, DicomVRType.PN, false, 0); 
   ds.InsertElementAndSetValue(DicomTag.SpecificCharacterSet, "ISO_IR 192");     // Unicode in UTF-8 
   ds.SetStringValuePtr(element, pointer, 1); 
   result = ds.GetStringValue(element, 0); 
   Debug.Assert(result == japaneseText1); 
   pinnedArray.Free(); 
 
   DicomEngine.Shutdown(); 
}