[Overview][Constants][Types][Classes][Procedures and functions][Variables][Index] Reference for unit 'Forms' (#lcl)

TWindowMagnetOptions

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements options which control magnetic window behavior in form instances.

Declaration

Source position: forms.pp line 421

type TWindowMagnetOptions = class(TPersistent)

public

  constructor Create;

  

Constructor for the class instance.

  procedure AssignTo(); override;

  

Implements object persistence for TWindowMagnetOptions instances.

published

  property SnapToMonitor: Boolean; [rw]

  

Enables or disables snapping a form to one of the edges on the monitor.

  property SnapToForms: Boolean; [rw]

  

Enables or disables snapping the current form to other forms in the application.

  property SnapFormTarget: Boolean; [rw]

  

Enables or disables snapping another form in the application to the form instance.

  property Distance: Integer; [rw]

  

Distance from (or proximity to) a snap target where the snapping behavior is automatically engaged.

end;

Inheritance

TWindowMagnetOptions

  

Implements options which control magnetic window behavior in form instances.

|

TPersistent,IFPObserved

|

TObject

Description

TWindowMagnetOptions is a class which implements options needed to control magnetic window behavior when a form is snapped to another form or to an edge on the screen. It introduces properties with default values which enable or disable the snapping behaviors for forms or the screen. It also includes a property to set the proximity or threshold where snapping behavior is engaged.

TWindowMagnetOptions is the type used to implement the SnapOptions property in TCustomForm and descendent classes. It is also passed as an argument to the SnapToMonitor and SnapToForms methods in TWindowMagnetManager.

Version info

Added in LCL version 3.0.

See also

TCustomForm.SnapOptions

  

Contains the form and screen snapping options for the form instance.

TWindowMagnetManager.SnapToMonitor

  

Snaps a window to an edge on the monitor.

TWindowMagnetManager.SnapToForms

  

Snaps a form to an edge on another form in the application which is a valid snap target.


Version 3.2 Generated 2024-02-25 Home