FormExtensions

Namespace: Wisej.Web.Markup

Assembly: Wisej.Framework (4.0.0.0)

Adds fluent markup extension methods to the Form class.

public class FormExtensions

Public Class FormExtensions

Methods

AcceptButton<TForm>(form, acceptButton)

Sets the accept button for the specified Form control, which is clicked when the user presses the Enter key.

Returns: TForm. The form with the updated accept button.

This method allows you to specify a button that will be activated when the Enter key is pressed, providing a convenient way to submit forms.

myForm.AcceptButton(mySubmitButton);

AutoSize<TForm>(form, autoSize, mode)

Sets the AutoSize property and AutoSizeMode for the specified Form control, enabling or disabling automatic resizing.

Returns: TForm. The form with the updated AutoSize property and mode.

This method allows you to control the automatic resizing behavior of the form based on its contents.

myForm.AutoSize(true, AutoSizeMode.GrowAndShrink);

Sets the cancel button for the specified Form control, which is clicked when the user presses the Esc key.

Returns: TForm. The form with the updated cancel button.

This method allows you to specify a button that will be activated when the Esc key is pressed, providing a convenient way to cancel operations.

myForm.CancelButton(myCancelButton);

Sets the icon for the specified Form control.

Returns: TForm. The form with the updated icon.

This method allows you to specify an image to be displayed as the form's icon in the title bar and taskbar.

myForm.Icon(myIconImage);

Sets the icon for the specified Form control using the provided icon source.

Returns: TForm. The form with the updated icon.

This method allows you to specify an icon for the form by providing a source path or identifier for the icon.

myForm.Icon("path/to/icon.png");

Sets the large icon for the specified Form control.

Returns: TForm. The form with the updated icon.

This method allows you to specify an image to be displayed as the form's icon in the title bar and taskbar.

myForm.Icon(myIconImage);

Sets the large icon for the specified Form control using the provided icon source.

Returns: TForm. The form with the updated large icon.

This method allows you to specify a large icon for the form by providing a source path or identifier for the icon.

myForm.IconLarge("path/to/largeIcon.ico");

Sets the IsMdiContainer property of the form.

Returns: TForm. The form instance with the updated property.

This method allows you to fluently set the IsMdiContainer property.

var form = new Form().IsMdiContainer(true);

Sets the MdiParent property of the form.

Returns: TForm. The form instance with the updated property.

This method allows you to fluently set the MdiParent property.

Attaches an action to the Activated event of a form.

Returns: TForm. The form with the attached Activated event handler.

This method allows you to execute a specific action when the form's Activated event is triggered.

myForm.OnActivated(f => f.Text = "Form Activated");

Attaches an action to the Closed event of a form.

Returns: TForm. The form with the attached Closed event handler.

This method allows you to execute a specific action when the form's Closed event is triggered.

myForm.OnClosed(f => MessageBox.Show("Form Closed"));

Attaches an action to the Closing event of a form.

Returns: TForm. The form with the attached Closing event handler.

This method allows you to execute a specific action when the form's Closing event is triggered, and optionally cancel the closing.

myForm.OnClosing((f, args) => {
if (!ConfirmClose())
args.Cancel = true;
});

Attaches an action to the Deactivate event of a form.

Returns: TForm. The form with the attached Deactivate event handler.

This method allows you to execute a specific action when the form's Deactivate event is triggered.

myForm.OnDeactivate(f => f.Text = "Form Deactivated");

Attaches an action to the Load event of a form.

Returns: TForm. The form with the attached Load event handler.

This method allows you to execute a specific action when the form's Load event is triggered.

myForm.OnLoad(f => f.Text = "Form Loaded");

Subscribes an action to the MdiChildActivate event of the form.

Returns: TForm. The form instance with the event subscription.

This method allows you to fluently subscribe to the MdiChildActivate event.

var form = new Form().OnMdiChildActivate(childForm => Console.WriteLine("MDI Child Activated"));

Sets the ShowInTaskbar property of the form.

Returns: TForm. The form instance with the updated property.

This method allows you to fluently set the ShowInTaskbar property.

Sets the ShowModalMask property of the form.

Returns: TForm. The form instance with the updated property.

This method allows you to fluently set the ShowModalMask property.

Sets the start position for the specified Form control, determining the initial position of the form when it is displayed.

Returns: TForm. The form with the updated start position.

This method allows you to control where the form appears on the screen when it is first shown.

myForm.StartPosition(FormStartPosition.CenterScreen);

Sets the TopLevel property of the form.

Returns: TForm. The form instance with the updated property.

This method allows you to fluently set the TopLevel property.

Sets the window state for the specified Form control.

Returns: TForm. The form with the updated window state.

This method allows you to control the state of the form's window, such as minimized, maximized, or normal.

myForm.WindowState(FormWindowState.Maximized);