RenderProperties- Global
The RenderProperties API provides methods to obtain information about the current page and is available in Jelly scripts and in UI-action conditions and scripts.
Access RenderProperties methods using the static variable RP.
Parent Topic:Server API reference
RenderProperties - getEncodedQuery()
Returns the encoded query from the URL sent to the page.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| String | Returns the encoded query from the URL sent to the form. |
The following example is used in a condition for UI action named listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
RP.getEncodedQuery() != null && (RP.getEncodedQuery().indexOf('table=global') < 0 && RP.getEncodedQuery().indexOf('table=') >= 0)
RenderProperties - getListControl()
Returns the list control object for the page.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| SysListControl object | The list control object for the page. |
The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()
RenderProperties - getParameterValue(String parameterName)
Returns the value of the specified URL parameter.
| Name | Type | Description |
|---|---|---|
| parameterName | String | Name of the parameter passed on the URL. |
| Type | Description |
|---|---|
| String | The parameter's value. |
The following example is used in a condition for the Insert and Stay UI action for configuration items listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
current.canCreate() && (!current.instanceOf('task') || gs.getProperty('glide.ui.task.insert') == 'true') && (!current.instanceOf('sys_db_object')) && JSUtil.nil(RP.getParameterValue("sysparm_changeset"))
RenderProperties - getReferringURL()
Returns the URL where the request originated.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| String | The URL of the page where the request originated. |
The following example is used in a condition for the Import Sets UI action for import set row listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
RP.getReferringURL().indexOf("sys_import_set.do") == -1 && new global.ImportSetRowHelper().canReadImportSets();
RenderProperties - getViewID()
Returns the view the page is using.
This method is not available in scoped applications.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| String | The sys_id of the view being used. |
RenderProperties - getViewName()
Returns the name of the view in use.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| String | Name of the view being used. |
The following example is used in a condition named New for action assignment. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
RP.getViewName() != '' && RP.getViewName() != null && RP.getViewName() != undefined
RenderProperties - getWindowProperties()
Returns the window's properties.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| Object | The window's properties |
RenderProperties - isInDevStudio()
Returns true if the page is part of Studio.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| Boolean | Returns true if the page is part of Studio. |
The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()
RenderProperties - isInteractive()
Returns true if this is an interactive session. An interactive session is when a user has logged in as opposed to a REST request.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| Boolean | True if this is an interactive session. |
RenderProperties - isManyToMany()
Returns true when the sysparm_collection_related_file URL parameter is set.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| Boolean | Returns true when the sysparm_collection_related_file URL parameter is set. |
The following example is used in a condition named New for CAB Agenda Items. This UI action is listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
current.canCreate() && !RP.getListControl().isOmitNewButton() && RP.isRelatedList() && !RP.isManyToMany() && !RP.isInDevStudio() && (new sn_change_cab.CABMeeting(parent)).canAddAgendaItem()
RenderProperties - isRelatedList()
Returns true when the sys_is_related_list URL-parameter is true. Returns false if the parameter is not present.
| Name | Type | Description |
|---|---|---|
| None |
| Type | Description |
|---|---|
| Boolean | True if the URL parameter sys_is_related_list is true. |
The following example is used in a condition for a UI action listed in the UI Actions [sys_ui_action] table. See also Defining UI actions.
current.canCreate() && RP.isRelatedList()