Click or drag to resize

PlatformOptions Class

Experimental : The class that controls options for a platform
Inheritance Hierarchy
SystemObject
  Openfin.DesktopOptionsEx
    Openfin.Desktop.PlatformAPIPlatformOptions

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

The PlatformOptions type exposes the following members.

Constructors
  NameDescription
Public methodPlatformOptions
Constructs an instance configuring a new underlying JObject with the passed values.
Top
Properties
  NameDescription
Public propertyApplicationIcon
The ApplicationIcon property represents the icon to display for the Application's main window.

Support formats: Portable Network Graphic (PNG); Size: 256 x 256

Default: An null string

Public propertyBrowserPluginsEnabled
Enables PPAPI plugins (Flash) for this application.
Public propertyCommands
Public propertyContentNavigationRules
Navigation rules used by this application.

Default: No application rules, Application will be allowed to navigate to any URL.

Public propertyDefaultViewOptions
Public propertyDefaultWindowOptions
Public propertyDisableDefaultCommands
Public propertyDisableIabSecureLogging
An error message to display when the application (launched via manifest) fails to load.
Public propertyEnableFDC3
Enables embedded FDC3 support within a supported runtime
Public propertyIsAdmin Obsolete.
The IsAdmin property represents if the application has administrator privileges. (e.g., the ability to create and run applications).

Default: false

Public propertyIsPlatformController
Public propertyLoadErrorMessage
An error message to display when the application (launched via manifest) fails to load.
Public propertyMainWindowOptions
The MainWindowOptions property represents the options of the main window of the application.
Public propertyName
The Name property represents the the name for the Application's main window window which must be unique within the context of the invoking Application.

Default: An empty string

Public propertyNonPersistent
Determines if this Application should keep the runtime up in the event of all other connections failing.
Public propertyPermissions
Public propertyProviderUrl
Public propertySnapshot
Public propertySpellCheck
Public propertySupressWindowAlerts
Determines if Alert boxes from any window within the application are suppresed, if supressed you will need to handle WindowAlertRequested events to obtain the information.
Public propertyUUID
The UUID property represents the UUID of the application as known by the AppDesktop.

Default: An empty string

Public propertyVersion Obsolete.
The Version property represents the version of the application.

Default: An empty string

Public propertyWebSecurity
When set to false it will disable the same-origin policy for the application.
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 methodgetJsonCopy
Gets all settings in JObject format.
(Inherited from OptionsEx.)
Public methodGetProperty
Gets the value of specified property by it's name or JSON name. This methond is intended to get experimental, undocumented or unsupported properties. However, using this method with existing public property name or JSON name will also get the value of that property.
(Inherited from OptionsEx.)
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 methodSetProperty
Sets the value of specified property by it's name or JSON name. This methond is intended to set experimental, undocumented or unsupported properties. However, using this method with existing public property name or JSON name will also set the value of that property.
(Inherited from OptionsEx.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also