Enum OpenAs
Stay organized with collections
Save and categorize content based on your preferences.
OpenAs
An enum that specifies how to open a URL.
The client can open a URL as either a full size window (if that is the frame used by the
client), or an overlay (such as a pop-up). The implementation depends on the client platform
capabilities, and the value selected may be ignored if the client does not support it. FULL_SIZE is supported by all clients.
Using OnClose may cause OpenAs to be ignored; if the client platform cannot
support both selected values together, OnClose takes precedence.
To call an enum, you call its parent class, name, and property. For example,
CardService.OpenAs.FULL_SIZE.
Properties
| Property | Type | Description |
FULL_SIZE | Enum | Open in a full window or tab. Default. |
OVERLAY | Enum | Open as an overlay such as a pop-up. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-12-02 UTC.
[null,null,["Last updated 2024-12-02 UTC."],[[["\u003cp\u003e\u003ccode\u003eOpenAs\u003c/code\u003e is an enum used to specify how a URL should be opened by the client, either as a full-size window or an overlay.\u003c/p\u003e\n"],["\u003cp\u003eWhile \u003ccode\u003eFULL_SIZE\u003c/code\u003e is supported by all clients, \u003ccode\u003eOVERLAY\u003c/code\u003e support depends on the client platform and might be ignored.\u003c/p\u003e\n"],["\u003cp\u003eUsing \u003ccode\u003eOnClose\u003c/code\u003e may take precedence over \u003ccode\u003eOpenAs\u003c/code\u003e, potentially causing the chosen opening method to be disregarded if the client platform has limitations.\u003c/p\u003e\n"],["\u003cp\u003eTo utilize this enum in your code, use the syntax: \u003ccode\u003eCardService.OpenAs.FULL_SIZE\u003c/code\u003e or \u003ccode\u003eCardService.OpenAs.OVERLAY\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Enum OpenAs\n\nOpenAs\n\nAn enum that specifies how to open a URL.\n\nThe client can open a URL as either a full size window (if that is the frame used by the\nclient), or an overlay (such as a pop-up). The implementation depends on the client platform\ncapabilities, and the value selected may be ignored if the client does not support it. `FULL_SIZE` is supported by all clients.\n\nUsing [OnClose](/apps-script/reference/card-service/on-close) may cause [OpenAs](#) to be ignored; if the client platform cannot\nsupport both selected values together, [OnClose](/apps-script/reference/card-service/on-close) takes precedence.\n\nTo call an enum, you call its parent class, name, and property. For example, `\nCardService.OpenAs.FULL_SIZE`. \n\n### Properties\n\n| Property | Type | Description |\n|-------------|--------|----------------------------------------|\n| `FULL_SIZE` | `Enum` | Open in a full window or tab. Default. |\n| `OVERLAY` | `Enum` | Open as an overlay such as a pop-up. |"]]
