A color object that defines the required color of the newly added redaction annotation.
Example





In This Topic
GdPicture14 Namespace / GdViewer Class / AddRedactionAnnotInteractive Method

AddRedactionAnnotInteractive Method (GdViewer)

In This Topic
Allows users to interactively add a new redaction annotation using the mouse on the current page of the document displayed in the GdViewer control. The annotation object is added following all the parameters you have specified and respecting the dimensions users will define using the mouse as well.

This annotation enables users to mark regions for redaction by adjusting the height and the width of the annotation continuously using the mouse.

The redaction annotations are used as input for the ApplyAllRedactions method.

The type of the newly added annotation object is GdPictureAnnotationType.AnnotationTypeRedaction. You can change the annotation properties directly using the GdPicture14.Annotations.AnnotationRedaction class before or after the successful creation of the annotation object. Please refer to both the BeforeAnnotationAddedByUser and the AnnotationAddedByUser events for how to achieve this.

Be aware that the editing mode for annotations must be enabled using the SetAnnotationEditorMode method, otherwise this method will fail.

Syntax
'Declaration
 

Public Sub AddRedactionAnnotInteractive( _
   ByVal BackColor As Color _
) 
public void AddRedactionAnnotInteractive( 
   Color BackColor
)
public procedure AddRedactionAnnotInteractive( 
    BackColor: Color
); 
public function AddRedactionAnnotInteractive( 
   BackColor : Color
);
public: void AddRedactionAnnotInteractive( 
   Color BackColor
) 
public:
void AddRedactionAnnotInteractive( 
   Color BackColor
)

Parameters

BackColor
A color object that defines the required color of the newly added redaction annotation.
Remarks
The GetStat method can be subsequently used to determine if this method has been successful. If the editing mode for annotations is disabled, the method will fail.
Example
How to add redaction annotations. 
'We assume that the GdViewer1 control has been properly integrated.
Sub buttonAddRedactionMark_Click(ByVal sender As Object, ByVal e As EventArgs)
    GdViewer1.AddRedactionAnnotInteractive(Color.Black)
    If GdViewer1.GetStat() <> GdPictureStatus.OK Then MessageBox.Show("Error!  Status: " + GdViewer1.GetStat().ToString(), "AddRedactionAnnotInteractive")
End Sub
//We assume that the GdViewer1 control has been properly integrated.
void buttonAddRedactionMark_Click(object sender, EventArgs e)
{
    GdViewer1.AddRedactionAnnotInteractive(Color.Black);
    if (GdViewer1.GetStat() != GdPictureStatus.OK) MessageBox.Show("Error!  Status: " + GdViewer1.GetStat().ToString(), "AddRedactionAnnotInteractive");
}
See Also

Reference

GdViewer Class
GdViewer Members
BeforeAnnotationAddedByUser Event
AnnotationAddedByUser Event
SetAnnotationEditorMode Method
GetAnnotationCount Method
ApplyAllRedactions Method