ItemOptions class (RadialMenu)

RadialMenu.ItemOptions()

new ItemOptions()

The RadialMenu.ItemOptions structure contains options that an item of RadialMenu control can handle

Every option of the RadialMenu.ItemOptions type has associated a property of the Item object. For instance, the option:

caption {string}, defines the item's caption
is associated with the property:
Caption {string}, defines the item's caption
which means that the following statements are equivalent:
oItem.Options = {caption: "font"}
oItem.SetOptions({caption: "font"})
oItem.Caption = "font"
oItem.SetCaption("font")
where oItem is an object of Item type
ItemOptions

Members

(static) caption :string

The caption field defines the item's caption. It supports ex-HTML format, and it is applied to "items" section only.
Type:
  • string
Example
null {null}, indicates no caption
 "caption" {string}, declares a plain-caption
 "<b>text</b>" {string}, displays the text in bold
 "<img>logo</img>" {string}, displays the "logo" image. The image can be added using the exontrol.HTMLPicture.Add() method
caption

(static) color :string

The color field defines the item's background color to be shown on the "items" portion of the control.
Type:
  • string
Example
null {null}, indicates no color
 "red" {string}, defines a red-pie
 "rgb(255,0,0)" {string}, defines a red-pie
 "rgba(255,0,0,0.5)" {string}, defines a 50% red-pie
color

(static) enabled :boolean

The enabled field indicates whether the item is enabled or disabled.
Type:
  • boolean
Example
false {boolean}, disables the item (including all its descendent items)
 true {boolean}, enables the item
enabled

(static) image :string

The image field specifies the name of the image/picture the item displays ("items" section only). The image can be added using the exontrol.HTMLPicture.Add() method.
Type:
  • string
Example
null {null}, indicates no image
 "logo" {string}, displays the "logo" image
image

(static) key :string

The key field specifies the key associated with the item. Specifies the key associated with the item. If no key is provided, the item's plain-caption can be used to request an item. The plain-caption includes no ex-HTML tags, such as <b>, <fgcolor> and so on.
Type:
  • string
Example
"logo" {string}, defines the item with the giving key (logo). You can use the Root.Item("logo") method to request the item giving its key.
key

(static) parent :Item

The parent field retrieves the parent of the item.
Type:
Since:
  • 2.4
parent

(static) subCaption :string

The subCaption field defines the item's caption (ex-HTML format, shown under the "sub-items" portion only).
Type:
  • string
Example
null {null}, indicates no caption
 "caption" {string}, declares a plain-caption
 "&lt;b>text&lt;/b>" {string}, displays the text in bold
 "&lt;img>logo&lt;/img>" {string}, displays the "logo" image. The image can be added using the exontrol.HTMLPicture.Add() method
subCaption

(static) subColor :string

The subColor field defines the item's background color to be shown on the "sub-items" portion of the control.
Type:
  • string
Example
null {null}, indicates no color
 "red" {string}, defines a red-pie
 "rgb(255,0,0)" {string}, defines a red-pie
 "rgba(255,0,0,0.5)" {string}, defines a 50% red-pie
subColor

(static) subImage :string

The subImage field defines the item's image to be displayed by "sub-items" section only. The image can be added using the exontrol.HTMLPicture.Add() method.
Type:
  • string
Example
null {null}, indicates no image
 "logo" {string}, displays the "logo" image
subImage

(static) visible :boolean

The visible field indicates whether the item (and all its descendent items) is visible or hidden.
Type:
  • boolean
Example
false {boolean}, hides the item (including all its descendent items)
 true {boolean}, shows the item
visible