Skip to main content

LensStudio:Ui.MessageBox

Class

Dialog for displaying messages or confirmations.

Index

Example

export class MessageBoxPanel extends PanelPlugin {
connections: any[];
static descriptor() {
const d = new Descriptor();
d.id = 'com.docs.UiMessageBoxExample';
d.name = 'MessageBox Example';
d.defaultDockState = DockState.Detached;
d.defaultSize = new Size(350, 200);
return d;
}
constructor(pluginSystem: Editor.PluginSystem, descriptor?: Descriptor) {
super(pluginSystem, descriptor);
this.connections = [];
}
createWidget(parent: Widget): Widget {
const root = new Widget(parent);
const layout = new BoxLayout();
layout.setDirection(Direction.TopToBottom);
layout.spacing = 8;
root.layout = layout;

const title = new Label(root);
title.text = 'MessageBox Demo';
title.fontRole = FontRole.TitleBold;
layout.addWidget(title);

const status = new Label(root);
status.text = 'Click a button to show a message box.';
status.wordWrap = true;
layout.addWidget(status);

const infoBtn = new PushButton(root);
infoBtn.text = 'Show Info';
layout.addWidget(infoBtn);

const questionBtn = new PushButton(root);
questionBtn.text = 'Show Question';
layout.addWidget(questionBtn);

this.connections.push(
infoBtn.onClick.connect(() => {
// MessageBox.information shows an info dialog
MessageBox.information(
'Info',
'Operation completed successfully.',
MessageBox.StandardButton.Ok as unknown as MessageBox.StandardButtons,
MessageBox.StandardButton.Ok
);
status.text = 'Info dialog shown.';
}),
questionBtn.onClick.connect(() => {
// MessageBox.question shows a question dialog with Yes/No
const result = MessageBox.question(
'Confirm',
'Do you want to proceed?',
MessageBox.StandardButton.Yes as unknown as MessageBox.StandardButtons,
MessageBox.StandardButton.Yes
);
status.text = 'Result: ' + (result === MessageBox.StandardButton.Yes ? 'Yes' : 'No');
})
);

return root;
}
deinit(): void {
this.connections.forEach((c: any) => c?.disconnect());
this.connections = [];
}
}

Methods

critical()

static critical(title, text, buttons, defaultButton): StandardButton

Display a critical error message dialog and return the button clicked by the user.

Parameters

ParameterType
titlestring
textstring
buttonsStandardButtons
defaultButtonStandardButton

Returns

StandardButton


information()

static information(title, text, buttons, defaultButton): StandardButton

Display an information message dialog and return the button clicked by the user.

Parameters

ParameterType
titlestring
textstring
buttonsStandardButtons
defaultButtonStandardButton

Returns

StandardButton


question()

static question(title, text, buttons, defaultButton): StandardButton

Display a question dialog and return the button clicked by the user.

Parameters

ParameterType
titlestring
textstring
buttonsStandardButtons
defaultButtonStandardButton

Returns

StandardButton


warning()

static warning(title, text, buttons, defaultButton): StandardButton

Display a warning message dialog and return the button clicked by the user.

Parameters

ParameterType
titlestring
textstring
buttonsStandardButtons
defaultButtonStandardButton

Returns

StandardButton

Nested types

Enumerations

EnumerationDescription
IconIcon enumeration for message box dialogs.
StandardButtonButton option type that can be clicked in a message dialog.

Classes

ClassDescription
StandardButtonsCollection of button options to display in the message dialog.