Border (Type of variable)

ONLINE HELP
WINDEV, WEBDEV AND WINDEV MOBILE

Version:

Home | Sign in | English

This content has been translated automatically. Click here to view the French version.

Default characteristics of border
WLanguage properties that can be used with the Border type
Type of line for the border

WINDEV

WEBDEV

WINDEV Mobile

Others

See also

Declaring and using a variable

Border (Type of variable)

In french: Cadre

The Border type is used to handle a border by programming. The characteristics of this border can be modified by several WLangage properties.

A Border type can be used:

in the controls of a report (Border property of controls of a report).
in the drawing functions (dBorder).
in the Excel cells (Border property for the cells of an Excel document).

Remark: See Declaring a variable for more details on the declaration of this type of variable and the use of WLanguage properties.

Example

// Define the border characteristics
MyBorder is Border
MyBorder..Color = LightRed
MyBorder..Thickness = 5

// Use the border for the NumNbPage control of report
NumNbPage..Border = MyBorder
// Modify a border characteristic for the NumNbPage control
NumNbPage..Border..Thickness = 1

// Retrieve the border characteristics for the NumNbPage control
MyBorder2 is Border = NumNbPage..Border

Versions 21 and later

// Define the border characteristics
MyBorder is Border
MyBorder.Color = LightRed
MyBorder.Thickness = 5

// Use the border for the NumNbPage control of report
NumNbPage.Border = MyBorder
// Modify a border characteristic for the NumNbPage control
NumNbPage.Border.TopLeftCorner.Width = 2
NumNbPage.Border.TopLeftCorner.Height = 3

New in version 21

Remarks

Default characteristics of border

By default, a border found in a report has the following characteristics:

thickness set to 0. The border is visible if the thickness is greater than 0. The border is invisible if the thickness is set to 0.
black.
solid line.
no rounded corner.
all the border edges are displayed.

By default, the border of a cell found in an XLS worksheet has the same characteristics. However, the thickness of the line and the rounding of corners are not supported for an XLS cell.

To define the characteristics of a border by programming, use the properties for border management.

WLanguage properties that can be used with the Border type

The following properties can be used to handle a Border variable.


