ItemOptions class (RadialMenu)

The caption field defines the item's ex-HTML caption. The caption is shown on the "items" portion of the control. The subCaption field defines the item's caption (ex-HTML format, shown under the "sub-items" portion only). You can include pictures in the caption using the <img> tag. For instance, the caption "<img>logo</img>" displays the "logo" image within the item's caption. The "logo" image can be added using the exontrol.HTMLPicture.Add method. The image field specifies the image to be displayed on the "items" portion of the control, while the caption field specifies the caption (ex-HTML format) to be displayed on the "items" portion of the control.

The caption field is mapped to the Item.Caption property, which means that the following statements are equivalent:

oItem.Options = {caption: "font"}
oItem.SetOptions({caption: "font"})
oItem.Caption = "font"
oItem.SetCaption("font")

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

The color field specifies the item's background color displayed in the "items" portion of the control. The subColor field specifies the item's background color in the "sub-items" portion. The shapes field defines the shapes used by each part of the control, allowing customization of its appearance. By default, items are displayed as pie shapes, while on the sub-items layer they appear as ring arcs. No color is applied by default, so the item's background is transparent.

The color field is mapped to the Item.Color property, which means that the following statements are equivalent:

oItem.Options = {color: "red"}
oItem.SetOptions({color: "red"})
oItem.Color = "red"
oItem.SetColor("red")

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

The enabled field indicates whether the item (including the root item) and all its descendent items are enabled or disabled. Setting the enabled field to false disables the item and all its descendent items, while setting it to true enables the item (if its parent is enabled) and all its descendent items. The allowToggleExpand field defines whether the user can expand/collapse the item while it is disabled. By default, the enabled field is set to true, which means that all items are enabled by default.

The enabled field is mapped to the Item.Enabled property, which means that the following statements are equivalent:

oItem.Options = {enabled: false}
oItem.SetOptions({enabled: false})
oItem.Enabled = false
oItem.SetEnabled(false)

false {boolean}, disables the item (including all its descendent items)
true {boolean}, enables the item

The image field specifies the name of the image or picture the item displays ("items" section only). The image can be added using the exontrol.HTMLPicture.Add method. You can also display a picture in the caption field using the <img> ex-HTML tag. The DisplayParentType.imageAlign field specifies the alignment of the image relative to the caption (valid for the content only). The DisplayParentType.imageSize field specifies the aspect-ratio to display the image.

The image field is mapped to the Item.Image property, which means that the following statements are equivalent:

oItem.Options = {image: "logo"}
oItem.SetOptions({image: "logo"})
oItem.Image = "logo"
oItem.SetImage("logo")

null {null}, indicates no image
"logo" {string}, displays the "logo" image

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. For instance, the caption "<fgcolor red>logo</fgcolor>" has the plain-caption "logo". The key can be used to request an item using the Root.Item(key) method.

The key field is mapped to the Item.Key property, which means that the following statements are equivalent:

oItem.Options = {key: "logo"}
oItem.SetOptions({key: "logo"})
oItem.Key = "logo"
oItem.SetKey("logo")

"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.

The parent field retrieves the parent of the item. Use the Item.Parent property to get the parent of an item. The parent of the root item is null, while the parent of any other item is an object of Item type. The parent field is read-only. You can use the Item.Add() method to add a child item to an item, which automatically sets the parent of the child item to the item. The GoBack() method of the control allows you to browse back to the parent of the current browsed item, while the Item() method allows you to request an item giving its key or caption.

The following statements are equivalent:

 oItem.GetParent() {Item}, gets the parent of the item
 oItem.Parent {Item}, gets the parent of the item

where oItem is an object of Item type

The subCaption field defines the item's caption (ex-HTML format, shown under the "sub-items" portion only). The subImage field defines the item's image to be displayed by "sub-items" section only. The caption field is shown on the "items" portion of the control. You can include pictures in the subCaption using the <img> tag. For instance, the subCaption "<img>logo</img>" displays the "logo" image within the item's sub-caption. The "logo" image can be added using the exontrol.HTMLPicture.Add method. The subImage field specifies the image to be displayed on the "sub-items" portion of the control, while the subCaption field specifies the caption (ex-HTML format) to be displayed on the "sub-items" portion of the control.

The subCaption field is mapped to the Item.SubCaption property, which means that the following statements are equivalent:

oItem.Options = {subCaption: "font"}
oItem.SetOptions({subCaption: "font"})
oItem.SubCaption = "font"
oItem.SetSubCaption("font")

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

The subColor field defines the item's background color to be shown on the "sub-items" portion of the control. The color field specifies the item's background color displayed in the "items" portion of the control. The subColor field specifies the item's background color in the "sub-items" portion. The shapes field defines the shapes used by each part of the control, allowing customization of its appearance. By default, items are displayed as pie shapes, while on the sub-items layer they appear as ring arcs. No color is applied by default, so the item's background is transparent.

The subColor field is mapped to the Item.SubColor property, which means that the following statements are equivalent:

oItem.Options = {subColor: "red"}
oItem.SetOptions({subColor: "red"})
oItem.SubColor = "red"
oItem.SetSubColor("red")

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

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. You can also display a picture in the subCaption field using the <img> ex-HTML tag. The DisplayParentType.imageAlign field specifies the alignment of the sub-image relative to the sub-caption (valid for the content only). The DisplayParentType.imageSize field specifies the aspect-ratio to display the sub-image.

The subImage field is mapped to the Item.SubImage property, which means that the following statements are equivalent:

oItem.Options = {subImage: "logo"}
oItem.SetOptions({subImage: "logo"})
oItem.SubImage = "logo"
oItem.SetSubImage("logo")

null {null}, indicates no image
"logo" {string}, displays the "logo" image

The visible field indicates whether the item (excepts the root item, which is always visible) and all its descendent items are visible or hidden. Setting the visible field to false hides the item and all its descendent items, while setting it to true shows the item (if its parent is visible) and all its descendent items. By default, the visible field is set to true, which means that all items are visible by default.

The visible field is mapped to the Item.Visible property, which means that the following statements are equivalent:

oItem.Options = {visible: false}
oItem.SetOptions({visible: false})
oItem.Visible = false
oItem.SetVisible(false)

false {boolean}, hides the item (including all its descendent items)
true {boolean}, shows the item