SetAnnotationEditorMode Method (GdViewer)

In This Topic

Turns on or off the "editing mode" for the GdPicture/XMP annotation support, that means allows to edit or to lock available GdPicture/XMP annotations of the document displayed in the GdViewer control. The initial value is set to true.

Syntax

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

'Declaration
 
Public Sub SetAnnotationEditorMode( _
   ByVal EditorMode As Boolean _
)

public void SetAnnotationEditorMode( 
   bool EditorMode
)

public procedure SetAnnotationEditorMode( 
    EditorMode: Boolean
);

public function SetAnnotationEditorMode( 
   EditorMode : boolean
);

public: void SetAnnotationEditorMode( 
   bool EditorMode
)

public:
void SetAnnotationEditorMode( 
   bool EditorMode
)

Parameters

EditorMode: Set this parameter to true to let users to edit available annotations of the displayed document. Set this parameter to false to prevent available annotations from editing, in other words to lock them.

Remarks

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

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

Example

How to enable or disable the annotations editing mode for GdPicture/XMP annotations.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
            
Sub buttonEnableEditing_Click(ByVal sender As Object, ByVal e As EventArgs)
    GdViewer1.SetAnnotationEditorMode(True)
End Sub
            
Sub buttonDisableEditing_Click(ByVal sender As Object, ByVal e As EventArgs)
    GdViewer1.SetAnnotationEditorMode(False)
End Sub

//We assume that the GdViewer1 control has been properly integrated.
            
void buttonEnableEditing_Click(object sender, EventArgs e)
{
    GdViewer1.SetAnnotationEditorMode(true);
}
            
void buttonDisableEditing_Click(object sender, EventArgs e)
{
    GdViewer1.SetAnnotationEditorMode(false);
}

Reference

GdViewer Class
GdViewer Members
GetAnnotationCount Method
GetAnnotationManager Method
GetAnnotationFromIdx Method
SelectAnnotation Method