PlatformOptions Class |
Experimental : The class that controls options for a platform
Inheritance HierarchyNamespace: Openfin.Desktop.PlatformAPI
Assembly: OpenfinDesktop (in OpenfinDesktop.dll) Version: 17.6.0
SyntaxC#
public class PlatformOptions : OptionsEx
The PlatformOptions type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PlatformOptions |
Constructs an instance configuring a new underlying JObject
with the passed values.
|
Properties| Name | Description | |
|---|---|---|
 | ApplicationIcon |
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 |
| BrowserPluginsEnabled |
Enables PPAPI plugins (Flash) for this application.
|
| Commands | |
| ContentNavigationRules |
Navigation rules used by this application.
Default: No application rules, Application will be allowed to navigate to any URL. |
| DefaultViewOptions | |
| DefaultWindowOptions | |
| DisableDefaultCommands | |
| DisableIabSecureLogging |
An error message to display when the application (launched via manifest) fails to load.
|
| EnableFDC3 |
Enables embedded FDC3 support within a supported runtime
|
| IsAdmin | Obsolete.
The IsAdmin property represents if the application has
administrator privileges. (e.g., the ability to create
and run applications).
Default: false |
| IsPlatformController | |
| LoadErrorMessage |
An error message to display when the application (launched via manifest) fails to load.
|
| MainWindowOptions |
The MainWindowOptions property represents the options
of the main window of the application.
|
| Name |
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 |
| NonPersistent |
Determines if this Application should keep the runtime up in the event of all other connections failing.
|
| Permissions | |
| ProviderUrl | |
| Snapshot | |
| SpellCheck | |
| SupressWindowAlerts |
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.
|
| UUID |
The UUID property represents the UUID of the application
as known by the AppDesktop.
Default: An empty string |
| Version | Obsolete.
The Version property represents the version
of the application.
Default: An empty string |
| WebSecurity |
When set to false it will disable the same-origin policy for the application.
|
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| getJsonCopy |
Gets all settings in JObject format.
(Inherited from OptionsEx.) |
| GetProperty |
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.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetProperty |
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.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also