Click or drag to resize

Settings Class

Experimental : Settings used to configure layout behavior.
Inheritance Hierarchy
SystemObject
  Openfin.Desktop.PlatformAPISettings

Namespace:  Openfin.Desktop.PlatformAPI
Assembly:  OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
Syntax
C#
public class Settings

The Settings type exposes the following members.

Constructors
  NameDescription
Public methodSettings
Initializes a new instance of the Settings class
Top
Properties
  NameDescription
Public propertyBlockedPopoutsThowError
Specifies if an error is thrown when a popout is blocked by the browser (e.g. by opening it programmatically). If false, the popout call will fail silently. Default: true
Public propertyClosePopoutsOnUnload
Specifies if all popouts should be closed when the page that created them is closed. Popouts don't have a strong dependency on their parent and can exist on their own, but can be quite annoying to close by hand.In addition, any changes made to popouts won't be stored after the parent is closed. Default: true
Public propertyConstrainDragToContainer
Constrains the area in which items can be dragged to the layout's container. Will be set to false automatically when layout.createDragSource() is called. Default : true
Public propertyHasHeaders
Turns headers on or off. If false, the layout will be displayed with splitters only. Default : true
Public propertyPopoutWholeStack
Decides what will be opened in a new window if the user clicks the popout icon. If true the entire stack will be transferred to the new window, if false only the active component will be opened.
Public propertyReorderEnabled
If true, the user can re-arrange the layout by dragging items by their tabs to the desired location. Default: true
Public propertySelectionEnabled
If true, the user can select items by clicking on their header. This sets the value of layout.selectedItem to the clicked item, highlights its header and the layout emits a 'selectionChanged' event. Default : true
Public propertyshowCloseIcon
Specifies if the close icon should be displayed in the header-bar. Default: true
Public propertyshowMaximiseIconshowPopoutIcon
Specifies if the maximise icon should be displayed in the header-bar. Default: true
Public propertyshowPopoutIcon
Specifies if the popout icon should be displayed in the header-bar. Default: true
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also