WidgetGetMargin

Syntax

MarginLeft = WidgetGetMargin(Widget, *MarginLeft.Integer=#Null, *MarginTop.Integer=#Null, *MarginRight.Integer=#Null, *MarginBottom.Integer=#Null)

Description

Retrieves the current margin settings for the specified widget. Margins define the space around the widget, outside its border.

Parameters

Widget
The handle of the ProGUI widget whose margins are to be retrieved.

*MarginLeft.Integer (optional)
A pointer to an Integer variable that will receive the left margin value (in DIPs).

*MarginTop.Integer (optional)
A pointer to an Integer variable that will receive the top margin value (in DIPs).

*MarginRight.Integer (optional)
A pointer to an Integer variable that will receive the right margin value (in DIPs).

*MarginBottom.Integer (optional)
A pointer to an Integer variable that will receive the bottom margin value (in DIPs).

Return Value

Returns the left margin value as an Integer (DIPs). Returns 0 or #False if the widget handle is invalid. The other margin values are returned via the pointers if provided.

Remarks

Margins contribute to the spacing between widgets within a layout. They are specified in device-independent pixels (DIPs). Individual margins can be retrieved using WidgetGetMarginLeft(), WidgetGetMarginTop(), etc.

See Also

WidgetSetMargin, WidgetSetMarginLeft, WidgetSetMarginTop, WidgetSetMarginRight, WidgetSetMarginBottom, WidgetGetMarginLeft, WidgetGetMarginTop, WidgetGetMarginRight, WidgetGetMarginBottom

Supported OS

Windows, Linux