Table of Contents

Class GuiEditor

Namespace
AlphaFramework.Editor.Gui
Assembly
AlphaFramework.Editor.dll

Allows a user to design a GUI dialog

public class GuiEditor : UndoCloneTab<Dialog>, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl
Inheritance
GuiEditor
Implements
Inherited Members
Extension Methods

Constructors

GuiEditor(string, bool)

Creates a new GUI editor.

public GuiEditor(string filePath, bool overwrite)

Parameters

filePath string

The path to the file to be edited.

overwrite bool

true if an existing file supposed to be overwritten when SaveFile() is called.

Methods

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true if managed resources should be disposed; otherwise, false.

OnClose()

Called when the tab needs to shutdown and close

protected override void OnClose()

OnDelete()

Hook to delete the currently selected object in this tab

protected override void OnDelete()

OnInitialize()

Called on startup to load the content for this tab from a file

protected override void OnInitialize()

OnSaveFile()

Called when the content of this tab is to be saved to a file.

protected override void OnSaveFile()

Exceptions

ArgumentException

The file path is invalid.

NotSupportedException

The file path is invalid.

IOException

There was a problem writing a file.

UnauthorizedAccessException

Write access to a file was denied.

OnUpdate()

Called on startup, content updates and tab switch to refresh any on-screen displays

protected override void OnUpdate()