IsRectEditing Method (GdViewer)

In This Topic

Detects, if the user is moving or editing the rectangle of area selection.

Please note that the rectangle of selection always relates to the document currently displayed in the GdViewer control. You can find out, if this rectangle is currently defined and drawn within the control, using the IsRect method.

The RectEditedByUser event is raised when the rectangle has been successfully edited.

Syntax

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

'Declaration
 
Public Function IsRectEditing() As Boolean

public bool IsRectEditing()

public function IsRectEditing(): Boolean;

public function IsRectEditing() : boolean;

public: bool IsRectEditing();

public:
bool IsRectEditing();

Return Value

true if the user is moving or editing the rectangle of area selection, else false.

Remarks

Please note that it is recommended to call this method from the MouseDown or MouseMove events.

Be aware that you are allowed to define only one rectangle of selection within the GdViewer control. Likewise, this rectangle always relates to the currently displayed document.

Example

How to utilize the fact that a user is editing the rectangle of area selection.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated
'and your document has been properly displayed as well.
Sub GdViewer1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
    If GdViewer1.IsRectEditing() Then
        'Do your stuff here.
    End If
End Sub

//We assume that the GdViewer1 control has been properly integrated
//and your document has been properly displayed as well.
void GdViewer1_MouseMove(object sender, MouseEventArgs e)
{
    if (GdViewer1.IsRectEditing())
    {
        //Do your stuff here.
    }
}

Reference

GdViewer Class
GdViewer Members
RectEditedByUser Event
RectIsEditable Property
IsRect Method
IsRectDrawing Method
ClearRect Method
CenterOnRect Method