diff --git a/ElectronNET.API/App.cs b/ElectronNET.API/App.cs index e4849ad..d1b39dd 100644 --- a/ElectronNET.API/App.cs +++ b/ElectronNET.API/App.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// Control your application's event lifecycle. + /// public sealed class App { /// @@ -1334,7 +1337,7 @@ namespace ElectronNET.API return await taskCompletionSource.Task; } - // TODO: Menu lösung muss gemacht werden und imeplementiert + // TODO: Menu lösung für macOS muss gemacht werden und imeplementiert /// /// Sets the application's dock menu. /// diff --git a/ElectronNET.API/BridgeSettings.cs b/ElectronNET.API/BridgeSettings.cs index 2f32157..96a2653 100644 --- a/ElectronNET.API/BridgeSettings.cs +++ b/ElectronNET.API/BridgeSettings.cs @@ -1,8 +1,24 @@ namespace ElectronNET.API { + /// + /// + /// public static class BridgeSettings { - public static string SocketPort { get; set; } - public static string WebPort { get; set; } + /// + /// Gets the socket port. + /// + /// + /// The socket port. + /// + public static string SocketPort { get; internal set; } + + /// + /// Gets the web port. + /// + /// + /// The web port. + /// + public static string WebPort { get; internal set; } } } diff --git a/ElectronNET.API/BrowserWindow.cs b/ElectronNET.API/BrowserWindow.cs index 77ccedf..bd4d0f6 100644 --- a/ElectronNET.API/BrowserWindow.cs +++ b/ElectronNET.API/BrowserWindow.cs @@ -10,8 +10,17 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// Create and control browser windows. + /// public class BrowserWindow { + /// + /// Gets the identifier. + /// + /// + /// The identifier. + /// public int Id { get; private set; } /// @@ -1112,6 +1121,10 @@ namespace ElectronNET.API BridgeConnector.Socket.Emit("browserWindowSetBounds", Id, JObject.FromObject(bounds, _jsonSerializer), animate); } + /// + /// Gets the bounds asynchronous. + /// + /// public Task GetBoundsAsync() { var taskCompletionSource = new TaskCompletionSource(); @@ -1146,6 +1159,10 @@ namespace ElectronNET.API BridgeConnector.Socket.Emit("browserWindowSetContentBounds", Id, JObject.FromObject(bounds, _jsonSerializer), animate); } + /// + /// Gets the content bounds asynchronous. + /// + /// public Task GetContentBoundsAsync() { var taskCompletionSource = new TaskCompletionSource(); @@ -1166,7 +1183,6 @@ namespace ElectronNET.API /// /// /// - /// public void SetSize(int width, int height) { BridgeConnector.Socket.Emit("browserWindowSetSize", Id, width, height); @@ -1207,7 +1223,6 @@ namespace ElectronNET.API /// /// /// - /// public void SetContentSize(int width, int height) { BridgeConnector.Socket.Emit("browserWindowSetContentSize", Id, width, height); @@ -1742,11 +1757,17 @@ namespace ElectronNET.API return taskCompletionSource.Task; } + /// + /// Focuses the on web view. + /// public void FocusOnWebView() { BridgeConnector.Socket.Emit("browserWindowFocusOnWebView", Id); } + /// + /// Blurs the web view. + /// public void BlurWebView() { BridgeConnector.Socket.Emit("browserWindowBlurWebView", Id); @@ -1781,7 +1802,13 @@ namespace ElectronNET.API BridgeConnector.Socket.Emit("browserWindowReload", Id); } - public IReadOnlyCollection Items { get { return _items.AsReadOnly(); } } + /// + /// Gets the menu items. + /// + /// + /// The menu items. + /// + public IReadOnlyCollection MenuItems { get { return _items.AsReadOnly(); } } private List _items = new List(); /// @@ -1804,7 +1831,7 @@ namespace ElectronNET.API /// /// Sets progress value in progress bar. Valid range is [0, 1.0]. Remove progress - /// bar when progress < 0; Change to indeterminate mode when progress > 1. On Linux + /// bar when progress smaler as 0; Change to indeterminate mode when progress bigger as 1. On Linux /// platform, only supports Unity desktop environment, you need to specify the /// .desktop file name to desktopName field in package.json.By default, it will /// assume app.getName().desktop.On Windows, a mode can be passed.Accepted values @@ -1820,7 +1847,7 @@ namespace ElectronNET.API /// /// Sets progress value in progress bar. Valid range is [0, 1.0]. Remove progress - /// bar when progress < 0; Change to indeterminate mode when progress > 1. On Linux + /// bar when progress smaler as 0; Change to indeterminate mode when progress bigger as 1. On Linux /// platform, only supports Unity desktop environment, you need to specify the /// .desktop file name to desktopName field in package.json.By default, it will /// assume app.getName().desktop.On Windows, a mode can be passed.Accepted values @@ -1865,6 +1892,12 @@ namespace ElectronNET.API return taskCompletionSource.Task; } + /// + /// Gets the thumbar buttons. + /// + /// + /// The thumbar buttons. + /// public IReadOnlyCollection ThumbarButtons { get { return _thumbarButtons.AsReadOnly(); } } private List _thumbarButtons = new List(); @@ -2054,7 +2087,7 @@ namespace ElectronNET.API /// On macOS it sets the NSWindow’s sharingType to NSWindowSharingNone. /// On Windows it calls SetWindowDisplayAffinity with WDA_MONITOR. /// - /// + /// public void SetContentProtection(bool enable) { BridgeConnector.Socket.Emit("browserWindowSetContentProtection", Id, enable); @@ -2073,7 +2106,7 @@ namespace ElectronNET.API /// Sets parent as current window’s parent window, /// passing null will turn current window into a top-level window. /// - /// + /// public void SetParentWindow(BrowserWindow parent) { BridgeConnector.Socket.Emit("browserWindowSetParentWindow", Id, JObject.FromObject(parent, _jsonSerializer)); diff --git a/ElectronNET.API/Dialog.cs b/ElectronNET.API/Dialog.cs index e1716a2..053837d 100644 --- a/ElectronNET.API/Dialog.cs +++ b/ElectronNET.API/Dialog.cs @@ -7,6 +7,9 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// Display native system dialogs for opening and saving files, alerting, etc. + /// public sealed class Dialog { private static Dialog _dialog; diff --git a/ElectronNET.API/Electron.cs b/ElectronNET.API/Electron.cs index 8e273d7..064ef98 100644 --- a/ElectronNET.API/Electron.cs +++ b/ElectronNET.API/Electron.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API { + /// + /// The Electron.NET API + /// public static class Electron { /// diff --git a/ElectronNET.API/Entities/AboutPanelOptions.cs b/ElectronNET.API/Entities/AboutPanelOptions.cs index db47d7e..4c17513 100644 --- a/ElectronNET.API/Entities/AboutPanelOptions.cs +++ b/ElectronNET.API/Entities/AboutPanelOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class AboutPanelOptions { /// diff --git a/ElectronNET.API/Entities/AppDetailsOptions.cs b/ElectronNET.API/Entities/AppDetailsOptions.cs index e05417c..55a92e9 100644 --- a/ElectronNET.API/Entities/AppDetailsOptions.cs +++ b/ElectronNET.API/Entities/AppDetailsOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class AppDetailsOptions { /// diff --git a/ElectronNET.API/Entities/BrowserWindowOptions.cs b/ElectronNET.API/Entities/BrowserWindowOptions.cs index 3a7e15d..e72c29f 100644 --- a/ElectronNET.API/Entities/BrowserWindowOptions.cs +++ b/ElectronNET.API/Entities/BrowserWindowOptions.cs @@ -4,6 +4,9 @@ using System.ComponentModel; namespace ElectronNET.API.Entities { + /// + /// + /// public class BrowserWindowOptions { /// diff --git a/ElectronNET.API/Entities/CPUUsage.cs b/ElectronNET.API/Entities/CPUUsage.cs index 0fb461a..f76324d 100644 --- a/ElectronNET.API/Entities/CPUUsage.cs +++ b/ElectronNET.API/Entities/CPUUsage.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class CPUUsage { /// diff --git a/ElectronNET.API/Entities/Certificate.cs b/ElectronNET.API/Entities/Certificate.cs index 957ce5b..646c126 100644 --- a/ElectronNET.API/Entities/Certificate.cs +++ b/ElectronNET.API/Entities/Certificate.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class Certificate { /// diff --git a/ElectronNET.API/Entities/CertificatePrincipal.cs b/ElectronNET.API/Entities/CertificatePrincipal.cs index 8691c96..0b1245a 100644 --- a/ElectronNET.API/Entities/CertificatePrincipal.cs +++ b/ElectronNET.API/Entities/CertificatePrincipal.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class CertificatePrincipal { /// diff --git a/ElectronNET.API/Entities/CertificateTrustDialogOptions.cs b/ElectronNET.API/Entities/CertificateTrustDialogOptions.cs index ed5729d..9a3bfda 100644 --- a/ElectronNET.API/Entities/CertificateTrustDialogOptions.cs +++ b/ElectronNET.API/Entities/CertificateTrustDialogOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class CertificateTrustDialogOptions { /// diff --git a/ElectronNET.API/Entities/Data.cs b/ElectronNET.API/Entities/Data.cs index 06ead56..2dcca89 100644 --- a/ElectronNET.API/Entities/Data.cs +++ b/ElectronNET.API/Entities/Data.cs @@ -1,9 +1,33 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class Data { + /// + /// Gets or sets the text. + /// + /// + /// The text. + /// public string Text { get; set; } + + /// + /// Gets or sets the HTML. + /// + /// + /// The HTML. + /// public string Html { get; set; } + + + /// + /// Gets or sets the RTF. + /// + /// + /// The RTF. + /// public string Rtf { get; set; } /// diff --git a/ElectronNET.API/Entities/DefaultFontFamily.cs b/ElectronNET.API/Entities/DefaultFontFamily.cs index d178a9d..105d205 100644 --- a/ElectronNET.API/Entities/DefaultFontFamily.cs +++ b/ElectronNET.API/Entities/DefaultFontFamily.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class DefaultFontFamily { /// diff --git a/ElectronNET.API/Entities/DevToolsMode.cs b/ElectronNET.API/Entities/DevToolsMode.cs index b99af27..7290d8c 100644 --- a/ElectronNET.API/Entities/DevToolsMode.cs +++ b/ElectronNET.API/Entities/DevToolsMode.cs @@ -7,9 +7,24 @@ /// public enum DevToolsMode { + /// + /// The right + /// right, + + /// + /// The bottom + /// bottom, + + /// + /// The undocked + /// undocked, + + /// + /// The detach + /// detach } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/Display.cs b/ElectronNET.API/Entities/Display.cs index 0e2b311..cdf9ac8 100644 --- a/ElectronNET.API/Entities/Display.cs +++ b/ElectronNET.API/Entities/Display.cs @@ -1,6 +1,4 @@ -using Newtonsoft.Json; - -namespace ElectronNET.API.Entities +namespace ElectronNET.API.Entities { /// /// @@ -8,8 +6,11 @@ namespace ElectronNET.API.Entities public class Display { /// - /// + /// Gets or sets the bounds. /// + /// + /// The bounds. + /// public Rectangle Bounds { get; set; } /// @@ -28,8 +29,11 @@ namespace ElectronNET.API.Entities public int ScaleFactor { get; set; } /// - /// + /// Gets or sets the size. /// + /// + /// The size. + /// public Size Size { get; set; } /// @@ -38,13 +42,19 @@ namespace ElectronNET.API.Entities public string TouchSupport { get; set; } /// - /// + /// Gets or sets the work area. /// + /// + /// The work area. + /// public Rectangle WorkArea { get; set; } /// - /// + /// Gets or sets the size of the work area. /// + /// + /// The size of the work area. + /// public Size WorkAreaSize { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/DisplayBalloonOptions.cs b/ElectronNET.API/Entities/DisplayBalloonOptions.cs index da59480..c223511 100644 --- a/ElectronNET.API/Entities/DisplayBalloonOptions.cs +++ b/ElectronNET.API/Entities/DisplayBalloonOptions.cs @@ -1,9 +1,32 @@ namespace ElectronNET.API { + /// + /// + /// public class DisplayBalloonOptions { + /// + /// Gets or sets the icon. + /// + /// + /// The icon. + /// public string Icon { get; set; } + + /// + /// Gets or sets the title. + /// + /// + /// The title. + /// public string Title { get; set; } + + /// + /// Gets or sets the content. + /// + /// + /// The content. + /// public string Content { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/DockBounceType.cs b/ElectronNET.API/Entities/DockBounceType.cs index 5af53ed..d3d0b82 100644 --- a/ElectronNET.API/Entities/DockBounceType.cs +++ b/ElectronNET.API/Entities/DockBounceType.cs @@ -1,8 +1,18 @@ namespace ElectronNET.API { + /// + /// + /// public enum DockBounceType { + /// + /// The critical + /// critical, + + /// + /// The informational + /// informational } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/Error.cs b/ElectronNET.API/Entities/Error.cs index 69def9c..33d7ed4 100644 --- a/ElectronNET.API/Entities/Error.cs +++ b/ElectronNET.API/Entities/Error.cs @@ -1,7 +1,16 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class Error { + /// + /// Gets or sets the stack. + /// + /// + /// The stack. + /// public string Stack { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/FileFilter.cs b/ElectronNET.API/Entities/FileFilter.cs index fa15bbf..3f573ed 100644 --- a/ElectronNET.API/Entities/FileFilter.cs +++ b/ElectronNET.API/Entities/FileFilter.cs @@ -1,8 +1,24 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class FileFilter { + /// + /// Gets or sets the extensions. + /// + /// + /// The extensions. + /// public string[] Extensions { get; set; } + + /// + /// Gets or sets the name. + /// + /// + /// The name. + /// public string Name { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/FileIconOptions.cs b/ElectronNET.API/Entities/FileIconOptions.cs index 4293a0a..f2e1d25 100644 --- a/ElectronNET.API/Entities/FileIconOptions.cs +++ b/ElectronNET.API/Entities/FileIconOptions.cs @@ -1,9 +1,22 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class FileIconOptions { + /// + /// Gets the size. + /// + /// + /// The size. + /// public string Size { get; private set; } + /// + /// Initializes a new instance of the class. + /// + /// Size of the file icon. public FileIconOptions(FileIconSize fileIconSize) { Size = fileIconSize.ToString(); diff --git a/ElectronNET.API/Entities/FileIconSize.cs b/ElectronNET.API/Entities/FileIconSize.cs index 7841ee8..75430d6 100644 --- a/ElectronNET.API/Entities/FileIconSize.cs +++ b/ElectronNET.API/Entities/FileIconSize.cs @@ -1,9 +1,23 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum FileIconSize { + /// + /// The small + /// small, + + /// + /// The normal + /// normal, + + /// + /// The large + /// large } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/GPUFeatureStatus.cs b/ElectronNET.API/Entities/GPUFeatureStatus.cs index a21aac5..a252191 100644 --- a/ElectronNET.API/Entities/GPUFeatureStatus.cs +++ b/ElectronNET.API/Entities/GPUFeatureStatus.cs @@ -2,6 +2,9 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class GPUFeatureStatus { /// diff --git a/ElectronNET.API/Entities/HighlightMode.cs b/ElectronNET.API/Entities/HighlightMode.cs index 19dc276..f5f810c 100644 --- a/ElectronNET.API/Entities/HighlightMode.cs +++ b/ElectronNET.API/Entities/HighlightMode.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum HighlightMode { /// diff --git a/ElectronNET.API/Entities/ImportCertificateOptions.cs b/ElectronNET.API/Entities/ImportCertificateOptions.cs index 779992c..cb8775a 100644 --- a/ElectronNET.API/Entities/ImportCertificateOptions.cs +++ b/ElectronNET.API/Entities/ImportCertificateOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class ImportCertificateOptions { /// diff --git a/ElectronNET.API/Entities/JumpListCategory.cs b/ElectronNET.API/Entities/JumpListCategory.cs index e52e5f8..0a1f54c 100644 --- a/ElectronNET.API/Entities/JumpListCategory.cs +++ b/ElectronNET.API/Entities/JumpListCategory.cs @@ -4,6 +4,9 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API { + /// + /// + /// public class JumpListCategory { /// diff --git a/ElectronNET.API/Entities/JumpListCategoryType.cs b/ElectronNET.API/Entities/JumpListCategoryType.cs index 9c00bf8..4b96112 100644 --- a/ElectronNET.API/Entities/JumpListCategoryType.cs +++ b/ElectronNET.API/Entities/JumpListCategoryType.cs @@ -1,10 +1,28 @@ namespace ElectronNET.API { + /// + /// + /// public enum JumpListCategoryType { + /// + /// The tasks + /// tasks, + + /// + /// The frequent + /// frequent, + + /// + /// The recent + /// recent, + + /// + /// The custom + /// custom } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/JumpListItem.cs b/ElectronNET.API/Entities/JumpListItem.cs index d9258b3..0341c8a 100644 --- a/ElectronNET.API/Entities/JumpListItem.cs +++ b/ElectronNET.API/Entities/JumpListItem.cs @@ -3,6 +3,9 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API.Entities { + /// + /// + /// public class JumpListItem { /// diff --git a/ElectronNET.API/Entities/JumpListItemType.cs b/ElectronNET.API/Entities/JumpListItemType.cs index 049834c..6bc2382 100644 --- a/ElectronNET.API/Entities/JumpListItemType.cs +++ b/ElectronNET.API/Entities/JumpListItemType.cs @@ -1,9 +1,23 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum JumpListItemType { + /// + /// The task + /// task, + + /// + /// The separator + /// separator, + + /// + /// The file + /// file } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/JumpListSettings.cs b/ElectronNET.API/Entities/JumpListSettings.cs index b7964cd..e56c151 100644 --- a/ElectronNET.API/Entities/JumpListSettings.cs +++ b/ElectronNET.API/Entities/JumpListSettings.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class JumpListSettings { /// diff --git a/ElectronNET.API/Entities/LoadURLOptions.cs b/ElectronNET.API/Entities/LoadURLOptions.cs index bd897ab..f332a77 100644 --- a/ElectronNET.API/Entities/LoadURLOptions.cs +++ b/ElectronNET.API/Entities/LoadURLOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class LoadURLOptions { /// diff --git a/ElectronNET.API/Entities/LoginItemSettings.cs b/ElectronNET.API/Entities/LoginItemSettings.cs index 67e9535..c30ede6 100644 --- a/ElectronNET.API/Entities/LoginItemSettings.cs +++ b/ElectronNET.API/Entities/LoginItemSettings.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class LoginItemSettings { /// diff --git a/ElectronNET.API/Entities/LoginItemSettingsOptions.cs b/ElectronNET.API/Entities/LoginItemSettingsOptions.cs index aee888d..bd23d45 100644 --- a/ElectronNET.API/Entities/LoginItemSettingsOptions.cs +++ b/ElectronNET.API/Entities/LoginItemSettingsOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class LoginItemSettingsOptions { /// diff --git a/ElectronNET.API/Entities/LoginSettings.cs b/ElectronNET.API/Entities/LoginSettings.cs index aec8203..b48011e 100644 --- a/ElectronNET.API/Entities/LoginSettings.cs +++ b/ElectronNET.API/Entities/LoginSettings.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class LoginSettings { /// diff --git a/ElectronNET.API/Entities/MemoryInfo.cs b/ElectronNET.API/Entities/MemoryInfo.cs index f31423b..ec79121 100644 --- a/ElectronNET.API/Entities/MemoryInfo.cs +++ b/ElectronNET.API/Entities/MemoryInfo.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class MemoryInfo { /// diff --git a/ElectronNET.API/Entities/MenuItem.cs b/ElectronNET.API/Entities/MenuItem.cs index 983dcff..5a58d7a 100644 --- a/ElectronNET.API/Entities/MenuItem.cs +++ b/ElectronNET.API/Entities/MenuItem.cs @@ -4,6 +4,9 @@ using System; namespace ElectronNET.API.Entities { + /// + /// + /// public class MenuItem { /// @@ -27,15 +30,39 @@ namespace ElectronNET.API.Entities public MenuType Type { get; set; } + /// + /// Gets or sets the label. + /// + /// + /// The label. + /// public string Label { get; set; } + /// + /// Gets or sets the sublabel. + /// + /// + /// The sublabel. + /// public string Sublabel { get; set; } + /// + /// Gets or sets the accelerator. + /// + /// + /// The accelerator. + /// public string Accelerator { get; set; } + /// + /// Gets or sets the icon. + /// + /// + /// The icon. + /// public string Icon { get; set; } /// diff --git a/ElectronNET.API/Entities/MenuRole.cs b/ElectronNET.API/Entities/MenuRole.cs index a1f8962..0e5673f 100644 --- a/ElectronNET.API/Entities/MenuRole.cs +++ b/ElectronNET.API/Entities/MenuRole.cs @@ -1,14 +1,48 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum MenuRole { + /// + /// The undo + /// undo, + + /// + /// The redo + /// redo, + + /// + /// The cut + /// cut, + + /// + /// The copy + /// copy, + + /// + /// The paste + /// paste, + + /// + /// The pasteandmatchstyle + /// pasteandmatchstyle, + + /// + /// The selectall + /// selectall, + + /// + /// The delete + /// delete, /// diff --git a/ElectronNET.API/Entities/MenuType.cs b/ElectronNET.API/Entities/MenuType.cs index 704f888..9da110c 100644 --- a/ElectronNET.API/Entities/MenuType.cs +++ b/ElectronNET.API/Entities/MenuType.cs @@ -1,11 +1,33 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum MenuType { + /// + /// The normal + /// normal, + + /// + /// The separator + /// separator, + + /// + /// The submenu + /// submenu, + + /// + /// The checkbox + /// checkbox, + + /// + /// The radio + /// radio } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/MessageBoxOptions.cs b/ElectronNET.API/Entities/MessageBoxOptions.cs index ba652d7..ccb405b 100644 --- a/ElectronNET.API/Entities/MessageBoxOptions.cs +++ b/ElectronNET.API/Entities/MessageBoxOptions.cs @@ -3,6 +3,9 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API.Entities { + /// + /// + /// public class MessageBoxOptions { /// @@ -51,6 +54,12 @@ namespace ElectronNET.API.Entities /// public bool CheckboxChecked { get; set; } + /// + /// Gets or sets the icon. + /// + /// + /// The icon. + /// public string Icon { get; set; } /// @@ -80,6 +89,10 @@ namespace ElectronNET.API.Entities /// public bool NormalizeAccessKeys { get; set; } + /// + /// Initializes a new instance of the class. + /// + /// The message. public MessageBoxOptions(string message) { Message = message; diff --git a/ElectronNET.API/Entities/MessageBoxResult.cs b/ElectronNET.API/Entities/MessageBoxResult.cs index 20a19b6..835c292 100644 --- a/ElectronNET.API/Entities/MessageBoxResult.cs +++ b/ElectronNET.API/Entities/MessageBoxResult.cs @@ -1,9 +1,24 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class MessageBoxResult { + /// + /// Gets or sets the response. + /// + /// + /// The response. + /// public int Response { get; set; } + /// + /// Gets or sets a value indicating whether [checkbox checked]. + /// + /// + /// true if [checkbox checked]; otherwise, false. + /// public bool CheckboxChecked { get; set; } } } diff --git a/ElectronNET.API/Entities/MessageBoxType.cs b/ElectronNET.API/Entities/MessageBoxType.cs index 877a793..09fb3b0 100644 --- a/ElectronNET.API/Entities/MessageBoxType.cs +++ b/ElectronNET.API/Entities/MessageBoxType.cs @@ -1,11 +1,33 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum MessageBoxType { + /// + /// The none + /// none, + + /// + /// The information + /// info, + + /// + /// The error + /// error, + + /// + /// The question + /// question, + + /// + /// The warning + /// warning } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/NativeImage.cs b/ElectronNET.API/Entities/NativeImage.cs index deb6210..2e408d1 100644 --- a/ElectronNET.API/Entities/NativeImage.cs +++ b/ElectronNET.API/Entities/NativeImage.cs @@ -1,6 +1,9 @@ namespace ElectronNET.API.Entities { - // TODO: Fertig coden + // TODO: Need some of real code :) + /// + /// + /// public class NativeImage { // public static NativeImage CreateEmpty() diff --git a/ElectronNET.API/Entities/NotificationAction.cs b/ElectronNET.API/Entities/NotificationAction.cs index 25bee11..c7194cd 100644 --- a/ElectronNET.API/Entities/NotificationAction.cs +++ b/ElectronNET.API/Entities/NotificationAction.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class NotificationAction { /// diff --git a/ElectronNET.API/Entities/NotificationOptions.cs b/ElectronNET.API/Entities/NotificationOptions.cs index f2fc91c..ce73b04 100644 --- a/ElectronNET.API/Entities/NotificationOptions.cs +++ b/ElectronNET.API/Entities/NotificationOptions.cs @@ -3,6 +3,9 @@ using System; namespace ElectronNET.API.Entities { + /// + /// + /// public class NotificationOptions { /// @@ -61,6 +64,12 @@ namespace ElectronNET.API.Entities [JsonIgnore] public Action OnShow { get; set; } + /// + /// Gets or sets the show identifier. + /// + /// + /// The show identifier. + /// [JsonProperty] internal string ShowID { get; set; } @@ -70,6 +79,12 @@ namespace ElectronNET.API.Entities [JsonIgnore] public Action OnClick { get; set; } + /// + /// Gets or sets the click identifier. + /// + /// + /// The click identifier. + /// [JsonProperty] internal string ClickID { get; set; } @@ -81,6 +96,12 @@ namespace ElectronNET.API.Entities [JsonIgnore] public Action OnClose { get; set; } + /// + /// Gets or sets the close identifier. + /// + /// + /// The close identifier. + /// [JsonProperty] internal string CloseID { get; set; } @@ -92,6 +113,12 @@ namespace ElectronNET.API.Entities [JsonIgnore] public Action OnReply { get; set; } + /// + /// Gets or sets the reply identifier. + /// + /// + /// The reply identifier. + /// [JsonProperty] internal string ReplyID { get; set; } @@ -101,9 +128,20 @@ namespace ElectronNET.API.Entities [JsonIgnore] public Action OnAction { get; set; } + /// + /// Gets or sets the action identifier. + /// + /// + /// The action identifier. + /// [JsonProperty] internal string ActionID { get; set; } + /// + /// Initializes a new instance of the class. + /// + /// The title. + /// The body. public NotificationOptions(string title, string body) { Title = title; diff --git a/ElectronNET.API/Entities/OnTopLevel.cs b/ElectronNET.API/Entities/OnTopLevel.cs index e57a283..f2a125c 100644 --- a/ElectronNET.API/Entities/OnTopLevel.cs +++ b/ElectronNET.API/Entities/OnTopLevel.cs @@ -2,19 +2,53 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum OnTopLevel { + /// + /// The normal + /// normal, + + /// + /// The floating + /// floating, + + /// + /// The torn off menu + /// [Description("torn-off-menu")] tornOffMenu, + + /// + /// The modal panel + /// [Description("modal-panel")] modalPanel, + + /// + /// The main menu + /// [Description("main-menu")] mainMenu, + + /// + /// The status + /// status, + + /// + /// The pop up menu + /// [Description("pop-up-menu")] popUpMenu, + + /// + /// The screen saver + /// [Description("screen-saver")] screenSaver } diff --git a/ElectronNET.API/Entities/OpenDevToolsOptions.cs b/ElectronNET.API/Entities/OpenDevToolsOptions.cs index ebb7d32..23a9aa7 100644 --- a/ElectronNET.API/Entities/OpenDevToolsOptions.cs +++ b/ElectronNET.API/Entities/OpenDevToolsOptions.cs @@ -3,6 +3,9 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API.Entities { + /// + /// + /// public class OpenDevToolsOptions { /// diff --git a/ElectronNET.API/Entities/OpenDialogOptions.cs b/ElectronNET.API/Entities/OpenDialogOptions.cs index 85b81f9..3f18dff 100644 --- a/ElectronNET.API/Entities/OpenDialogOptions.cs +++ b/ElectronNET.API/Entities/OpenDialogOptions.cs @@ -3,9 +3,25 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API.Entities { + /// + /// + /// public class OpenDialogOptions { + /// + /// Gets or sets the title. + /// + /// + /// The title. + /// public string Title { get; set; } + + /// + /// Gets or sets the default path. + /// + /// + /// The default path. + /// public string DefaultPath { get; set; } /// diff --git a/ElectronNET.API/Entities/OpenDialogProperty.cs b/ElectronNET.API/Entities/OpenDialogProperty.cs index a1b7723..44a16b1 100644 --- a/ElectronNET.API/Entities/OpenDialogProperty.cs +++ b/ElectronNET.API/Entities/OpenDialogProperty.cs @@ -1,14 +1,48 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum OpenDialogProperty { + /// + /// The open file + /// openFile, + + /// + /// The open directory + /// openDirectory, + + /// + /// The multi selections + /// multiSelections, + + /// + /// The show hidden files + /// showHiddenFiles, + + /// + /// The create directory + /// createDirectory, + + /// + /// The prompt to create + /// promptToCreate, + + /// + /// The no resolve aliases + /// noResolveAliases, + + /// + /// The treat package as directory + /// treatPackageAsDirectory } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/OpenExternalOptions.cs b/ElectronNET.API/Entities/OpenExternalOptions.cs index 4ad12ff..f5819c6 100644 --- a/ElectronNET.API/Entities/OpenExternalOptions.cs +++ b/ElectronNET.API/Entities/OpenExternalOptions.cs @@ -2,6 +2,9 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class OpenExternalOptions { /// diff --git a/ElectronNET.API/Entities/PathName.cs b/ElectronNET.API/Entities/PathName.cs index 0435b4c..560b9f9 100644 --- a/ElectronNET.API/Entities/PathName.cs +++ b/ElectronNET.API/Entities/PathName.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum PathName { /// @@ -64,7 +67,7 @@ videos, /// - /// + /// The logs /// logs, diff --git a/ElectronNET.API/Entities/Point.cs b/ElectronNET.API/Entities/Point.cs index 265237a..a464bed 100644 --- a/ElectronNET.API/Entities/Point.cs +++ b/ElectronNET.API/Entities/Point.cs @@ -1,8 +1,24 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class Point { + /// + /// Gets or sets the x. + /// + /// + /// The x. + /// public int X { get; set; } + + /// + /// Gets or sets the y. + /// + /// + /// The y. + /// public int Y { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/PrintToPDFOptions.cs b/ElectronNET.API/Entities/PrintToPDFOptions.cs index 53d24a8..3604d38 100644 --- a/ElectronNET.API/Entities/PrintToPDFOptions.cs +++ b/ElectronNET.API/Entities/PrintToPDFOptions.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class PrintToPDFOptions { /// diff --git a/ElectronNET.API/Entities/ProcessMetric.cs b/ElectronNET.API/Entities/ProcessMetric.cs index 79cab89..cf1973f 100644 --- a/ElectronNET.API/Entities/ProcessMetric.cs +++ b/ElectronNET.API/Entities/ProcessMetric.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class ProcessMetric { /// diff --git a/ElectronNET.API/Entities/ProgressBarMode.cs b/ElectronNET.API/Entities/ProgressBarMode.cs index dc47445..b9fed42 100644 --- a/ElectronNET.API/Entities/ProgressBarMode.cs +++ b/ElectronNET.API/Entities/ProgressBarMode.cs @@ -1,11 +1,33 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum ProgressBarMode { + /// + /// The none + /// none, + + /// + /// The normal + /// normal, + + /// + /// The indeterminate + /// indeterminate, + + /// + /// The error + /// error, + + /// + /// The paused + /// paused } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/ProgressBarOptions.cs b/ElectronNET.API/Entities/ProgressBarOptions.cs index ffcc25e..7177a2f 100644 --- a/ElectronNET.API/Entities/ProgressBarOptions.cs +++ b/ElectronNET.API/Entities/ProgressBarOptions.cs @@ -3,6 +3,9 @@ using Newtonsoft.Json.Converters; namespace ElectronNET.API.Entities { + /// + /// + /// public class ProgressBarOptions { /// diff --git a/ElectronNET.API/Entities/ReadBookmark.cs b/ElectronNET.API/Entities/ReadBookmark.cs index 76bc611..fd5b665 100644 --- a/ElectronNET.API/Entities/ReadBookmark.cs +++ b/ElectronNET.API/Entities/ReadBookmark.cs @@ -1,8 +1,24 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class ReadBookmark { + /// + /// Gets or sets the title. + /// + /// + /// The title. + /// public string Title { get; set; } + + /// + /// Gets or sets the URL. + /// + /// + /// The URL. + /// public string Url { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/Rectangle.cs b/ElectronNET.API/Entities/Rectangle.cs index 7e1a8eb..5d171e7 100644 --- a/ElectronNET.API/Entities/Rectangle.cs +++ b/ElectronNET.API/Entities/Rectangle.cs @@ -1,10 +1,40 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class Rectangle { + /// + /// Gets or sets the x. + /// + /// + /// The x. + /// public int X { get; set; } + + /// + /// Gets or sets the y. + /// + /// + /// The y. + /// public int Y { get; set; } + + /// + /// Gets or sets the width. + /// + /// + /// The width. + /// public int Width { get; set; } + + /// + /// Gets or sets the height. + /// + /// + /// The height. + /// public int Height { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/RelaunchOptions.cs b/ElectronNET.API/Entities/RelaunchOptions.cs index 55ff88e..9d81603 100644 --- a/ElectronNET.API/Entities/RelaunchOptions.cs +++ b/ElectronNET.API/Entities/RelaunchOptions.cs @@ -1,8 +1,24 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class RelaunchOptions { + /// + /// Gets or sets the arguments. + /// + /// + /// The arguments. + /// public string[] Args { get; set; } + + /// + /// Gets or sets the execute path. + /// + /// + /// The execute path. + /// public string ExecPath { get; set; } } } diff --git a/ElectronNET.API/Entities/SaveDialogOptions.cs b/ElectronNET.API/Entities/SaveDialogOptions.cs index 42c4954..16811d7 100644 --- a/ElectronNET.API/Entities/SaveDialogOptions.cs +++ b/ElectronNET.API/Entities/SaveDialogOptions.cs @@ -2,8 +2,17 @@ namespace ElectronNET.API { + /// + /// + /// public class SaveDialogOptions { + /// + /// Gets or sets the title. + /// + /// + /// The title. + /// public string Title { get; set; } /// diff --git a/ElectronNET.API/Entities/ShortcutDetails.cs b/ElectronNET.API/Entities/ShortcutDetails.cs index accc7ac..d011c9e 100644 --- a/ElectronNET.API/Entities/ShortcutDetails.cs +++ b/ElectronNET.API/Entities/ShortcutDetails.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API { + /// + /// + /// public class ShortcutDetails { /// diff --git a/ElectronNET.API/Entities/ShortcutLinkOperation.cs b/ElectronNET.API/Entities/ShortcutLinkOperation.cs index 258c2bb..ed501a2 100644 --- a/ElectronNET.API/Entities/ShortcutLinkOperation.cs +++ b/ElectronNET.API/Entities/ShortcutLinkOperation.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API { + /// + /// + /// public enum ShortcutLinkOperation { /// diff --git a/ElectronNET.API/Entities/Size.cs b/ElectronNET.API/Entities/Size.cs index 35b0a0d..d63d180 100644 --- a/ElectronNET.API/Entities/Size.cs +++ b/ElectronNET.API/Entities/Size.cs @@ -6,13 +6,19 @@ public class Size { /// - /// + /// Gets or sets the width. /// + /// + /// The width. + /// public int Width { get; set; } /// - /// + /// Gets or sets the height. /// + /// + /// The height. + /// public int Height { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/ThumbarButton.cs b/ElectronNET.API/Entities/ThumbarButton.cs index ce2e0be..504c26f 100644 --- a/ElectronNET.API/Entities/ThumbarButton.cs +++ b/ElectronNET.API/Entities/ThumbarButton.cs @@ -4,10 +4,25 @@ using System; namespace ElectronNET.API.Entities { + /// + /// + /// public class ThumbarButton { + /// + /// Gets the identifier. + /// + /// + /// The identifier. + /// public string Id { get; internal set; } + /// + /// Gets or sets the click. + /// + /// + /// The click. + /// [JsonIgnore] public Action Click { get; set; } @@ -34,6 +49,10 @@ namespace ElectronNET.API.Entities /// public string Tooltip { get; set; } + /// + /// Initializes a new instance of the class. + /// + /// The icon. public ThumbarButton(string icon) { Icon = icon; diff --git a/ElectronNET.API/Entities/ThumbarButtonFlag.cs b/ElectronNET.API/Entities/ThumbarButtonFlag.cs index 869a283..e68ca86 100644 --- a/ElectronNET.API/Entities/ThumbarButtonFlag.cs +++ b/ElectronNET.API/Entities/ThumbarButtonFlag.cs @@ -1,5 +1,8 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum ThumbarButtonFlag { /// diff --git a/ElectronNET.API/Entities/TitleBarStyle.cs b/ElectronNET.API/Entities/TitleBarStyle.cs index 99c923c..8fb108e 100644 --- a/ElectronNET.API/Entities/TitleBarStyle.cs +++ b/ElectronNET.API/Entities/TitleBarStyle.cs @@ -2,12 +2,30 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum TitleBarStyle { + /// + /// The default style + /// [JsonProperty("default")] defaultStyle, + + /// + /// The hidden + /// hidden, + + /// + /// The hidden inset + /// hiddenInset, + + /// + /// The custom buttons on hover + /// customButtonsOnHover } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/TrayClickEventArgs.cs b/ElectronNET.API/Entities/TrayClickEventArgs.cs index 5e7b09b..4a881a1 100644 --- a/ElectronNET.API/Entities/TrayClickEventArgs.cs +++ b/ElectronNET.API/Entities/TrayClickEventArgs.cs @@ -1,10 +1,43 @@ -namespace ElectronNET.API +/// +/// +/// +namespace ElectronNET.API { + /// + /// + /// public class TrayClickEventArgs { + /// + /// Gets or sets a value indicating whether [alt key]. + /// + /// + /// true if [alt key]; otherwise, false. + /// public bool AltKey { get; set; } + + /// + /// Gets or sets a value indicating whether [shift key]. + /// + /// + /// true if [shift key]; otherwise, false. + /// public bool ShiftKey { get; set; } + + /// + /// Gets or sets a value indicating whether [control key]. + /// + /// + /// true if [control key]; otherwise, false. + /// public bool CtrlKey { get; set; } + + /// + /// Gets or sets a value indicating whether [meta key]. + /// + /// + /// true if [meta key]; otherwise, false. + /// public bool MetaKey { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/Entities/UserTask.cs b/ElectronNET.API/Entities/UserTask.cs index 1b37d67..985717d 100644 --- a/ElectronNET.API/Entities/UserTask.cs +++ b/ElectronNET.API/Entities/UserTask.cs @@ -1,12 +1,56 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public class UserTask { + /// + /// Gets or sets the arguments. + /// + /// + /// The arguments. + /// public string Arguments { get; set; } + + /// + /// Gets or sets the description. + /// + /// + /// The description. + /// public string Description { get; set; } + + /// + /// Gets or sets the index of the icon. + /// + /// + /// The index of the icon. + /// public int IconIndex { get; set; } + + /// + /// Gets or sets the icon path. + /// + /// + /// The icon path. + /// public string IconPath { get; set; } + + /// + /// Gets or sets the program. + /// + /// + /// The program. + /// public string Program { get; set; } + + /// + /// Gets or sets the title. + /// + /// + /// The title. + /// public string Title { get; set; } } } diff --git a/ElectronNET.API/Entities/Vibrancy.cs b/ElectronNET.API/Entities/Vibrancy.cs index d4fe52a..07ca743 100644 --- a/ElectronNET.API/Entities/Vibrancy.cs +++ b/ElectronNET.API/Entities/Vibrancy.cs @@ -2,19 +2,61 @@ namespace ElectronNET.API.Entities { + /// + /// + /// public enum Vibrancy { + /// + /// The appearance based + /// [JsonProperty("appearance-based")] appearanceBased, + + /// + /// The light + /// light, + + /// + /// The dark + /// dark, + + /// + /// The titlebar + /// titlebar, + + /// + /// The selection + /// selection, + + /// + /// The menu + /// menu, + + /// + /// The popover + /// popover, + + /// + /// The sidebar + /// sidebar, + + /// + /// The medium light + /// [JsonProperty("medium-light")] mediumLight, + + /// + /// The ultra dark + /// [JsonProperty("ultra-dark")] ultraDark } diff --git a/ElectronNET.API/Entities/WebPreferences.cs b/ElectronNET.API/Entities/WebPreferences.cs index 6e12ea4..11c562b 100644 --- a/ElectronNET.API/Entities/WebPreferences.cs +++ b/ElectronNET.API/Entities/WebPreferences.cs @@ -1,8 +1,8 @@ -using Newtonsoft.Json; -using Newtonsoft.Json.Converters; - -namespace ElectronNET.API.Entities +namespace ElectronNET.API.Entities { + /// + /// + /// public class WebPreferences { /// @@ -182,13 +182,16 @@ namespace ElectronNET.API.Entities public bool NativeWindowOpen { get; set; } /// - /// Whether to enable the . Defaults to the value of the nodeIntegration option. The - /// preload script configured for the will have node integration enabled + /// Whether to enable the Webview. Defaults to the value of the nodeIntegration option. The + /// preload script configured for the Webview will have node integration enabled /// when it is executed so you should ensure remote/untrusted content is not able to - /// create a tag with a possibly malicious preload script.You can use the + /// create a Webview tag with a possibly malicious preload script.You can use the /// will-attach-webview event on to strip away the preload script and to validate or - /// alter the's initial settings. + /// alter the Webview's initial settings. /// + /// + /// true if [webview tag]; otherwise, false. + /// public bool WebviewTag { get; set; } } } \ No newline at end of file diff --git a/ElectronNET.API/HybridSupport.cs b/ElectronNET.API/HybridSupport.cs index 26252e4..935ea51 100644 --- a/ElectronNET.API/HybridSupport.cs +++ b/ElectronNET.API/HybridSupport.cs @@ -1,7 +1,16 @@ namespace ElectronNET.API { + /// + /// + /// public static class HybridSupport { + /// + /// Gets a value indicating whether this instance is electron active. + /// + /// + /// true if this instance is electron active; otherwise, false. + /// public static bool IsElectronActive { get diff --git a/ElectronNET.API/Menu.cs b/ElectronNET.API/Menu.cs index 4d74ad3..bbd593c 100644 --- a/ElectronNET.API/Menu.cs +++ b/ElectronNET.API/Menu.cs @@ -10,6 +10,9 @@ using System; namespace ElectronNET.API { + /// + /// Create native application menus and context menus. + /// public sealed class Menu { private static Menu _menu; @@ -29,9 +32,19 @@ namespace ElectronNET.API } } + /// + /// Gets the menu items. + /// + /// + /// The menu items. + /// public IReadOnlyCollection MenuItems { get { return _menuItems.AsReadOnly(); } } private List _menuItems = new List(); + /// + /// Sets the application menu. + /// + /// The menu items. public void SetApplicationMenu(MenuItem[] menuItems) { _menuItems.Clear(); @@ -47,9 +60,20 @@ namespace ElectronNET.API }); } + /// + /// Gets the context menu items. + /// + /// + /// The context menu items. + /// public IReadOnlyDictionary> ContextMenuItems { get; internal set; } private Dictionary> _contextMenuItems = new Dictionary>(); + /// + /// Sets the context menu. + /// + /// The browser window. + /// The menu items. public void SetContextMenu(BrowserWindow browserWindow, MenuItem[] menuItems) { if (!_contextMenuItems.ContainsKey(browserWindow.Id)) @@ -73,6 +97,10 @@ namespace ElectronNET.API } } + /// + /// Contexts the menu popup. + /// + /// The browser window. public void ContextMenuPopup(BrowserWindow browserWindow) { BridgeConnector.Socket.Emit("menu-contextMenuPopup", browserWindow.Id); diff --git a/ElectronNET.API/Notification.cs b/ElectronNET.API/Notification.cs index b7fd081..b8c5579 100644 --- a/ElectronNET.API/Notification.cs +++ b/ElectronNET.API/Notification.cs @@ -9,6 +9,9 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// Create OS desktop notifications + /// public sealed class Notification { private static Notification _notification; diff --git a/ElectronNET.API/Tray.cs b/ElectronNET.API/Tray.cs index fb5aac7..75aa8b2 100644 --- a/ElectronNET.API/Tray.cs +++ b/ElectronNET.API/Tray.cs @@ -9,6 +9,9 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// Add icons and context menus to the system's notification area. + /// public sealed class Tray { /// @@ -196,14 +199,30 @@ namespace ElectronNET.API } } - public IReadOnlyCollection Items { get { return _items.AsReadOnly(); } } + /// + /// Gets the menu items. + /// + /// + /// The menu items. + /// + public IReadOnlyCollection MenuItems { get { return _items.AsReadOnly(); } } private List _items = new List(); + /// + /// Shows the Traybar. + /// + /// The image. + /// The menu item. public void Show(string image, MenuItem menuItem) { Show(image, new MenuItem[] { menuItem }); } + /// + /// Shows the Traybar. + /// + /// The image. + /// The menu items. public void Show(string image, MenuItem[] menuItems) { menuItems.AddMenuItemsId(); @@ -211,7 +230,8 @@ namespace ElectronNET.API _items.AddRange(menuItems); BridgeConnector.Socket.Off("trayMenuItemClicked"); - BridgeConnector.Socket.On("trayMenuItemClicked", (id) => { + BridgeConnector.Socket.On("trayMenuItemClicked", (id) => + { MenuItem menuItem = _items.GetMenuItem(id.ToString()); menuItem?.Click(); }); diff --git a/ElectronNET.API/WebHostBuilderExtensions.cs b/ElectronNET.API/WebHostBuilderExtensions.cs index 226f0f3..5547f46 100644 --- a/ElectronNET.API/WebHostBuilderExtensions.cs +++ b/ElectronNET.API/WebHostBuilderExtensions.cs @@ -3,8 +3,17 @@ using System; namespace ElectronNET.API { + /// + /// + /// public static class WebHostBuilderExtensions { + /// + /// Use a Electron support for this .NET Core Project. + /// + /// The builder. + /// The arguments. + /// public static IWebHostBuilder UseElectron(this IWebHostBuilder builder, string[] args) { foreach (string argument in args) diff --git a/ElectronNET.API/WindowManager.cs b/ElectronNET.API/WindowManager.cs index 7c91da0..f6519d5 100644 --- a/ElectronNET.API/WindowManager.cs +++ b/ElectronNET.API/WindowManager.cs @@ -8,6 +8,9 @@ using System.Threading.Tasks; namespace ElectronNET.API { + /// + /// + /// public sealed class WindowManager { private static WindowManager _windowManager; @@ -27,14 +30,31 @@ namespace ElectronNET.API } } + /// + /// Gets the browser windows. + /// + /// + /// The browser windows. + /// public IReadOnlyCollection BrowserWindows { get { return _browserWindows.AsReadOnly(); } } private List _browserWindows = new List(); + /// + /// Creates the window asynchronous. + /// + /// The load URL. + /// public async Task CreateWindowAsync(string loadUrl = "http://localhost") { return await CreateWindowAsync(new BrowserWindowOptions(), loadUrl); } + /// + /// Creates the window asynchronous. + /// + /// The options. + /// The load URL. + /// public Task CreateWindowAsync(BrowserWindowOptions options, string loadUrl = "http://localhost") { var taskCompletionSource = new TaskCompletionSource();