GetEmbeddedFileDescription Method (GdPicturePDF)

In This Topic

Gets the description of an embedded file (the attachment's description) within the currently loaded PDF document. You need to specify this attachment by its 0-based index.

Syntax

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

'Declaration
 
Public Function GetEmbeddedFileDescription( _
   ByVal FileIdx As Integer _
) As String

public string GetEmbeddedFileDescription( 
   int FileIdx
)

public function GetEmbeddedFileDescription( 
    FileIdx: Integer
): String;

public function GetEmbeddedFileDescription( 
   FileIdx : int
) : String;

public: string* GetEmbeddedFileDescription( 
   int FileIdx
)

public:
String^ GetEmbeddedFileDescription( 
   int FileIdx
)

Parameters

FileIdx: The 0-based index of the embedded file. It must be a value from 0 to GdPicturePDF.GetEmbeddedFileCount-1.

Return Value

The description of the embedded file. It is the description you have specified with embedding the file.

The GdPicturePDF.GetStat method can be subsequently used to determine if this method has been successful.

Remarks

This method is only allowed for use with non-encrypted documents.

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

Example

How to find out the description of the first embedded file within the PDF document.

VB.NET
C#

Dim caption As String = "Example: GetEmbeddedFileDescription"
Dim gdpicturePDF As New GdPicturePDF()
If gdpicturePDF.LoadFromFile("TestPDFWithAttachment.pdf", False) = GdPictureStatus.OK Then
    Dim embeddedFileCount As Integer = gdpicturePDF.GetEmbeddedFileCount()
    If gdpicturePDF.GetStat() = GdPictureStatus.OK Then
        If embeddedFileCount = 0 Then
            MessageBox.Show("This PDF file does not contain embedded files.", caption)
        Else
            Dim description As String = gdpicturePDF.GetEmbeddedFileDescription(0)
            Dim status As GdPictureStatus = gdpicturePDF.GetStat()
            If status = GdPictureStatus.OK Then
                MessageBox.Show("The description of the first embedded file is: " + description, caption)
            Else
                MessageBox.Show("The GetEmbeddedFileDescription() method has failed with the status: " + status.ToString(), caption)
            End If
        End If
    End If
Else
    MessageBox.Show("The file can't be loaded.", caption)
End If
gdpicturePDF.Dispose()

string caption = "Example: GetEmbeddedFileDescription";
GdPicturePDF gdpicturePDF = new GdPicturePDF();
if (gdpicturePDF.LoadFromFile("TestPDFWithAttachment.pdf", false) == GdPictureStatus.OK)
{
    int embeddedFileCount = gdpicturePDF.GetEmbeddedFileCount();
    if (gdpicturePDF.GetStat() == GdPictureStatus.OK)
    {
        if (embeddedFileCount == 0)
        {
            MessageBox.Show("This PDF file does not contain embedded files.", caption);
        }
        else
        {
            string description = gdpicturePDF.GetEmbeddedFileDescription(0);
            GdPictureStatus status = gdpicturePDF.GetStat();
            if (status == GdPictureStatus.OK)
            {
                MessageBox.Show("The description of the first embedded file is: " + description, caption);
            }
            else
            {
                MessageBox.Show("The GetEmbeddedFileDescription() method has failed with the status: " + status.ToString(), caption);
            }
        }
    }
}
else
{
    MessageBox.Show("The file can't be loaded.", caption);
}
gdpicturePDF.Dispose();

Reference

GdPicturePDF Class
GdPicturePDF Members
GetEmbeddedFileCount Method
EmbedFile(String,String) Method
DeleteEmbeddedFile Method
LoadFromFile Method