Skip to main content
English (US) Nederlands

Assets Server action plug-ins setting - userInterface

  • Updated

The userInterface setting is one of the settings of an Action plug-in that can be configured in its configuration file. For more information, see Assets Server Action plug-ins - configuration settings.

Required Yes
Description

Controls where the URL is opened:

  • in a tab,
  • in a dialog
  • in an external web browser.
Basic setting 
<action>
    <userInterface>...</userInterface>
</action>

Tab - <tab/>

Opens the URL in a new Browser tab.

Dialog - <dialog/>

Opens the URL in a dialog.

Parameters

width

Dialog width in pixels.

Optional. Default is 800.
height

Dialog height in pixels.

Optional. Default is 600.

External browser - <externalBrowser/>

Opens the URL in the system's default (external) Web browser.

Parameters

loadInIframe

Defines if the URL is opened in an iframe.

Set to true when the URL is a HTML page, in this case the URL is loaded in an iframe which consumes the complete browser window. The elvisContext is available via JavaScript, via parent.elvisContext.

Set to false, or do not specify when the URL is a server side page (JSP, PHP, ASP, etc). The elvisContext is available as POST variable, formatted in JSON.

Optional. Default is "false".

Examples

Open a tab

<userInterface>
    <tab/>
<userInterface>

Open a dialog with default dimensions

<userInterface>
    <dialog/>
<userInterface>

Open a dialog with a custom width and height

<userInterface>
    <dialog width="500" height="400"/>
<userInterface>

Open an external browser with default settings

<userInterface>
    <externalBrowser/>
<userInterface>

Open an external browser and load the URL in an iframe

<userInterface>
    <externalBrowser loadInIframe="true"/>
<userInterface>

Related articles

Comment

Do you have corrections or additional information about this article? Leave a comment!
Do you have a question about what is described in this article? Please contact Support.


0 comments

Please sign in to leave a comment.