RectBorderSize Property (GdViewer)

In This Topic

Gets or sets the border size (the border width), in pixels, of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This value is used when drawing the rectangle of selection within the control.

You can find out, if this rectangle is currently defined and drawn, using the IsRect method.

Syntax

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

'Declaration
 
Public Property RectBorderSize As Integer

public int RectBorderSize {get; set;}

public read-write property RectBorderSize: Integer;

public function get,set RectBorderSize : int

public: __property int get_RectBorderSize();
public: __property void set_RectBorderSize( 
   int value
);

public:
property int RectBorderSize {
   int get();
   void set (    int value);
}

Property Value

The default value is 1.

Remarks

Be aware that you are allowed to define only one rectangle of selection within the GdViewer control. The property value does not change when reloading documents in the control.

Example

How to reset the border size of the rectangle of selection.

VB.NET
C#

'We assume that the GdViewer1 control has been properly integrated.
'Setting some custom properties (the border color and the border size) for the rectangle of selection.
GdViewer1.SetRectBorderColor(GdViewer1.ARGBI(255, 255, 69, 0))
'Calling the method above does the same as setting the property as below.
'GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0)
GdViewer1.RectBorderSize = 2

//We assume that the GdViewer1 control has been properly integrated
//Setting some custom properties (the border color and the border size) for the rectangle of selection.
GdViewer1.SetRectBorderColor(GdViewer1.ARGBI(255, 255, 69, 0));
//Calling the method above does the same as setting the property as below.
//GdViewer1.RectBorderColor = GdViewer1.ARGB(255, 69, 0);
GdViewer1.RectBorderSize = 2;

Reference

GdViewer Class
GdViewer Members
SetRectBorderColor Method
RectBorderColor Property
IsRect Method
ClearRect Method