Documentation

ControlItem
in package

Table of Contents

$Disabled  : bool
$DisabledBackgroundColor  : string
$DisabledForegroundColor  : string
$Id  : string
$ItemBackgroundColor  : string
$ItemForegroundColor  : string
$Name  : string
$Ordering  : int
$Selectable  : bool
__construct()  : mixed
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

$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 = true

Is item visible and allowed to be selected

Methods

__construct()

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

Render()

public Render() : string
Return values
string —

Rendered item

Search results