Documentation

MenuBoxDelimiter extends ListBoxDelimiter
in package

Using to delimit MenuBox items

Table of Contents

$Character  : string
$Disabled  : bool
$DisabledBackgroundColor  : string
$DisabledForegroundColor  : string
$Hint  : string
$HintBackgroundColor  : string
$HintForegroundColor  : string
$Id  : string
$ItemBackgroundColor  : string
$ItemForegroundColor  : string
$Length  : int
$Name  : string
$Ordering  : int
$Selectable  : bool
$Visible  : bool
__construct()  : mixed
GetMenuBox()  : MenuBox|null
Remove()  : void
Removes element from current MenuBox
Render()  : string
SetItemStyle()  : ControlItem
Set style for item

Properties

$Disabled

public bool $Disabled = false

Is item disabled

$DisabledBackgroundColor

public string $DisabledBackgroundColor = \Data\String\BackgroundColors::AUTO

Text's background color when item disabled

$DisabledForegroundColor

public string $DisabledForegroundColor = \Data\String\ForegroundColors::AUTO

Text's color when item disabled

$Hint

public string $Hint = ""

Item's hint. Display when item is selected

$HintBackgroundColor

public string $HintBackgroundColor = \Data\String\BackgroundColors::AUTO

Hint background color

$HintForegroundColor

public string $HintForegroundColor = \Data\String\ForegroundColors::DARK_RED

Hint foreground color

$Id

public string $Id = ""

Any value here. ID is not using anywhere except your code

$ItemBackgroundColor

public string $ItemBackgroundColor = \Data\String\BackgroundColors::AUTO

Text's background color

$ItemForegroundColor

public string $ItemForegroundColor = \Data\String\ForegroundColors::AUTO

Text's color

$Selectable

public bool $Selectable = false

(always FALSE) Element cannot be selected because it's not clickable

Methods

__construct()

public __construct([string $name = "" ][, string $hint = "" ]) : mixed
Parameters
$name : string = ""
$hint : string = ""
Return values
mixed —

Remove()

Removes element from current MenuBox

public Remove() : void
Return values
void —

Render()

public Render() : string
Return values
string —

Rendered item

Search results