RCMenuLayout Class Properties

In this section, the RCMenuLayout class properties are presented in alphabetical order.

Description

Use the IsNew property to return a boolean value indicating whether the menu layout is a new configuration. This property returns True after calling CloneForNew to update the target menu layout object.

Note: This property returns False after instantiating a new menu layout object with either AddPageFieldMenu or CloneForNewFull.

This property is read-only.

Description

Use the LanguageCD property to set or return the language code for this menu layout as a three-character string.

This property is read/write.

Example

&rcMenuLayout.LanguageCD = "GER";

Description

Use the MenuId property to return the ID for this menu layout as a string value in the following format:

PAGE_NAME.field_ID

This property is set by the CloneForNewFull method and the AddPageFieldMenu method of the RCServiceConfig class.

This property is effectively read-only.

Example

Local string &menu_ID = &rcMenuLayout.MenuId; 

Description

Use the MenuType property to return the type of menu as a string value:

Value

Description

FLDM

Page field level related action and related content configuration.

MMNU

Component level related action configuration.

PGBM

Pivot grid related action configuration.

RCMU

Component level related content menu configuration.

This property is set by the AddPageFieldMenu method of the RCServiceConfig class.

This property is effectively read-only.

Example

Local String &sMenu_Type = &rcMenuLayout.MenuType;

Description

Use the PnlFldName property to return the mapped data value as a string value. The value specified—for example, the page field name, key field name, fixed value, system variable, and so on—depends on the value of the MapFieldType property of the RCMapFields class.

This property is read/write.

Description

Use the PnlName property to return the page name as a string value. This property is set in the RCMapFields object and is only required when the value of the MapFieldType property is set to PF (page field); otherwise, it is an empty string.

This property is effectively read-only.

Example

Local String &pg_name = &rcMenuLayout.PnlName;

Description

Use the PortalName property to return the portal specified for this menu layout as a string value.

This property is set by the AddPageFieldMenu method of the RCServiceConfig class.

This property is effectively read-only.

Example

Local string &portal_name = &rcMenuLayout.PortalName;

Description

Use the PortalObjName property to return the content reference ID (portal object name) specified for this menu layout as a string value.

This property is set by the AddPageFieldMenu method of the RCServiceConfig class.

This property is effectively read-only.

Example

Local string &CREF_ID = &rcMenuLayout.PortalObjName;