Property name	Type used	Effect
Round	Real	Value of rounding for the corners. Corresponds to the radius of rounding. Versions 21 and later In modification, modifies the rounding of all corners. In read mode, returns: the width and the height of corners if these parameters are identical for all corners. the RoundingUndefined constant if all the corners do not have the same width and height. New in version 21 In modification, modifies the rounding of all corners. In read mode, returns: the width and the height of corners if these parameters are identical for all corners. the RoundingUndefined constant if all the corners do not have the same width and height. In modification, modifies the rounding of all corners. In read mode, returns: the width and the height of corners if these parameters are identical for all corners. the RoundingUndefined constant if all the corners do not have the same width and height. Not supported: in the XLS cells. in the prargraphs of Word Processing documents.
Edges	Integer constant	Returns and modifies the presence of edges. This property can correspond to a combination of the following options: BorderNone: the border has no edge. BorderBottom: the border has a bottom edge. BorderRight: the border has a right edge. BorderLeft: the border has a left edge. BorderTop: the border has a top edge. BorderAll: all the border edges are displayed.
Versions 21 and later BottomRightCorner New in version 21 BottomRightCorner BottomRightCorner		Characteristics of bottom right corner: Property Width: width of border corner (real). Property Height: height of border corner (real). Not supported in the XLS cells.
Versions 21 and later BottomLeftCorner New in version 21 BottomLeftCorner BottomLeftCorner		Characteristics of bottom left corner: Property Width: width of border corner (real). Property Height: height of border corner (real). Not supported in the XLS cells.
Versions 21 and later TopRightCorner New in version 21 TopRightCorner TopRightCorner		Characteristics of top right corner: Property Width: width of border corner (real). Property Height: height of border corner (real). Not supported in the XLS cells.
Versions 21 and later TopLeftCorner New in version 21 TopLeftCorner TopLeftCorner		Characteristics of top left corner: Property Width: width of border corner (real). Property Height: height of border corner (real). Not supported in the XLS cells.
Color	Integer	Color of the border. This color can correspond to: an RGB color (returned by RGB), a preset color. Versions 21 and later In modification, modifies the color of all borders. In read mode, returns: the color of borders if this parameter is identical for all borders. the ColorUndefined constant if all the borders do not have the same color. New in version 21 In modification, modifies the color of all borders. In read mode, returns: the color of borders if this parameter is identical for all borders. the ColorUndefined constant if all the borders do not have the same color. In modification, modifies the color of all borders. In read mode, returns: the color of borders if this parameter is identical for all borders. the ColorUndefined constant if all the borders do not have the same color.
Thickness	Real	Returns and modifies the thickness of the border (in millimeters in the prints and in pixels in the graphic functions). Versions 21 and later In modification, modifies the thickness of all borders. In read mode, returns: the thickness of borders if this parameter is identical for all borders. the ThicknessUndefined constant if all the borders do not have the same thickness. New in version 21 In modification, modifies the thickness of all borders. In read mode, returns: the thickness of borders if this parameter is identical for all borders. the ThicknessUndefined constant if all the borders do not have the same thickness. In modification, modifies the thickness of all borders. In read mode, returns: the thickness of borders if this parameter is identical for all borders. the ThicknessUndefined constant if all the borders do not have the same thickness. Not supported in the XLS cells.
Line	Integer constant	Returns and modifies the type of line for the border (see the next paragraph). Versions 21 and later In modification, modifies the type of line for all borders. In read mode, returns: the type of line for the borders if this parameter is identical for all borders. the TypeUndefined constant if all the borders do not have the same line. New in version 21 In modification, modifies the type of line for all borders. In read mode, returns: the type of line for the borders if this parameter is identical for all borders. the TypeUndefined constant if all the borders do not have the same line. In modification, modifies the type of line for all borders. In read mode, returns: the type of line for the borders if this parameter is identical for all borders. the TypeUndefined constant if all the borders do not have the same line.
Versions 21 and later LineBottom New in version 21 LineBottom LineBottom		Characteristics of the bottom line: Property Color: Line color: This color can correspond to an RGB color (returned by RGB) or to a preset color. §>Thickness (Real): Line thickness (in millimeters in the prints and in pixels in the graphic functions). Property Type (integer type constant): Type of line (see the next paragraph). Not supported in the XLS cells.
Versions 21 and later LineRight New in version 21 LineRight LineRight		Characteristics of the right line: Property Color: Line color: This color can correspond to an RGB color (returned by RGB) or to a preset color. Property Thickness (Actual): Line thickness (in millimeters in the prints and in pixels in the graphic functions). Property Type (integer type constant): Type of line (see the next paragraph). Not supported in the XLS cells.
Versions 21 and later LineLeft New in version 21 LineLeft LineLeft		Characteristics of the left line: Property Color: Line color: This color can correspond to an RGB color (returned by RGB) or to a preset color. Property Thickness (Actual): Line thickness (in millimeters in the prints and in pixels in the graphic functions). Property Type (integer type constant): Type of line (see the next paragraph). Not supported in the XLS cells.
Versions 21 and later LineTop New in version 21 LineTop LineTop		Characteristics of the top line: Property Color: Line color: This color can correspond to an RGB color (returned by RGB) or to a preset color. Property Thickness (Actual): Line thickness (in millimeters in the prints and in pixels in the graphic functions). Property Type (integer type constant): Type of line (see the next paragraph). Not supported in the XLS cells.

These properties can be used:

on the Border variable. Example:

MyBorder is Border
MyBorder.Color = LightRed
MyBorder.Thickness = 5
on the Border property of the element used.

// Modify a characteristic of the border for the NumNbPage element
Border...Thickness = 1

Remark: The characteristics of a border defined by programming can also be directly assigned to an element:

// Define the border characteristics
MyBorder is Border
MyBorder.Color = LightRed
MyBorder.Thickness = 5

// Use the border for the NumNbPage control of report
NumNbPage.Border = MyBorder

Type of line for the border

The Property Type makes it possible to define and know the type of the Line of the Border. The available constants are as follows (caution: the effect of these constants will differ when the border is used in a report or when it is used for a cell in an Excel document).


Constant	Effect in Excel	Effect in a report	Versions 21 and later Effect in dBorder New in version 21 Effect in dBorder Effect in dBorder
LineNone	No line.	No line.	No line.
LineSolid		with the thickness defined in millimeters.
LineSolidThick		with the thickness defined in millimeters.
LineSolidMedium		with the thickness defined in millimeters.
LineDouble		with the thickness defined in millimeters.
LineDotAndDash		with the thickness defined in millimeters.
LineDotAndDashMedium		with the thickness defined in millimeters.
LineDotAndDashDoubleDash		with the thickness defined in millimeters.
LineDotAndDashDoubleDashMedium		with the thickness defined in millimeters.
LineDotted		with the thickness defined in millimeters
LineDottedMedium		with the thickness defined in millimeters
LineDash		with the thickness defined in millimeters.
LineDashMedium		with the thickness defined in millimeters.