Lua:Class:Button

⚠️ Work Needed

This page still needs significant improvements.

Please help by expanding or correcting this article where possible.

For suggestions or discussion, see the talk page.

{} Class

class Button : ButtonControl

The Button class represents a clickable button control.

A Button inherits from ButtonControl, WinControl, Control, Component, and Object. It can be created with createButton and must belong to an owner inherited from WinControl.

Inheritance

Class	Inherits From	Description
Button	ButtonControl	A clickable button control.
ButtonControl	WinControl	Base class for button-like controls.
WinControl	Control	Base class for windowed controls.
Control	Component	Base class for visual controls.
Component	Object	Base class for components.

Creation

<> Lua API Reference

function createButton(owner) : Button

Creates a Button object that belongs to the given owner.

The owner can be any object inherited from WinControl.

Function Parameters

Parameter	Type	Description
owner	WinControl	The owner of the button. This can be any object inherited from WinControl.

Properties

Property	Type	Description
ModalResult	ModalResult	The result this button will give the modal form when clicked.

Methods

Method	Return Type	Description
getModalResult(button)	ModalResult	Returns the ModalResult value of the specified button.
setModalResult(button, mr)	void	Sets the ModalResult value of the specified button.

Examples

local form = createForm()
form.Caption = "Button Example"

local button = createButton(form)
button.Parent = form
button.Caption = "Close"
button.Left = 20
button.Top = 20
button.Width = 100

button.ModalResult = mrOK

form.showModal()
form.destroy()

local form = createForm()
form.Caption = "Button Example"

local button = createButton(form)
button.Parent = form
button.Caption = "OK"

setModalResult(button, mrOK)

print("ModalResult: " .. tostring(getModalResult(button)))

form.destroy()

Main Pages

Core Lua documentation entry points

◆ Lua
◆ Script Engine