IPTCGetValueString Method (GdViewer)

In This Topic

Returns a string representation of the current tag value of the required IPTC tag, that is embedded within the document displayed in the GdViewer control.

Syntax

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

'Declaration
 
Public Function IPTCGetValueString( _
   ByVal TagNo As Integer _
) As String

public string IPTCGetValueString( 
   int TagNo
)

public function IPTCGetValueString( 
    TagNo: Integer
): String;

public function IPTCGetValueString( 
   TagNo : int
) : String;

public: string* IPTCGetValueString( 
   int TagNo
)

public:
String^ IPTCGetValueString( 
   int TagNo
)

Parameters

TagNo: The sequence index of the required IPTC tag within the displayed document. It must be a value from 1 to IPTCCount.

Return Value

The current IPTC tag value as a string. The GetStat method can be subsequently used to determine if this method has been successful.

Remarks

It is recommend to use the GetStat method to identify the specific reason for the method's failure, if any.

Be aware that this method only handles IPTC tags.

Example

How to find out the IPTC tag's value.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated
'and your document has been properly displayed as well.
Dim count As Integer = GdViewer1.IPTCCount()
If GdViewer1.GetStat() = GdPictureStatus.OK Then
    Dim message As String = "IPTC Tags count: " + count + vbCrLf
    Dim tagID As IPTCTags = IPTCTags.IPTCTagUnknown
    Dim tagValue As String = ""
    For i As Integer = 1 To count
        tagID = GdViewer1.IPTCGetID(i)
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            tagValue = GdViewer1.TagGetValueString(i)
        End If
        If GdViewer1.GetStat() = GdPictureStatus.OK Then
            message = message + vbCrLf + tagID + ": " + tagValue
        Else
            message = message + vbCrLf + "Tag nr." + i + "  Status: " + GdViewer1.GetStat().ToString()
        End If
    Next
    MessageBox.Show(message, "GdViewer.IPTCGetValueString")
Else
    MessageBox.Show("The number of IPTC tags can't be found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.IPTCGetValueString")
End If

//We assume that the GdViewer1 control has been properly integrated
//and your document has been properly displayed as well.
int count = GdViewer1.IPTCCount();
if (GdViewer1.GetStat() == GdPictureStatus.OK)
{
    string message = "IPTC Tags count: " + count + "\n";
    IPTCTags tagID = IPTCTags.IPTCTagUnknown;
    string tagValue = "";
    for (int i = 1; i <= count; i++)
    {
        tagID = GdViewer1.IPTCGetID(i);
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            tagValue = GdViewer1.TagGetValueString(i);
        if (GdViewer1.GetStat() == GdPictureStatus.OK)
            message = message + "\n" + tagID + ": " + tagValue;
        else
            message = message + "\nTag nr." + i + "  Status: " + GdViewer1.GetStat().ToString();
    }
    MessageBox.Show(message, "GdViewer.IPTCGetValueString");
}
else
    MessageBox.Show("The number of IPTC tags can't be found. Status: " + GdViewer1.GetStat().ToString(), "GdViewer.IPTCGetValueString");

Reference

GdViewer Class
GdViewer Members
IPTCCount Method
IPTCGetID Method
TagCount Method