Skip to main content

LensStudio:Ui.MessageBox.StandardButton

Enum

Button option type that can be clicked in a message dialog.

Index

Example

export class MessageBoxStandardButtonPanel extends PanelPlugin {
connections: any[];
static descriptor() {
const d = new Descriptor();
d.id = 'com.docs.UiMessageBoxStandardButtonExample';
d.name = 'MessageBox StandardButton';
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 = 'StandardButton Enum';
title.fontRole = FontRole.TitleBold;
layout.addWidget(title);

const status = new Label(root);
status.text = 'Shows which StandardButton the user clicked.';
status.wordWrap = true;
layout.addWidget(status);

const btn = new PushButton(root);
btn.text = 'Ask Yes/No';
layout.addWidget(btn);

this.connections.push(
btn.onClick.connect(() => {
// StandardButton enum: Ok, Save, Yes, No, Cancel, Discard, etc.
const result = MessageBox.question(
'Confirm',
'Save changes before closing?',
MessageBox.StandardButton.Yes as unknown as MessageBox.StandardButtons,
MessageBox.StandardButton.Yes
);
if (result === MessageBox.StandardButton.Yes) {
status.text = 'User clicked: Yes';
} else if (result === MessageBox.StandardButton.No) {
status.text = 'User clicked: No';
} else {
status.text = 'User clicked: Cancel';
}
})
);

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

Enumeration Members

Abort

Abort: number

Abort button.


Apply

Apply: number

Apply button.


Cancel

Cancel: number

Cancel button.


Close

Close: number

Close button.


Discard

Discard: number

Discard button.


Help

Help: number

Help button.


Ignore

Ignore: number

Ignore button.


No

No: number

No button.


NoButton

NoButton: number

No button.


NoToAll

NoToAll: number

No to all button.


Ok

Ok: number

OK button.


Open

Open: number

Open button.


Reset

Reset: number

Reset button.


RestoreDefaults

RestoreDefaults: number

Restore defaults button.


Retry

Retry: number

Retry button.


Save

Save: number

Save button.


SaveAll

SaveAll: number

Save all button.


Yes

Yes: number

Yes button.


YesToAll

YesToAll: number

Yes to all button.