BorderGetWidth - ProGUI Reference Manual

Syntax

Width.d = BorderGetWidth(Border, *LeftWidth.Double=#Null, *TopWidth.Double=#Null, *RightWidth.Double=#Null, *BottomWidth.Double=#Null)

Description

Retrieves the width values (in DIPs) for the sides of a generated border object. This command is only applicable to borders created with CreateBorder().

Parameters

Border
The handle of the generated border object.

*LeftWidth.Double (optional)
A pointer to a Double variable to receive the width of the left border side.

*TopWidth.Double (optional)
A pointer to a Double variable to receive the width (thickness) of the top border side.

*RightWidth.Double (optional)
A pointer to a Double variable to receive the width of the right border side.

*BottomWidth.Double (optional)
A pointer to a Double variable to receive the width (thickness) of the bottom border side.

Return Value

Returns the width (Double) of the left border side in DIPs. Returns 0.0 or #False if the border handle is invalid or not a generated border.

Remarks

This function allows retrieving the individual width settings for each side of a generated border.

Example

IncludeFile "ProGUI_PB.pbi"

StartProGUI()

MyBorder = CreateBorder(#PG_Border_Solid, 5, 10)
BorderSetWidth(MyBorder, 2, 4, 6, 8)

If MyBorder
  BorderGetWidth(MyBorder, @LWidth.d, @TWidth.d, @RWidth.d, @BWidth.d)
  Debug "Left Width: " + StrD(LWidth)
  Debug "Top Width: " + StrD(TWidth)
  Debug "Right Width: " + StrD(RWidth)
  Debug "Bottom Width: " + StrD(BWidth)

  FreeBorder(MyBorder)
EndIf

StopProGUI()

Supported OS

Windows, Linux