Class MenuItem

Namespace

PolarStudio

Assembly

PolarStudio.dll

This class is the representation of a menu item in the Polar Studio menu.

public class MenuItem

Inheritance

object

MenuItem

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Globals.IsNumericType(object)

Properties

CaptionTC

The caption to show for the menu item.

public string CaptionTC { get; }

Property Value

string

ExplanationTC

An explanation as can be shown in a mouse-over event for the menu item.

public string ExplanationTC { get; }

Property Value

string

IconTC

The IconTC property is not formally used, but it can be used in scripts to create menu's with icons.

public string IconTC { get; }

Property Value

string

MenuItemID

The ID of the menu item, as is also used for performing an action from the browser.

public int MenuItemID { get; }

Property Value

int

MenuItemType

The type of menu item. Is one of: SubMenu, Table, Form, SystemForm, Script, PlainText, Custom

public string MenuItemType { get; }

Property Value

string

Name

The name of the menu item. Is not formally used.

public string Name { get; }

Property Value

string

ScriptExpression

The ScriptExpression contains the action to perform for custom menu items. It can contain a script expression to fire server-side. It can also be like 'Action;ActionParameter' to fire an action in the browser. Alternatively it can contain an expression like '@JavaScriptExpression'

public string ScriptExpression { get; }

Property Value

string

ShortCaptionTC

The ShortCaptionTC property is not formally used, but it can be used in scripts, for example to create shorter captions for mobile devices.

public string ShortCaptionTC { get; }

Property Value

string

SubItems

In case this menu item is a SubMenu, the menu items contained in this sub menu are retrieved using SubItems

public MenuItems SubItems { get; }

Property Value

MenuItems

SysApplicationID

The SysApplicationID that refers to the application this menu item is part of.

public int SysApplicationID { get; }

Property Value

int

SysFormID

In case of a menu item of type 'Form' the SysFormID sets the form that is to be opened.

public int SysFormID { get; }

Property Value

int

SysTableID

In case of a menu item of type 'Table' the SysTableID sets the table that is to be opened.

public int SysTableID { get; }

Property Value

int

SystemFormName

In case of a menu item of type 'SystemForm' the SystemFormName indicates the system form to open or the system action to perform.

public string SystemFormName { get; }

Property Value

string

Visible

A boolean (read/write) indicating this menu item is visible.

public bool Visible { get; set; }

Property Value

bool

Methods

IsVisible()

This method returns True if the item is visible. For menu's False will be returned if the menu does not contain any visible element.

public bool IsVisible()

Returns

bool

A boolean indicating the menu item is visible.