SaveAnnotationsToXMP(Stream) Method

In This Topic

Saves the GdPicture/XMP annotation part of the current page of the document displayed in the GdViewer control in XML format to an instantiated Stream object according to what you have specified.

Be aware that this method only handles GdPicture/XMP annotations.

Syntax

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

'Declaration
 
Public Overloads Function SaveAnnotationsToXMP( _
   ByVal Stream As Stream _
) As GdPictureStatus

public GdPictureStatus SaveAnnotationsToXMP( 
   Stream Stream
)

public function SaveAnnotationsToXMP( 
    Stream: Stream
): GdPictureStatus;

public function SaveAnnotationsToXMP( 
   Stream : Stream
) : GdPictureStatus;

public: GdPictureStatus SaveAnnotationsToXMP( 
   Stream* Stream
)

public:
GdPictureStatus SaveAnnotationsToXMP( 
   Stream^ Stream
)

Parameters

Stream: A Stream object where all GdPicture/XMP annotations from the current page will be saved to. This Stream object must be initialized before it can be sent into this method and it should remain open for subsequent use.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Remarks

The output stream should be open for writing and should be closed/disposed of by the user as well.

Be aware that this method only handles GdPicture/XMP annotations contained within the currently displayed page.

Example

How to transfer GdPicture/XMP annotations from one jpg file to another.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated
'and your document has been properly displayed as well.
            
'Assuming you have already annotated the displayed jpg document.
Dim annotStream As System.IO.MemoryStream = New System.IO.MemoryStream()
If GdViewer1.SaveAnnotationsToXMP(annotStream) = GdPictureStatus.OK Then
    GdViewer1.CloseDocument()
    If (GdViewer1.DisplayFromFile("test.jpg") <> GdPictureStatus.OK) OrElse
       (GdViewer1.LoadAnnotationsFromXMP(annotStream) <> GdPictureStatus.OK) Then
        MessageBox.Show("Error! : " + GdViewer1.GetStat().ToString(), "GdViewer.SaveAnnotationsToXMP")
    End If
End If
annotStream.Dispose()

//We assume that the GdViewer1 control has been properly integrated
//and your document has been properly displayed as well.
            
//Assuming you have already annotated the displayed document.
System.IO.MemoryStream annotStream = new System.IO.MemoryStream();
if (GdViewer1.SaveAnnotationsToXMP(annotStream) == GdPictureStatus.OK)
{
    GdViewer1.CloseDocument();
    if ((GdViewer1.DisplayFromFile("test.jpg") != GdPictureStatus.OK) ||
        (GdViewer1.LoadAnnotationsFromXMP(annotStream) != GdPictureStatus.OK))
    {
        MessageBox.Show("Error! : " + GdViewer1.GetStat().ToString(), "GdViewer.SaveAnnotationsToXMP");
    }
}
annotStream.Dispose();

Reference

GdViewer Class
GdViewer Members
Overload List
SaveAnnotationsToXMPEx(Stream) Method
GetAnnotationCount Method
LoadAnnotationsFromXMP(Stream) Method
SaveAnnotationsToPage Method
BurnAnnotationsToPage(Boolean) Method