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
'Declaration
Public Overloads Function AddEmbeddedImageAnnot( _
ByVal As String, _
ByVal As Single, _
ByVal As Single, _
ByVal As Single, _
ByVal As Single _
) As AnnotationEmbeddedImage
public AnnotationEmbeddedImage AddEmbeddedImageAnnot(
string ,
float ,
float ,
float ,
float
)
public function AddEmbeddedImageAnnot(
: String;
: Single;
: Single;
: Single;
: Single
): AnnotationEmbeddedImage;
public function AddEmbeddedImageAnnot(
: String,
: float,
: float,
: float,
: float
) : AnnotationEmbeddedImage;
public: AnnotationEmbeddedImage* AddEmbeddedImageAnnot(
string* ,
float ,
float ,
float ,
float
)
public:
AnnotationEmbeddedImage^ AddEmbeddedImageAnnot(
String^ ,
float ,
float ,
float ,
float
)
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.
Example
How to add an embedded image annotation from a file on the currently selected page of the handled document.
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();
}
Example
How to add an embedded image annotation from a file on the currently selected page of the handled document.
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();
}
See Also