BorderGetFlags

Syntax

Flags = BorderGetFlags(Border)

Description

Retrieves the style flags currently set for a generated border object. This command is only applicable to borders created with CreateBorder().

Parameters

Border
The handle of the generated border object.

Return Value

Returns an integer representing the combination of style flags currently applied to the border. Returns 0 or #False if the border handle is invalid or not a generated border.

Remarks

The returned value is a combination of the #PG_Border_* style constants originally passed to CreateBorder() or subsequently set using BorderSetFlags().

Example

IncludeFile "ProGUI_PB.pbi"

StartProGUI()

MyBorder = CreateBorder(#PG_Border_Groove | #PG_Border_TopDash, 6, 10)

If MyBorder
  CurrentFlags = BorderGetFlags(MyBorder)
  Debug "Border Flags: " + Str(CurrentFlags)

  If CurrentFlags & #PG_Border_Groove
    Debug "- Groove style is set"
  EndIf
  If CurrentFlags & #PG_Border_TopDash
    Debug "- Top side is dashed"
  EndIf

  FreeBorder(MyBorder)
EndIf

StopProGUI()

See Also

CreateBorder, BorderSetFlags, BorderGetWidth, BorderGetColor, BorderGetRadius

Supported OS

Windows, Linux