AddEmbeddedImageAnnot(String,Single,Single,Single,Single) Method

In This Topic

Adds a new GdPicture/XMP embedded image annotation on the selected page of the document currently handled by this AnnotationManager object according to the parameters you have specified. This annotation embeds the specified image on the page within the defined rectangle area.

The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeEmbeddedImage. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationEmbeddedImage class right after the successful creation of the annotation object.

Be aware that annotations are always treated relative to the currently selected page.

Syntax

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

'Declaration
 
Public Overloads Function AddEmbeddedImageAnnot( _
   ByVal ImagePath As String, _
   ByVal Left As Single, _
   ByVal Top As Single, _
   ByVal Width As Single, _
   ByVal Height As Single _
) As AnnotationEmbeddedImage

public AnnotationEmbeddedImage AddEmbeddedImageAnnot( 
   string ImagePath,
   float Left,
   float Top,
   float Width,
   float Height
)

public function AddEmbeddedImageAnnot( 
    ImagePath: String;
    Left: Single;
    Top: Single;
    Width: Single;
    Height: Single
): AnnotationEmbeddedImage;

public function AddEmbeddedImageAnnot( 
   ImagePath : String,
   Left : float,
   Top : float,
   Width : float,
   Height : float
) : AnnotationEmbeddedImage;

public: AnnotationEmbeddedImage* AddEmbeddedImageAnnot( 
   string* ImagePath,
   float Left,
   float Top,
   float Width,
   float Height
)

public:
AnnotationEmbeddedImage^ AddEmbeddedImageAnnot( 
   String^ ImagePath,
   float Left,
   float Top,
   float Width,
   float Height
)

Parameters

ImagePath: The file path of the image resource to render as an annotation.
Left: The horizontal (X) coordinate of the top left point, in inches, where the annotation bounding box is to be located.
Top: The vertical (Y) coordinate of the top left point, in inches, where the annotation bounding box is to be located.
Width: The width of the annotation bounding box, in inches.
Height: The height of the annotation bounding box, in inches.

Return Value

A GdPicture/XMP AnnotationEmbeddedImage object. The newly added GdPicture/XMP embedded image annotation.

Remarks

Please ensure that you have selected the proper page before starting any annotation related action with the handled document. Annotations are always treated relative to the currently selected page.

You can regularly apply the GetStat method to determine if this method has been successful.

Example

How to add an embedded image annotation from a file on the currently selected page of the handled document.

VB.NET
C#

Using annotMgr As AnnotationManager = New AnnotationManager()
    If (annotMgr.InitFromFile("source.tiff") = GdPictureStatus.OK) AndAlso
       (annotMgr.SelectPage(1) = GdPictureStatus.OK) Then
        Dim annot As GdPicture14.Annotations.AnnotationEmbeddedImage = annotMgr.AddEmbeddedImageAnnot("annot.jpg", 0.5F, 0.5F, 2, 3)
        If (annotMgr.GetStat() = GdPictureStatus.OK) AndAlso (annot IsNot Nothing) Then
            annot.Author = "GdPicture"
            annot.Opacity = 0.8F
            If annotMgr.SaveAnnotationsToPage() = GdPictureStatus.OK Then
                annotMgr.SaveDocumentToTIFF("dest.tiff", TiffCompression.TiffCompressionAUTO)
            End If
        End If
        annot.Dispose()
    End If
    If annotMgr.GetStat() = GdPictureStatus.OK Then
        MessageBox.Show("Done!", "AnnotationManager.AddEmbeddedImageAnnot")
    Else
        MessageBox.Show("Error!   Status: " + annotMgr.GetStat().ToString(), "AnnotationManager.AddEmbeddedImageAnnot")
    End If
    annotMgr.Close()
End Using

using (AnnotationManager annotMgr = new AnnotationManager())
{
    if ((annotMgr.InitFromFile("source.tiff") == GdPictureStatus.OK) &&
        (annotMgr.SelectPage(1) == GdPictureStatus.OK))
    {
        GdPicture14.Annotations.AnnotationEmbeddedImage annot = annotMgr.AddEmbeddedImageAnnot("annot.jpeg", 0.5f, 0.5f, 2, 3);
        if ((annotMgr.GetStat() == GdPictureStatus.OK) && (annot != null))
        {
            annot.Author = "GdPicture";
            annot.Opacity = 0.8f;
            if (annotMgr.SaveAnnotationsToPage() == GdPictureStatus.OK)
                annotMgr.SaveDocumentToTIFF("dest.tiff", TiffCompression.TiffCompressionAUTO);
        }
        annot.Dispose();
    }
    if (annotMgr.GetStat() == GdPictureStatus.OK)
        MessageBox.Show("Done!", "AnnotationManager.AddEmbeddedImageAnnot");
    else
        MessageBox.Show("Error!   Status: " + annotMgr.GetStat().ToString(), "AnnotationManager.AddEmbeddedImageAnnot");
    annotMgr.Close();
}

Reference

AnnotationManager Class
AnnotationManager Members
Overload List
SelectPage Method
SaveAnnotationsToPage Method
GetAnnotationCount Method
GetAnnotationIdx Method
GetAnnotationType Method
DeleteAnnotation Method