SetRectBorderColor Method (GdViewer)

In This Topic

Sets the border color of the rectangle of area selection, that is related to the document currently displayed in the GdViewer control. This color 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.

The default border color of the rectangle of area selection set by the toolkit is Color.Black. This property does not change its value when reloading documents within the control.

Syntax

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

'Declaration
 
Public Sub SetRectBorderColor( _
   ByVal Color As Integer _
)

public void SetRectBorderColor( 
   int Color
)

public procedure SetRectBorderColor( 
    Color: Integer
);

public function SetRectBorderColor( 
   Color : int
);

public: void SetRectBorderColor( 
   int Color
)

public:
void SetRectBorderColor( 
   int Color
)

Parameters

Color: A color value that defines the new border color used to draw the rectangle of area selection. You can obtain a suitable color using the ARGBI method.

Remarks

Be aware that you are allowed to define only one rectangle of selection within the GdViewer control.

Just to inform you, that this method simply resets the RectBorderColor property to the newly specified value. The default border color set by the toolkit is Color.Black. The property value does not change when reloading documents.

Example

How to reset the border color 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
RectBorderColor Property
RectBorderSize Property
IsRect Method
ClearRect Method
SearchText(String,Int32,Boolean) Method
SetRectCoordinatesOnDocument Method
SetRectCoordinatesOnViewer Method