Sign in Join
FPDoc Onlineexperiment

TForm.ShowInTaskBar property

Member of TFormpublishedIn unit Forms

Indicates if the form should be displayed on the system Task Bar.

Declaration

pascal
property ShowInTaskBar:;

Description

ShowInTaskBar is a TShowInTaskbar property which indicates whether the form instance should be displayed as an icon on the system task bar. The default value for the property is stDefault, and indicates the default behavior for the application, widgetset, platform, or operating system is used. See TShowInTaskbar for more information about values in the enumeration and their meanings.

ShowInTaskBar is used in conjunction with the TaskBarBehavior property in the Application singleton to determine the effective (realized) visibility for the form on the system task bar. For example, the value may be changed when it conflicts with the value in TaskBarBehavior.

Changing the value for the property causes the effective visibility to be recalculated when the form is not hidden, or a MDI child form. The value is posted to the widgetset class. Actions performed in the widget are platform-specific, and may include:

  • Update and apply style flags for the form window (when needed).
  • Show or Hide the form window (as needed).
  • Disable the request when not supported in the widgetset or the display protocol (like X-11, Wayland).
  • Update other properties which control the feature (GTK2 and GTK use their SkipTaskBarHint properties).

In short, ShowInTaskBar is the requested visibility on the task bar. EffectiveShowInTaskBar is the visibility as determined by the Application and the widgetset / platform at run-time. stDefault is the value which enables use of the platform rules. Any given value assigned to either ShowInTaskBar or in Application.TaskBarBehavior can be overridden at run-time based on the capabilities for the widgetset or the display manager.

For the macOS Carbon widgetset, ShowInTaskBar is not supported.

This description is the one of Forms.TCustomForm.ShowInTaskBar.

See also

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.