AddTextAnnot Method (AnnotationManager)

In This Topic

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

The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeText. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationText 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 Function AddTextAnnot( _
   ByVal Left As Single, _
   ByVal Top As Single, _
   ByVal Width As Single, _
   ByVal Height As Single, _
   ByVal Text As String _
) As AnnotationText

public AnnotationText AddTextAnnot( 
   float Left,
   float Top,
   float Width,
   float Height,
   string Text
)

public function AddTextAnnot( 
    Left: Single;
    Top: Single;
    Width: Single;
    Height: Single;
    Text: String
): AnnotationText;

public function AddTextAnnot( 
   Left : float,
   Top : float,
   Width : float,
   Height : float,
   Text : String
) : AnnotationText;

public: AnnotationText* AddTextAnnot( 
   float Left,
   float Top,
   float Width,
   float Height,
   string* Text
)

public:
AnnotationText^ AddTextAnnot( 
   float Left,
   float Top,
   float Width,
   float Height,
   String^ Text
)

Parameters

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.
Text: The content of the newly added annotation, that means the text to be displayed in the annotation bounding box.

Return Value

A GdPicture/XMP AnnotationText object. The newly added GdPicture/XMP text 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 a text annotation to a newly created image.

VB.NET
C#

Dim status As GdPictureStatus = GdPictureStatus.OK
Using image As GdPictureImaging = New GdPictureImaging()
    Dim imageID As Integer = image.CreateNewGdPictureImage(1000, 1600, CShort(32), Color.White)
    status = image.GetStat()
    If (status = GdPictureStatus.OK) AndAlso (imageID <> 0) Then
        Using annotMgr As AnnotationManager = New AnnotationManager()
            If (annotMgr.InitFromGdPictureImage(imageID) = GdPictureStatus.OK) AndAlso
               (annotMgr.SelectPage(1) = GdPictureStatus.OK) Then
                Dim annot As GdPicture14.Annotations.AnnotationText = annotMgr.AddTextAnnot(1, 1, 4, 1, "This is some text introduced by the TextAnnotation added by GdPicture.")
                If (annotMgr.GetStat() = GdPictureStatus.OK) AndAlso (annot IsNot Nothing) Then
                    annot.Alignment = System.Drawing.StringAlignment.Near
                    annot.Author = "GdPicture"
                    annot.Fill = True
                    annot.FillColor = Color.LightBlue
                    annot.FontSize = 16
                    annot.Opacity = 0.7F
                    annot.StrokeColor = Color.DarkBlue
                End If
                If annotMgr.SaveAnnotationsToPage() = GdPictureStatus.OK Then
                    annotMgr.SaveDocumentToJPEG("textannot.jpeg", 75)
                End If
                annot.Dispose()
            End If
            status = annotMgr.GetStat()
            annotMgr.Close()
        End Using
        image.ReleaseGdPictureImage(imageID)
    End If
End Using
'We assume that the GdViewer1 control has been integrated into your application.
If status = GdPictureStatus.OK Then
    GdViewer1.DisplayFromFile("textannot.jpeg")
Else
    MessageBox.Show("Error!   Status: " + status.ToString(), "AnnotationManager.AddTextAnnot")
End If

GdPictureStatus status = GdPictureStatus.OK;
using (GdPictureImaging image = new GdPictureImaging())
{
    int imageID = image.CreateNewGdPictureImage(1000, 1600, 32, Color.White);
    status = image.GetStat();
    if ((status == GdPictureStatus.OK) && (imageID != 0))
    {
        using (AnnotationManager annotMgr = new AnnotationManager())
        {
            if ((annotMgr.InitFromGdPictureImage(imageID) == GdPictureStatus.OK) &&
                (annotMgr.SelectPage(1) == GdPictureStatus.OK))
            {
                GdPicture14.Annotations.AnnotationText annot = annotMgr.AddTextAnnot(1, 1, 4, 1, "This is some text introduced by the TextAnnotation added by GdPicture.");
                if ((annotMgr.GetStat() == GdPictureStatus.OK) && (annot != null))
                {
                    annot.Alignment = System.Drawing.StringAlignment.Near;
                    annot.Author = "GdPicture";
                    annot.Fill = true;
                    annot.FillColor = Color.LightBlue;
                    annot.FontSize = 16;
                    annot.Opacity = 0.7f;
                    annot.StrokeColor = Color.DarkBlue;
                }
                if (annotMgr.SaveAnnotationsToPage() == GdPictureStatus.OK)
                    annotMgr.SaveDocumentToJPEG("textnote.jpeg", 75);
                annot.Dispose();
            }
            status = annotMgr.GetStat();
            annotMgr.Close();
        }
        image.ReleaseGdPictureImage(imageID);
    }
}
//We assume that the GdViewer1 control has been integrated into your application.
if (status == GdPictureStatus.OK)
    GdViewer1.DisplayFromFile("textnote.jpeg");
else
    MessageBox.Show("Error!   Status: " + status.ToString(), "AnnotationManager.AddTextAnnot");

Reference

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