| availability |
WebLinkAvailability (enumeration of type string) |
Required. Indicates whether the link is only available online
(online, or if it is also
available offline (offline). |
| description |
string |
A description of the link. |
| displayType |
WebLinkDisplayType (enumeration of type string) |
Represents how this link is rendered. Valid values:
-
link for a
hyperlink
-
button for a
button
-
massActionButton for a
button attached to a related list
|
| encodingKey |
Encoding (enumeration of type string) |
Required. The default encoding setting is Unicode: UTF-8. Change it if your template
requires data in a different format. This is available if your
content source is URL. Valid values include:
-
UTF-8—Unicode
(UTF-8)
-
ISO-8859-1—General US & Western Europe
(ISO-8859–1, ISO-LATIN-1)
-
Shift_JIS—Japanese (Shift-JIS)
-
ISO-2022-JP—Japanese (JIS)
-
EUC-JP—Japanese
(EUC-JP)
-
x-SJIS_0213—Japanese (Shift-JIS_2004)
-
ks_c_5601-1987—Korean (ks_c_5601-1987)
-
Big5—Traditional
Chinese (Big5)
-
GB2312—Simplified Chinese (GB2312)
-
Big5-HKSCS—Traditional Chinese Hong Kong
(Big5–HKSCS)
|
| fullName |
string |
The name used as a unique identifier for API access. The
fullName can contain only underscores and
alphanumeric characters. It must be unique, begin with a letter, not
include spaces, not end with an underscore, and not contain two
consecutive underscores. |
| hasMenubar |
boolean |
If the openType is newWindow, this field indicates
whether to show the browser menu bar for the window (true or not (false). Otherwise, leave this field
empty. |
| hasScrollbars |
boolean |
If the openType is newWindow, this field indicates
whether to show the scroll bars for the window (true) or not (false). Otherwise, leave this field
empty. |
| hasToolbar |
boolean |
If the openType is newWindow, this field indicates
whether to show the browser toolbar for the window (true) or not (false). Otherwise, leave this field
empty. |
| height |
int |
Height in pixels of the window opened by the link. Required if
the openType is newWindow. Otherwise, leave this field empty. |
| isResizable |
boolean |
If the openType is newWindow, this field indicates
whether to allow resizing of the window (true) or not (false). Otherwise, leave this field empty. |
| linkType |
WebLinkType (enumeration of type string) |
Required. Represents whether the content of the button or link is
specified by a URL, an sControl, a JavaScript code block, or a
Visualforce page.
- url
- sControl
- javascript
- page
-
flow—Reserved
for future use.
|
| masterLabel |
string |
The
label for the link. |
| openType |
WebLinkWindowType (enumeration of type string) |
Required. When the link is clicked, this field specifies the
window style used to display the content. Valid values are:
- newWindow
- sidebar
- noSidebar
- replace
- onClickJavaScript
|
| page |
string |
If the value of linkType is page, this field represents the
Visualforce page. Otherwise, leave this field empty. |
| position |
WebLinkPosition (enumeration of type string) |
If the openType is newWindow, this field indicates how
the new window should be displayed. Otherwise, leave this field
empty. Valid values are:
|
| protected |
boolean |
Required. Indicates whether this
component is protected (true)
or not (false). Protected
components cannot be linked to or referenced by components
created in the installing organization.
|
| requireRowSelection |
boolean |
If the openType is massAction, this field indicates
whether to require individual row selection to execute the action
for this button (true) or not
(false). Otherwise, leave
this field empty. |
| scontrol |
string |
If the value of linkType is sControl, this field represents the
name of the sControl. Otherwise, leave this field empty. |
| showsLocation |
boolean |
If the openType is newWindow, this field indicates
whether or not to show the browser location bar for the window.
Otherwise, leave this field empty. |
| showsStatus |
boolean |
If the openType is newWindow, this field indicates
whether or not to show the browser status bar for the window.
Otherwise, leave this field empty. |
| url |
string |
If the value of linkType is url, this field represents the
URL value. If the value of linkType is
javascript, this field
represents the JavaScript content. If the value is neither of
these, leave this field empty.
Content must be escaped in a manner consistent with XML parsing
rules.
|
| width |
int |
Width in pixels of the window opened by the link. Required if
the openType is newWindow. Otherwise, leave this field
empty.
|
j