Repository: ElectronNET/Electron.NET Branch: main Commit: c8268fae0eab Files: 477 Total size: 1.6 MB Directory structure: gitextract_uhomav4p/ ├── .gitattributes ├── .github/ │ ├── CONTRIBUTING.md │ ├── FUNDING.yml │ ├── ISSUE_TEMPLATE/ │ │ ├── bug_report.md │ │ ├── feature_request.md │ │ └── question.md │ └── workflows/ │ ├── Build and Publish.yml │ ├── PR Validation.yml │ ├── integration-tests.yml │ ├── pr-comment.yml │ ├── publish-wiki.yml │ ├── retry-test-jobs.yml │ └── trailing-whitespace-check.yml ├── .gitignore ├── .nuke/ │ ├── build.schema.json │ └── parameters.json ├── .vscode/ │ ├── launch.json │ └── tasks.json ├── Changelog.md ├── LICENSE ├── NuGet.config ├── README.md ├── artifacts/ │ └── .gitkeep ├── assets/ │ └── images/ │ └── electron.net-logo.psd ├── build.cmd ├── build.ps1 ├── build.sh ├── docs/ │ ├── .docproj/ │ │ ├── DocProj.props │ │ └── DocProj.targets │ ├── API/ │ │ ├── App.md │ │ ├── AutoUpdater.md │ │ ├── Clipboard.md │ │ ├── Dialog.md │ │ ├── Dock.md │ │ ├── GlobalShortcut.md │ │ ├── HostHook.md │ │ ├── IpcMain.md │ │ ├── Menu.md │ │ ├── NativeTheme.md │ │ ├── Notification.md │ │ ├── Overview.md │ │ ├── PowerMonitor.md │ │ ├── Screen.md │ │ ├── Shell.md │ │ ├── Tray.md │ │ ├── WebContents.md │ │ └── WindowManager.md │ ├── About.md │ ├── Core/ │ │ ├── Advanced-Migration-Topics.md │ │ ├── Migration-Checks.md │ │ ├── Migration-Guide.md │ │ └── What's-New.md │ ├── Docs.shproj │ ├── GettingStarted/ │ │ ├── ASP.Net.md │ │ ├── Console-App.md │ │ └── System-Requirements.md │ ├── Home.md │ ├── RelInfo/ │ │ └── Package-Description.md │ ├── Using/ │ │ ├── Configuration.md │ │ ├── Custom_main.md │ │ ├── Debugging.md │ │ ├── Package-Building.md │ │ └── Startup-Methods.md │ ├── _Footer.md │ ├── _Sidebar.md │ └── md-styles.css ├── global.json ├── nuke/ │ ├── .editorconfig │ ├── Build.cs │ ├── CommonPropsParser.cs │ ├── Configuration.cs │ ├── Directory.Build.props │ ├── Directory.Build.targets │ ├── Extensions/ │ │ └── StringExtensions.cs │ ├── ReleaseNotes.cs │ ├── ReleaseNotesParser.cs │ ├── SemVersion.cs │ └── _build.csproj └── src/ ├── .editorconfig ├── ElectronNET/ │ ├── .electron/ │ │ └── .gitkeep │ ├── ElectronNET.csproj │ └── build/ │ ├── ElectronNET.Core.props │ ├── ElectronNET.Core.targets │ ├── ElectronNET.DesignTime.targets │ ├── ElectronNET.LateImport.targets │ ├── ElectronNET.MigrationChecks.targets │ ├── ElectronNETRules.Project.xaml │ ├── ElectronNETRules.Project2.xaml │ ├── electron-builder.json │ ├── package.template.json │ └── update_electron_versions.py ├── ElectronNET.API/ │ ├── API/ │ │ ├── ApiBase.cs │ │ ├── App.cs │ │ ├── AutoUpdater.cs │ │ ├── BrowserView.cs │ │ ├── BrowserWindow.cs │ │ ├── Clipboard.cs │ │ ├── CommandLine.cs │ │ ├── Cookies.cs │ │ ├── Dialog.cs │ │ ├── Dock.cs │ │ ├── Electron.cs │ │ ├── Entities/ │ │ │ ├── AboutPanelOptions.cs │ │ │ ├── AddRepresentationOptions.cs │ │ │ ├── AppDetailsOptions.cs │ │ │ ├── AutoResizeOptions.cs │ │ │ ├── BitmapOptions.cs │ │ │ ├── Blob.cs │ │ │ ├── BlockMapDataHolder.cs │ │ │ ├── BrowserViewConstructorOptions.cs │ │ │ ├── BrowserWindowOptions.cs │ │ │ ├── CPUUsage.cs │ │ │ ├── Certificate.cs │ │ │ ├── CertificatePrincipal.cs │ │ │ ├── CertificateTrustDialogOptions.cs │ │ │ ├── ChromeExtensionInfo.cs │ │ │ ├── ClearStorageDataOptions.cs │ │ │ ├── Cookie.cs │ │ │ ├── CookieChangedCause.cs │ │ │ ├── CookieDetails.cs │ │ │ ├── CookieFilter.cs │ │ │ ├── CreateFromBitmapOptions.cs │ │ │ ├── CreateFromBufferOptions.cs │ │ │ ├── CreateInterruptedDownloadOptions.cs │ │ │ ├── Data.cs │ │ │ ├── DefaultFontFamily.cs │ │ │ ├── DevToolsMode.cs │ │ │ ├── Display.cs │ │ │ ├── DisplayBalloonOptions.cs │ │ │ ├── DockBounceType.cs │ │ │ ├── EnableNetworkEmulationOptions.cs │ │ │ ├── Extension.cs │ │ │ ├── FileFilter.cs │ │ │ ├── FileIconOptions.cs │ │ │ ├── FileIconSize.cs │ │ │ ├── FocusOptions.cs │ │ │ ├── GPUFeatureStatus.cs │ │ │ ├── IPostData.cs │ │ │ ├── ImportCertificateOptions.cs │ │ │ ├── InputEvent.cs │ │ │ ├── InputEventType.cs │ │ │ ├── JumpListCategory.cs │ │ │ ├── JumpListCategoryType.cs │ │ │ ├── JumpListItem.cs │ │ │ ├── JumpListItemType.cs │ │ │ ├── JumpListSettings.cs │ │ │ ├── LoadURLOptions.cs │ │ │ ├── LoginItemLaunchItem.cs │ │ │ ├── LoginItemSettings.cs │ │ │ ├── LoginItemSettingsOptions.cs │ │ │ ├── LoginSettings.cs │ │ │ ├── Margins.cs │ │ │ ├── MemoryInfo.cs │ │ │ ├── MenuItem.cs │ │ │ ├── MenuRole.cs │ │ │ ├── MenuType.cs │ │ │ ├── MessageBoxOptions.cs │ │ │ ├── MessageBoxResult.cs │ │ │ ├── MessageBoxType.cs │ │ │ ├── ModifierType.cs │ │ │ ├── NativeImage.cs │ │ │ ├── NativeImageJsonConverter.cs │ │ │ ├── NotificationAction.cs │ │ │ ├── NotificationOptions.cs │ │ │ ├── OnDidFailLoadInfo.cs │ │ │ ├── OnDidNavigateInfo.cs │ │ │ ├── OnTopLevel.cs │ │ │ ├── OpenDevToolsOptions.cs │ │ │ ├── OpenDialogOptions.cs │ │ │ ├── OpenDialogProperty.cs │ │ │ ├── OpenExternalOptions.cs │ │ │ ├── PageSize.cs │ │ │ ├── PathName.cs │ │ │ ├── Point.cs │ │ │ ├── PrintOptions.cs │ │ │ ├── PrintToPDFOptions.cs │ │ │ ├── PrinterInfo.cs │ │ │ ├── ProcessMetric.cs │ │ │ ├── ProcessVersions.cs │ │ │ ├── ProgressBarMode.cs │ │ │ ├── ProgressBarOptions.cs │ │ │ ├── ProgressInfo.cs │ │ │ ├── ProxyConfig.cs │ │ │ ├── ReadBookmark.cs │ │ │ ├── Rectangle.cs │ │ │ ├── RelaunchOptions.cs │ │ │ ├── ReleaseNoteInfo.cs │ │ │ ├── RemovePassword.cs │ │ │ ├── ResizeOptions.cs │ │ │ ├── SaveDialogOptions.cs │ │ │ ├── SaveDialogProperty.cs │ │ │ ├── Scheme.cs │ │ │ ├── SemVer.cs │ │ │ ├── SharingItem.cs │ │ │ ├── ShortcutDetails.cs │ │ │ ├── ShortcutLinkOperation.cs │ │ │ ├── Size.cs │ │ │ ├── ThemeSourceMode.cs │ │ │ ├── ThumbarButton.cs │ │ │ ├── ThumbarButtonFlag.cs │ │ │ ├── TitleBarOverlay.cs │ │ │ ├── TitleBarStyle.cs │ │ │ ├── ToBitmapOptions.cs │ │ │ ├── ToDataUrlOptions.cs │ │ │ ├── ToPNGOptions.cs │ │ │ ├── TrayClickEventArgs.cs │ │ │ ├── UpdateCancellationToken.cs │ │ │ ├── UpdateCheckResult.cs │ │ │ ├── UpdateFileInfo.cs │ │ │ ├── UpdateInfo.cs │ │ │ ├── UploadFile.cs │ │ │ ├── UploadRawData.cs │ │ │ ├── UserTask.cs │ │ │ ├── Vibrancy.cs │ │ │ └── WebPreferences.cs │ │ ├── Extensions/ │ │ │ ├── MenuItemExtensions.cs │ │ │ └── ThumbarButtonExtensions.cs │ │ ├── GlobalShortcut.cs │ │ ├── HostHook.cs │ │ ├── HybridSupport.cs │ │ ├── IpcMain.cs │ │ ├── Menu.cs │ │ ├── NativeTheme.cs │ │ ├── Notification.cs │ │ ├── PowerMonitor.cs │ │ ├── Process.cs │ │ ├── QuitEventArgs.cs │ │ ├── Screen.cs │ │ ├── Session.cs │ │ ├── Shell.cs │ │ ├── Tray.cs │ │ ├── WebContents.cs │ │ ├── WebRequest.cs │ │ ├── WindowManager.cs │ │ └── web-request.md │ ├── Bridge/ │ │ ├── BridgeConnector.cs │ │ ├── Events.cs │ │ └── SocketIOFacade.cs │ ├── Common/ │ │ ├── Extensions.cs │ │ ├── ProcessRunner.cs │ │ ├── RunnerParams.cs │ │ └── TimeSpanExtensions.cs │ ├── Converter/ │ │ ├── ModifierTypeListConverter.cs │ │ ├── PageSizeConverter.cs │ │ └── TitleBarOverlayConverter.cs │ ├── ElectronNET.API.csproj │ ├── ElectronNET.API.csproj.DotSettings │ ├── ElectronNetRuntime.cs │ ├── Runtime/ │ │ ├── Controllers/ │ │ │ ├── RuntimeControllerBase.cs │ │ │ ├── RuntimeControllerDotNetFirst.cs │ │ │ └── RuntimeControllerElectronFirst.cs │ │ ├── Data/ │ │ │ ├── BuildInfo.cs │ │ │ ├── DotnetAppType.cs │ │ │ ├── LifetimeState.cs │ │ │ └── StartupMethod.cs │ │ ├── Helpers/ │ │ │ ├── LaunchOrderDetector.cs │ │ │ ├── PortHelper.cs │ │ │ └── UnpackagedDetector.cs │ │ ├── IElectronNetRuntimeController.cs │ │ ├── Services/ │ │ │ ├── ElectronProcess/ │ │ │ │ ├── ElectronProcessActive.cs │ │ │ │ ├── ElectronProcessBase.cs │ │ │ │ └── ElectronProcessPassive.cs │ │ │ ├── LifetimeServiceBase.cs │ │ │ └── SocketBridge/ │ │ │ └── SocketBridgeService.cs │ │ └── StartupManager.cs │ └── Serialization/ │ ├── ElectronJson.cs │ └── JsonToBoxedPrimitivesConverter.cs ├── ElectronNET.AspNet/ │ ├── API/ │ │ ├── ServiceCollectionExtensions.cs │ │ ├── WebApplicationBuilderExtensions.cs │ │ └── WebHostBuilderExtensions.cs │ ├── ElectronNET.AspNet.csproj │ └── Runtime/ │ ├── Controllers/ │ │ ├── RuntimeControllerAspNetBase.cs │ │ ├── RuntimeControllerAspNetDotnetFirst.cs │ │ └── RuntimeControllerAspNetElectronFirst.cs │ ├── Helpers/ │ │ └── ServerReadyStartupFilter.cs │ └── Services/ │ └── AspNetLifetimeAdapter.cs ├── ElectronNET.Build/ │ ├── ElectronNET.Build.csproj │ ├── ElectronNET.Build.csproj.DotSettings │ ├── PrintItemMetadata.cs │ ├── RemoveEnvironmentVariables.cs │ └── ReplaceMsBuildPropertiesTask.cs ├── ElectronNET.ConsoleApp/ │ ├── ElectronNET.ConsoleApp.csproj │ ├── Program.cs │ └── Properties/ │ ├── PublishProfiles/ │ │ ├── linux-x64.pubxml │ │ ├── publish-win-x64.pubxml │ │ └── win-x64.pubxml │ ├── electron-builder.json │ └── launchSettings.json ├── ElectronNET.Host/ │ ├── .gitignore │ ├── .vscode/ │ │ ├── launch.json │ │ └── tasks.json │ ├── ElectronHostHook/ │ │ ├── .gitignore │ │ ├── connector.js │ │ ├── connector.ts │ │ ├── index.js │ │ ├── index.ts │ │ ├── package.json │ │ └── tsconfig.json │ ├── ElectronNET.Host.esproj │ ├── api/ │ │ ├── app.js │ │ ├── app.ts │ │ ├── autoUpdater.js │ │ ├── autoUpdater.ts │ │ ├── browserView.js │ │ ├── browserView.ts │ │ ├── browserWindows.js │ │ ├── browserWindows.ts │ │ ├── clipboard.js │ │ ├── clipboard.ts │ │ ├── commandLine.js │ │ ├── commandLine.ts │ │ ├── dialog.js │ │ ├── dialog.ts │ │ ├── dock.js │ │ ├── dock.ts │ │ ├── globalShortcut.js │ │ ├── globalShortcut.ts │ │ ├── ipc.js │ │ ├── ipc.ts │ │ ├── menu.js │ │ ├── menu.ts │ │ ├── nativeTheme.js │ │ ├── nativeTheme.ts │ │ ├── notification.js │ │ ├── notification.ts │ │ ├── powerMonitor.js │ │ ├── powerMonitor.ts │ │ ├── process.js │ │ ├── process.ts │ │ ├── screen.js │ │ ├── screen.ts │ │ ├── shell.js │ │ ├── shell.ts │ │ ├── tray.js │ │ ├── tray.ts │ │ ├── webContents.js │ │ └── webContents.ts │ ├── eslint.config.js │ ├── globals.d.ts │ ├── main.js │ ├── package.json │ ├── scripts/ │ │ └── blazor-preload.js │ ├── splashscreen/ │ │ └── index.html │ ├── tsconfig.json │ ├── tsconfig.tsbuildinfo │ └── types-shims.d.ts ├── ElectronNET.IntegrationTests/ │ ├── Common/ │ │ ├── IntegrationFactAttribute.cs │ │ └── IntegrationTestBase.cs │ ├── ElectronFixture.cs │ ├── ElectronNET.IntegrationTests.csproj │ ├── GlobalUsings.cs │ ├── Properties/ │ │ └── electron-builder.json │ ├── Tests/ │ │ ├── AppTests.cs │ │ ├── AutoUpdaterTests.cs │ │ ├── BrowserViewTests.cs │ │ ├── BrowserWindowTests.cs │ │ ├── ClipboardTests.cs │ │ ├── CookiesTests.cs │ │ ├── GlobalShortcutTests.cs │ │ ├── HostHookTests.cs │ │ ├── IpcMainTests.cs │ │ ├── MenuTests.cs │ │ ├── MultiEventRegistrationTests.cs │ │ ├── NativeImageTests.cs │ │ ├── NativeThemeTests.cs │ │ ├── NotificationTests.cs │ │ ├── ProcessTests.cs │ │ ├── ScreenTests.cs │ │ ├── SessionTests.cs │ │ ├── ShellTests.cs │ │ ├── ThumbarButtonTests.cs │ │ ├── TrayTests.cs │ │ └── WebContentsTests.cs │ └── xunit.runner.json ├── ElectronNET.Lean.sln ├── ElectronNET.Samples.ElectronHostHook/ │ ├── Controllers/ │ │ └── HomeController.cs │ ├── ElectronHostHook/ │ │ ├── .gitignore │ │ ├── connector.ts │ │ ├── index.ts │ │ ├── package.json │ │ └── tsconfig.json │ ├── ElectronNET.Samples.ElectronHostHook.csproj │ ├── Program.cs │ ├── Properties/ │ │ ├── electron-builder.json │ │ └── launchSettings.json │ └── Views/ │ └── Home/ │ └── Index.cshtml ├── ElectronNET.WebApp/ │ ├── Controllers/ │ │ ├── AboutController.cs │ │ ├── AppSysInformationController.cs │ │ ├── ClipboardController.cs │ │ ├── CrashHangController.cs │ │ ├── DesktopCapturerController.cs │ │ ├── DialogsController.cs │ │ ├── HomeController.cs │ │ ├── HostHookController.cs │ │ ├── IpcController.cs │ │ ├── ManageWindowsController.cs │ │ ├── MenusController.cs │ │ ├── NotificationsController.cs │ │ ├── PdfController.cs │ │ ├── ShellController.cs │ │ ├── ShortcutsController.cs │ │ ├── TrayController.cs │ │ ├── UpdateController.cs │ │ └── WindowsController.cs │ ├── ElectronHostHook/ │ │ ├── .gitignore │ │ ├── connector.js │ │ ├── connector.ts │ │ ├── excelCreator.js │ │ ├── excelCreator.ts │ │ ├── index.js │ │ ├── index.ts │ │ ├── package.json │ │ └── tsconfig.json │ ├── ElectronNET.WebApp.csproj │ ├── Program.cs │ ├── Properties/ │ │ ├── PublishProfiles/ │ │ │ ├── linux-x64.pubxml │ │ │ └── win-x64.pubxml │ │ ├── electron-builder.json │ │ └── launchSettings.json │ ├── Startup.cs │ ├── Views/ │ │ ├── About/ │ │ │ └── Index.cshtml │ │ ├── AppSysInformation/ │ │ │ └── Index.cshtml │ │ ├── Clipboard/ │ │ │ └── Index.cshtml │ │ ├── CrashHang/ │ │ │ ├── Index.cshtml │ │ │ ├── ProcessCrash.cshtml │ │ │ └── ProcessHang.cshtml │ │ ├── DesktopCapturer/ │ │ │ └── Index.cshtml │ │ ├── Dialogs/ │ │ │ └── Index.cshtml │ │ ├── Home/ │ │ │ └── Index.cshtml │ │ ├── HostHook/ │ │ │ └── Index.cshtml │ │ ├── Ipc/ │ │ │ └── Index.cshtml │ │ ├── Menus/ │ │ │ └── Index.cshtml │ │ ├── Notifications/ │ │ │ └── Index.cshtml │ │ ├── Pdf/ │ │ │ └── Index.cshtml │ │ ├── Shell/ │ │ │ └── Index.cshtml │ │ ├── Shortcuts/ │ │ │ └── Index.cshtml │ │ ├── Tray/ │ │ │ └── Index.cshtml │ │ ├── Update/ │ │ │ └── Index.cshtml │ │ └── Windows/ │ │ ├── DemoWindow.cshtml │ │ ├── HandleErrorCrashes.cshtml │ │ └── Index.cshtml │ ├── appsettings.Development.json │ ├── appsettings.json │ └── wwwroot/ │ └── assets/ │ ├── app-icon/ │ │ └── mac/ │ │ └── app.icns │ ├── code-blocks.js │ ├── css/ │ │ ├── about.css │ │ ├── demo.css │ │ ├── fonts/ │ │ │ ├── SourceSansPro-Black.otf │ │ │ ├── SourceSansPro-BlackIt.otf │ │ │ ├── SourceSansPro-Bold.otf │ │ │ ├── SourceSansPro-BoldIt.otf │ │ │ ├── SourceSansPro-ExtraLight.otf │ │ │ ├── SourceSansPro-ExtraLightIt.otf │ │ │ ├── SourceSansPro-It.otf │ │ │ ├── SourceSansPro-Light.otf │ │ │ ├── SourceSansPro-LightIt.otf │ │ │ ├── SourceSansPro-Regular.otf │ │ │ ├── SourceSansPro-Semibold.otf │ │ │ └── SourceSansPro-SemiboldIt.otf │ │ ├── github.css │ │ ├── global.css │ │ ├── nativize.css │ │ ├── nav.css │ │ ├── print.css │ │ ├── section.css │ │ └── variables.css │ ├── demo-btns.js │ ├── ex-links.js │ ├── imports.js │ ├── mac/ │ │ ├── child.plist │ │ ├── info.plist │ │ └── parent.plist │ └── nav.js ├── ElectronNET.sln ├── ElectronNET.sln.DotSettings ├── common.props └── testEnvironments.json ================================================ FILE CONTENTS ================================================ ================================================ FILE: .gitattributes ================================================ ############################################################################### # Set default behavior to automatically normalize line endings. ############################################################################### * text=auto ############################################################################### # Set default behavior for command prompt diff. # # This is need for earlier builds of msysgit that does not have it on by # default for csharp files. # Note: This is only used by command line ############################################################################### #*.cs diff=csharp ############################################################################### # Set the merge driver for project and solution files # # Merging from the command prompt will add diff markers to the files if there # are conflicts (Merging from VS is not affected by the settings below, in VS # the diff markers are never inserted). Diff markers may cause the following # file extensions to fail to load in VS. An alternative would be to treat # these files as binary and thus will always conflict and require user # intervention with every merge. To do so, just uncomment the entries below ############################################################################### #*.sln merge=binary #*.csproj merge=binary #*.vbproj merge=binary #*.vcxproj merge=binary #*.vcproj merge=binary #*.dbproj merge=binary #*.fsproj merge=binary #*.lsproj merge=binary #*.wixproj merge=binary #*.modelproj merge=binary #*.sqlproj merge=binary #*.wwaproj merge=binary ############################################################################### # behavior for image files # # image files are treated as binary by default. ############################################################################### #*.jpg binary #*.png binary #*.gif binary ############################################################################### # diff behavior for common document formats # # Convert binary document formats to text before diffing them. This feature # is only available from the command line. Turn it on by uncommenting the # entries below. ############################################################################### #*.doc diff=astextplain #*.DOC diff=astextplain #*.docx diff=astextplain #*.DOCX diff=astextplain #*.dot diff=astextplain #*.DOT diff=astextplain #*.pdf diff=astextplain #*.PDF diff=astextplain #*.rtf diff=astextplain #*.RTF diff=astextplain ================================================ FILE: .github/CONTRIBUTING.md ================================================ # Contributing ## Project Scope The Electron.NET project ultimately tries to provide a framework for developing cross-platform client applications on the basis of .NET and Electron. Anything that is related to this goal will be considered. The project aims to be as close to Electron with .NET as a basis as possible. If your contribution does not reflect that goal, the chances of accepting it are limited. ## Code License This is an open source project falling under the [MIT License](../LICENSE). By using, distributing, or contributing to this project, you accept and agree that all code within the Electron.NET project and its libraries are licensed under MIT license. ## Becoming a Contributor Usually appointing someone as a contributor follows this process: 1. An individual contributes actively via discussions (reporting bugs, giving feedback to existing or opening new issues) and / or pull requests 2. The individual is either directly asked, invited or asks for contributor rights on the project 3. The individual uses the contribution rights to sustain or increase the active contributions Every contributor might have to sign the contributor's license agreement (CLA) to establish a legal trust between the project and its contributors. ## Working on Electron.NET ### Issue Discussion Discussion of issues should be placed transparently in the issue tracker here on GitHub. * [General issues, bugs, new features](https://github.com/ElectronNET/Electron.NET/issues) * [General discussions, help, exchange of ideas](https://github.com/ElectronNET/Electron.NET/discussions) ### Modifying the code Electron.NET and its libraries uses features from the latest versions of C# (e.g., C# 10). You will therefore need a C# compiler that is up for the job. 1. Fork and clone the repo. 2. First try to build the ElectronNET.Core library and see if you get the tests running. 3. You will be required to resolve some dependencies via NuGet. The build system of Electron.NET uses NUKE. ### Code Conventions Most parts in the Electron.NET project are fairly straight forward. Among these are: * Always use statement blocks for control statements, e.g., in a for-loop, if-condition, ... * You may use a simple (throw) statement in case of enforcing contracts on argument * Be explicit about modifiers (some files follow an older convention of the code base, but we settled on the explicit style) ### Development Workflow 1. If no issue already exists for the work you'll be doing, create one to document the problem(s) being solved and self-assign. 2. Otherwise please let us know that you are working on the problem. Regular status updates (e.g. "still in progress", "no time anymore", "practically done", "pull request issued") are highly welcome. 3. Create a new branch—please don't work in the `main` branch directly. It is reserved for releases. We recommend naming the branch to match the issue being addressed (`feature/#777` or `issue-777`). 4. Add failing tests for the change you want to make. Tests are crucial and should be taken from W3C (or other specification). 5. Fix stuff. Always go from edge case to edge case. 6. All tests should pass now. Also your new implementation should not break existing tests. 7. Update the documentation to reflect any changes. (or document such changes in the original issue) 8. Push to your fork or push your issue-specific branch to the main repository, then submit a pull request against `develop`. Just to illustrate the git workflow for Electron.NET a little bit more we've added the following graphs. Initially, Electron.NET starts at the `main` branch. This branch should contain the latest stable (or released) version. Here we now created a new branch called `develop`. This is the development branch. Now active work is supposed to be done. Therefore a new branch should be created. Let's create one: ```sh git checkout -b feature/#777 ``` There may be many of these feature branches. Most of them are also pushed to the server for discussion or synchronization. ```sh git push -u origin feature/#777 ``` Now feature branches may be closed when they are done. Here we simply merge with the feature branch(es). For instance the following command takes the `feature/#777` branch from the server and merges it with the `develop` branch. ```sh git checkout develop git pull git pull origin feature/#777 git push ``` Finally, we may have all the features that are needed to release a new version of Electron.NET. Here we tag the release. For instance for the 1.0 release we use `v1.0`. ```sh git checkout main git merge develop git tag v1.0 ``` (The last part is automatically performed by our CI system. Don't tag manually.) ### Versioning The rules of [semver](http://semver.org/) don't necessarily apply here, but we will try to stay quite close to them. Prior to version 1.0.0 we use the following scheme: 1. MINOR versions for reaching a feature milestone potentially combined with dramatic API changes 2. PATCH versions for refinements (e.g. performance improvements, bug fixes) After releasing version 1.0.0 the scheme changes to become: 1. MAJOR versions at maintainers' discretion following significant changes to the codebase (e.g., API changes) 2. MINOR versions for backwards-compatible enhancements (e.g., performance improvements) 3. PATCH versions for backwards-compatible bug fixes (e.g., spec compliance bugs, support issues) #### Code style Regarding code style like indentation and whitespace, **follow the conventions you see used in the source already.** In general most of the [C# coding guidelines from Microsoft](https://msdn.microsoft.com/en-us/library/ff926074.aspx) are followed. This project prefers type inference with `var` to explicitly stating (redundant) information. It is also important to keep a certain `async`-flow and to always use `ConfigureAwait(false)` in conjunction with an `await` expression. ## Backwards Compatibility We always try to remain backwards compatible beyond the currently supported versions of .NET. For instance, in December 2025 there have been activity to remove .NET 6 support from the codebase. We rejected this. Key points: 1. We have absolutely no need to drop `.net6` support. It doesn't hurt us in any way. 2. Many are still using `.net6`, including Electron.NET (non-Core) users. It doesn't make sense to force them to update two things at the same time (.NET + Electron.NET). 3. We MUST NOT and NEVER update `Microsoft.Build.Utilities.Core`. This will make Electron.NET stop working on older Visual Studio and MSBuild versions. There's are also no reasons to update it in the first place. It's important to note that the Microsoft label of "Out of support" on .NET has almost no practical meaning. We've rarely (if ever) seen any bugs fixed in the same .NET version which mattered. The bugs that all new .NET versions have are much worse than mature .NET versions which are declared as "out of support". Keep in mind that the LTS matters most for active development / ongoing supported projects. If, e.g., a TV has been released a decade ago it most likely won't be patched. Still, you might want to deploy applications to it, which then naturally would involve being based on "out of support" versions of the framework. TL;DR: Unless there is a technical reason (e.g., a crucial new API not being available) we should not drop "out of support" .NET versions. At the time of writing (December 2025) the minimum supported .NET version remains at `.net6`. ## Timeline **All of this information is related to ElectronNET.Core pre-v1!** We pretty much release whenever we have something new (i.e., do fixes such as a 0.1.1, or add new features, such as a 0.2.0) quite quickly. We will go for a 1.0.0 release of this as early as ~mid of January 2026 (unless we find some critical things or want to extend the beta phase for ElectronNET.Core). This should be sufficient time to get some user input and have enough experience to call it stable. ================================================ FILE: .github/FUNDING.yml ================================================ # These are supported funding model platforms github: [GregorBiswanger, FlorianRappl] patreon: # Replace with a single Patreon username open_collective: # Replace with a single Open Collective username ko_fi: # Replace with a single Ko-fi username tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry liberapay: # Replace with a single Liberapay username issuehunt: # Replace with a single IssueHunt username otechie: # Replace with a single Otechie username custom: https://donorbox.org/electron-net ================================================ FILE: .github/ISSUE_TEMPLATE/bug_report.md ================================================ --- name: Bug report about: Create a report to help us improve title: '' labels: bug assignees: '' --- * **Version**: * **Target**: Steps to Reproduce: 1. 2. ================================================ FILE: .github/ISSUE_TEMPLATE/feature_request.md ================================================ --- name: Feature request about: Suggest an idea for this project title: '' labels: Feature assignees: '' --- ================================================ FILE: .github/ISSUE_TEMPLATE/question.md ================================================ --- name: Question about: The issue tracker is not for questions. Please ask questions on https://stackoverflow.com/questions/tagged/electron.net or via chat in https://gitter.im/ElectronNET/community. title: '' labels: question assignees: '' --- 🚨 The issue tracker is not for questions 🚨 The issue tracker is not for questions. Please ask questions on https://stackoverflow.com/questions/tagged/electron.net or via chat in https://gitter.im/ElectronNET/community. ================================================ FILE: .github/workflows/Build and Publish.yml ================================================ name: Build and Publish on: [push] env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NUGET_API_KEY: ${{ secrets.NUGET_API_KEY }} concurrency: group: build-publish-${{ github.ref }} cancel-in-progress: true jobs: Integration-Tests: uses: ./.github/workflows/integration-tests.yml name: '1' Publish: needs: [Integration-Tests] runs-on: windows-latest timeout-minutes: 10 name: '2 / Publish' steps: - uses: actions/checkout@v4 - name: Setup dotnet uses: actions/setup-dotnet@v4 with: dotnet-version: | 6.0.x 8.0.x 10.0.x - name: Build run: | if ($env:GITHUB_REF -eq "refs/heads/main") { .\build.ps1 -Target Publish } elseif ($env:GITHUB_REF -eq "refs/heads/develop") { .\build.ps1 -Target PrePublish } else { .\build.ps1 } ================================================ FILE: .github/workflows/PR Validation.yml ================================================ name: PR Validation on: [pull_request] concurrency: group: pr-validation-${{ github.ref }} cancel-in-progress: true jobs: Whitespace-Check: uses: ./.github/workflows/trailing-whitespace-check.yml secrets: inherit name: '1' Tests: needs: Whitespace-Check uses: ./.github/workflows/integration-tests.yml secrets: inherit name: '2' build: needs: [Whitespace-Check, Tests] runs-on: windows-latest timeout-minutes: 10 name: '3 / Build' steps: - uses: actions/checkout@v4 - name: Setup dotnet uses: actions/setup-dotnet@v4 with: dotnet-version: | 6.0.x 8.0.x 10.0.x - name: Build run: .\build.ps1 ================================================ FILE: .github/workflows/integration-tests.yml ================================================ name: Tests on: workflow_call: concurrency: group: integration-tests-${{ github.ref }} cancel-in-progress: true jobs: tests: name: ${{ matrix.os }} API-${{ matrix.electronVersion }} runs-on: ${{ matrix.os }} strategy: fail-fast: false matrix: os: [ubuntu-22.04, ubuntu-24.04, windows-2022, windows-2025, macos-14, macos-15-intel, macos-26] electronVersion: ['30.4.0', '38.2.2'] include: - os: ubuntu-22.04 rid: linux-x64 - os: ubuntu-24.04 rid: linux-x64 - os: windows-2022 rid: win-x64 - os: windows-2025 rid: win-x64 - os: macos-14 rid: osx-arm64 - os: macos-15-intel rid: osx-x64 - os: macos-26 rid: osx-arm64 env: DOTNET_SKIP_FIRST_TIME_EXPERIENCE: 1 DOTNET_NOLOGO: 1 CI: true ELECTRON_ENABLE_LOGGING: 1 steps: - name: Checkout uses: actions/checkout@v4 - name: Random delay (0-20 seconds) shell: bash run: | DELAY=$((RANDOM % 21)) echo "Waiting for $DELAY seconds..." sleep $DELAY - name: Setup .NET uses: actions/setup-dotnet@v4 with: dotnet-version: '10.0.x' - name: Setup Node.js uses: actions/setup-node@v4 with: node-version: '22' - name: Restore run: dotnet restore -r ${{ matrix.rid }} -p:RuntimeIdentifier=${{ matrix.rid }} -p:ElectronVersion=${{ matrix.electronVersion }} src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj - name: Build run: dotnet build --no-restore -c Release -r ${{ matrix.rid }} -p:RuntimeIdentifier=${{ matrix.rid }} -p:ElectronVersion=${{ matrix.electronVersion }} src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj - name: Install Linux GUI dependencies if: runner.os == 'Linux' run: | set -e sudo apt-get update . /etc/os-release if [ "$VERSION_ID" = "24.04" ]; then ALSA_PKG=libasound2t64; else ALSA_PKG=libasound2; fi echo "Using ALSA package: $ALSA_PKG" sudo apt-get install -y xvfb \ libgtk-3-0 libnss3 libgdk-pixbuf-2.0-0 libdrm2 libgbm1 libxss1 libxtst6 libatk-bridge2.0-0 libatk1.0-0 libatspi2.0-0 libx11-xcb1 "$ALSA_PKG" - name: Run tests (Linux) if: runner.os == 'Linux' continue-on-error: true run: | mkdir -p test-results xvfb-run -a dotnet test src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj \ -c Release --no-build -r ${{ matrix.rid }} -p:RuntimeIdentifier=${{ matrix.rid }} -p:ElectronVersion=${{ matrix.electronVersion }} \ --logger "trx;LogFileName=${{ matrix.os }}-electron-${{ matrix.electronVersion }}.trx" \ --logger "console;verbosity=detailed" \ --results-directory test-results - name: Run tests (Windows) if: runner.os == 'Windows' continue-on-error: true run: | New-Item -ItemType Directory -Force -Path test-results | Out-Null dotnet test src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj -c Release --no-build -r ${{ matrix.rid }} -p:RuntimeIdentifier=${{ matrix.rid }} -p:ElectronVersion=${{ matrix.electronVersion }} --logger "trx;LogFileName=${{ matrix.os }}-electron-${{ matrix.electronVersion }}.trx" --logger "console;verbosity=detailed" --results-directory test-results - name: Run tests (macOS) if: runner.os == 'macOS' continue-on-error: true run: | mkdir -p test-results dotnet test src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj -c Release --no-build -r ${{ matrix.rid }} -p:RuntimeIdentifier=${{ matrix.rid }} -p:ElectronVersion=${{ matrix.electronVersion }} --logger "trx;LogFileName=${{ matrix.os }}-electron-${{ matrix.electronVersion }}.trx" --logger "console;verbosity=detailed" --results-directory test-results - name: Upload raw test results if: always() uses: actions/upload-artifact@v4 with: name: test-results-${{ matrix.os }}-electron-${{ matrix.electronVersion }} path: test-results/*.trx retention-days: 7 summary: name: Test Results runs-on: ubuntu-24.04 if: always() needs: [tests] permissions: actions: read contents: read checks: write pull-requests: write steps: - name: Download all test results uses: actions/download-artifact@v4 with: path: test-results - name: Setup .NET (for CTRF conversion) uses: actions/setup-dotnet@v4 with: dotnet-version: '10.0.x' - name: Install CTRF TRX→CTRF converter (dotnet tool) run: | dotnet new tool-manifest dotnet tool install DotnetCtrfJsonReporter --local - name: Convert TRX → CTRF and clean names (filePath=OS|Electron X.Y.Z) shell: bash run: | set -euo pipefail mkdir -p ctrf shopt -s globstar nullglob conv=0 for trx in test-results/**/*.trx; do base="$(basename "$trx" .trx)" # e.g. ubuntu-22.04-electron-30.4.0 os="${base%%-electron-*}" electron="${base#*-electron-}" label="$os|Electron $electron" outdir="ctrf/${label}" mkdir -p "$outdir" out="${outdir}/ctrf-report.json" dotnet tool run DotnetCtrfJsonReporter -p "$trx" -d "$outdir" -f "ctrf-report.json" jq --arg fp "$label" '.results.tests |= map(.filePath = $fp)' "$out" > "${out}.tmp" && mv "${out}.tmp" "$out" echo "Converted & normalized $trx -> $out" conv=$((conv+1)) done echo "Processed $conv TRX file(s)" - name: Publish Test Report if: always() uses: ctrf-io/github-test-reporter@v1 with: report-path: 'ctrf/**/*.json' summary: true pull-request: false status-check: false status-check-name: 'Integration Tests' use-suite-name: true update-comment: true always-group-by: true overwrite-comment: true exit-on-fail: true group-by: 'suite' upload-artifact: true fetch-previous-results: true summary-report: false summary-delta-report: true github-report: true test-report: false test-list-report: false failed-report: true failed-folded-report: false skipped-report: true suite-folded-report: true suite-list-report: false file-report: true previous-results-report: true insights-report: true flaky-report: true flaky-rate-report: true fail-rate-report: false slowest-report: false report-order: 'summary-delta-report,failed-report,skipped-report,suite-folded-report,file-report,previous-results-report,github-report' env: GITHUB_TOKEN: ${{ github.token }} - name: Save PR Number if: github.event_name == 'pull_request' run: echo "PR_NUMBER=${{ github.event.pull_request.number }}" >> $GITHUB_ENV - name: Write PR Number to File if: github.event_name == 'pull_request' run: echo "$PR_NUMBER" > pr_number.txt shell: bash - name: Upload PR Number Artifact if: github.event_name == 'pull_request' uses: actions/upload-artifact@v4 with: name: pr_number path: pr_number.txt - name: Summary run: echo "All matrix test jobs completed." ================================================ FILE: .github/workflows/pr-comment.yml ================================================ name: Create PR Comments on: workflow_run: workflows: [ "PR Validation" ] types: [completed] permissions: contents: read actions: read pull-requests: write jobs: pr-comment: name: Post Test Result as PR comment runs-on: ubuntu-24.04 if: github.event.workflow_run.event == 'pull_request' && github.event.workflow_run.conclusion != 'cancelled' steps: - name: Download CTRF artifact uses: dawidd6/action-download-artifact@v8 with: github_token: ${{ github.token }} run_id: ${{ github.event.workflow_run.id }} name: ctrf-report path: ctrf - name: Download PR Number Artifact uses: dawidd6/action-download-artifact@v8 with: github_token: ${{ github.token }} run_id: ${{ github.event.workflow_run.id }} name: pr_number path: pr_number - name: Read PR Number run: | set -Eeuo pipefail FILE='pr_number/pr_number.txt' # Ensure file exists if [ ! -f "$FILE" ] || [ -L "$FILE" ]; then echo "Error: $FILE is missing or is not a regular file." >&2 exit 1 fi # Chec file size if [ "$(wc -c < "$FILE" | tr -d ' ')" -gt 200 ]; then echo "Error: $FILE is too large." >&2 exit 1 fi # Read first line PR_NUMBER="" IFS= read -r PR_NUMBER < "$FILE" || true # Validate whether it's a number if ! [[ "$PR_NUMBER" =~ ^[0-9]{1,10}$ ]]; then echo "Error: PR_NUMBER is not a valid integer on the first line." >&2 exit 1 fi printf 'PR_NUMBER=%s\n' "$PR_NUMBER" >> "$GITHUB_ENV" - name: Post PR Comment uses: ctrf-io/github-test-reporter@v1 with: report-path: 'ctrf/**/*.json' issue: ${{ env.PR_NUMBER }} summary: true pull-request: true use-suite-name: true update-comment: true always-group-by: true overwrite-comment: true upload-artifact: false pull-request-report: true env: GITHUB_TOKEN: ${{ github.token }} ================================================ FILE: .github/workflows/publish-wiki.yml ================================================ name: Publish wiki on: push: branches: [electronnet_core, main] workflow_dispatch: concurrency: group: publish-wiki cancel-in-progress: true permissions: contents: write jobs: publish-wiki: runs-on: windows-latest steps: - uses: actions/checkout@v3 - name: Remove level 1 headings from Markdown files shell: bash run: | find docs/ -name '*.md' -exec sed -i '1d' {} \; - name: Move all files to root folder shell: bash run: | mv docs/*/* docs/ - name: Delete unwanted files shell: bash run: | # rm docs/*.xlsm # rm docs/*.pptx rm docs/*.shproj - name: Stripping file extensions.... uses: softworkz/strip-markdown-extensions-from-links-action@main with: path: ./docs/ - name: Copy Changelog shell: bash run: | cp Changelog.md docs/RelInfo/ 2>/dev/null || true - name: Copy images to wiki/wiki folder shell: bash run: | mkdir docs/wiki cp docs/*.svg docs/wiki/ 2>/dev/null || true cp docs/*.png docs/wiki/ 2>/dev/null || true cp docs/*.jpg docs/wiki/ 2>/dev/null || true cp docs/*.gif docs/wiki/ 2>/dev/null || true cp docs/*.mp4 docs/wiki/ 2>/dev/null || true - name: Commit and push changes run: | git config --global user.name "GitHub Action" git config --global user.email "action@github.com" git add -A git commit -m "Automatically update Markdown files" || echo "No changes to commit" - uses: Andrew-Chen-Wang/github-wiki-action@v4.4.0 with: path: docs/ ignore: | '**/*.xlsm' '**/*.pptx' '**/*.shproj' ================================================ FILE: .github/workflows/retry-test-jobs.yml ================================================ name: Tests auto-rerun on: workflow_run: workflows: [ "PR Validation", "Build and Publish" ] types: [ completed ] jobs: rerun-failed-matrix-jobs-once: if: > ${{ github.event.workflow_run.conclusion == 'failure' && github.event.workflow_run.run_attempt == 1 }} runs-on: ubuntu-24.04 permissions: actions: write contents: read steps: - name: Decide whether to rerun (only if matrix jobs failed) env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} REPO: ${{ github.repository }} RUN_ID: ${{ github.event.workflow_run.id }} run: | echo "Inspecting jobs of workflow run $RUN_ID in $REPO" jobs_json="$(gh api -R $REPO repos/$REPO/actions/runs/$RUN_ID/jobs)" echo "Jobs and conclusions:" echo "$jobs_json" | jq '.jobs[] | {name: .name, conclusion: .conclusion}' failed_matrix_jobs=$(echo "$jobs_json" | jq -r ' [ .jobs[] | select(.conclusion == "failure" and (.name | contains(" API-"))) ] | length // 0 ') failed_matrix_jobs=${failed_matrix_jobs:-0} if [ "${failed_matrix_jobs}" -gt 0 ]; then echo "Detected failing Integration Tests jobs – re-running failed jobs for this run." gh run rerun -R "$REPO" "$RUN_ID" --failed else echo "Only non-matrix jobs (like Test Results) failed – not auto-rerunning." fi ================================================ FILE: .github/workflows/trailing-whitespace-check.yml ================================================ name: Whitespace Check on: workflow_call: jobs: check-whitespace: runs-on: ubuntu-latest permissions: contents: read steps: - name: Checkout code uses: actions/checkout@v4 with: fetch-depth: 0 - name: Check for trailing whitespace run: | echo "Checking for trailing whitespace in changed files..." # Get the base branch BASE_SHA="${{ github.event.pull_request.base.sha }}" HEAD_SHA="${{ github.event.pull_request.head.sha }}" # Get list of changed files (excluding deleted files) CHANGED_FILES=$(git diff --name-only --diff-filter=d "$BASE_SHA" "$HEAD_SHA") if [ -z "$CHANGED_FILES" ]; then echo "No files to check." exit 0 fi # File patterns to check (text files) PATTERNS="\.cs$|\.csproj$|\.sln$|\.ts$|\.html$|\.css$|\.scss$" # Directories and file patterns to exclude EXCLUDE_PATTERNS="(^|\/)(\.|node_modules|bin|obj|artifacts|packages|\.vs|\.nuke\/temp)($|\/)" ERRORS_FOUND=0 TEMP_FILE=$(mktemp) while IFS= read -r file; do # Skip if file doesn't exist (shouldn't happen with --diff-filter=d, but just in case) if [ ! -f "$file" ]; then continue fi # Check if file matches patterns to check if ! echo "$file" | grep -qE "$PATTERNS"; then continue fi # Check if file should be excluded if echo "$file" | grep -qE "$EXCLUDE_PATTERNS"; then continue fi # Find trailing whitespace lines, excluding XML doc placeholder lines that are exactly "/// " (one space) MATCHES=$(grep -n '[[:space:]]$' "$file" | grep -vE '^[0-9]+:[[:space:]]*/// $' || true) if [ -n "$MATCHES" ]; then echo "❌ Trailing whitespace found in: $file" echo "$MATCHES" | head -10 TOTAL=$(echo "$MATCHES" | wc -l) if [ "$TOTAL" -gt 10 ]; then echo " ... and $(($TOTAL - 10)) more lines" fi echo "1" >> "$TEMP_FILE" fi done <<< "$CHANGED_FILES" ERRORS_FOUND=$(wc -l < "$TEMP_FILE" 2>/dev/null || echo "0") rm -f "$TEMP_FILE" if [ "$ERRORS_FOUND" -gt 0 ]; then echo "" echo "❌ Found trailing whitespace in $ERRORS_FOUND file(s)." echo "Please remove trailing whitespace from the files listed above." exit 1 else echo "✅ No trailing whitespace found in changed files." exit 0 fi ================================================ FILE: .gitignore ================================================ ## Ignore Visual Studio temporary files, build results, and ## files generated by popular Visual Studio add-ons. # User-specific files *.suo *.user *.userosscache *.sln.docstates # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs # Build results [Dd]ebug/ [Dd]ebugPublic/ [Rr]elease/ [Rr]eleases/ x64/ x86/ bld/ [Bb]in/ [Oo]bj/ [Ll]og/ # Visual Studio 2015 cache/options directory .vs/ # Uncomment if you have tasks that create the project's static files in wwwroot #wwwroot/ # MSTest test Results [Tt]est[Rr]esult*/ [Bb]uild[Ll]og.* # NUNIT *.VisualState.xml TestResult.xml # Build Results of an ATL Project [Dd]ebugPS/ [Rr]eleasePS/ dlldata.c # DNX project.lock.json project.fragment.lock.json artifacts/ !/artifacts/.gitkeep *_i.c *_p.c *_i.h *.ilk *.meta *.obj *.pch *.pdb *.pgc *.pgd *.rsp *.sbr *.tlb *.tli *.tlh *.tmp *.tmp_proj *.log *.vspscc *.vssscc .builds *.pidb *.svclog *.scc # Chutzpah Test files _Chutzpah* # Visual C++ cache files ipch/ *.aps *.ncb *.opendb *.opensdf *.sdf *.cachefile *.VC.db *.VC.VC.opendb # Visual Studio profiler *.psess *.vsp *.vspx *.sap # TFS 2012 Local Workspace $tf/ # Guidance Automation Toolkit *.gpState # ReSharper is a .NET coding add-in _ReSharper*/ *.[Rr]e[Ss]harper *.DotSettings.user # JustCode is a .NET coding add-in .JustCode # TeamCity is a build add-in _TeamCity* # DotCover is a Code Coverage Tool *.dotCover # NCrunch _NCrunch_* .*crunch*.local.xml nCrunchTemp_* # MightyMoose *.mm.* AutoTest.Net/ # Web workbench (sass) .sass-cache/ # Installshield output folder [Ee]xpress/ # DocProject is a documentation generator add-in DocProject/buildhelp/ DocProject/Help/*.HxT DocProject/Help/*.HxC DocProject/Help/*.hhc DocProject/Help/*.hhk DocProject/Help/*.hhp DocProject/Help/Html2 DocProject/Help/html # Click-Once directory publish/ # Publish Web Output *.[Pp]ublish.xml *.azurePubxml # TODO: Comment the next line if you want to checkin your web deploy settings # but database connection strings (with potential passwords) will be unencrypted #*.pubxml *.publishproj # Microsoft Azure Web App publish settings. Comment the next line if you want to # checkin your Azure Web App publish settings, but sensitive information contained # in these scripts will be unencrypted PublishScripts/ # NuGet Packages *.nupkg # The packages folder can be ignored because of Package Restore **/packages/* # except build/, which is used as an MSBuild target. !**/packages/build/ # Uncomment if necessary however generally it will be regenerated when needed #!**/packages/repositories.config # NuGet v3's project.json files produces more ignoreable files *.nuget.props *.nuget.targets # Microsoft Azure Build Output csx/ *.build.csdef # Microsoft Azure Emulator ecf/ rcf/ # Windows Store app package directories and files AppPackages/ BundleArtifacts/ Package.StoreAssociation.xml _pkginfo.txt # Visual Studio cache files # files ending in .cache can be ignored *.[Cc]ache # but keep track of directories ending in .cache !*.[Cc]ache/ # Others ClientBin/ ~$* *~ *.dbmdl *.dbproj.schemaview *.jfm *.pfx *.publishsettings node_modules/ orleans.codegen.cs # Since there are multiple workflows, uncomment next line to ignore bower_components # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) #bower_components/ # RIA/Silverlight projects Generated_Code/ # Backup & report files from converting an old project file # to a newer Visual Studio version. Backup files are not needed, # because we have git ;-) _UpgradeReport_Files/ Backup*/ UpgradeLog*.XML UpgradeLog*.htm # SQL Server files *.mdf *.ldf # Business Intelligence projects *.rdl.data *.bim.layout *.bim_*.settings # Microsoft Fakes FakesAssemblies/ # GhostDoc plugin setting file *.GhostDoc.xml # Node.js Tools for Visual Studio .ntvs_analysis.dat # Visual Studio 6 build log *.plg # Visual Studio 6 workspace options file *.opt # Visual Studio LightSwitch build output **/*.HTMLClient/GeneratedArtifacts **/*.DesktopClient/GeneratedArtifacts **/*.DesktopClient/ModelManifest.xml **/*.Server/GeneratedArtifacts **/*.Server/ModelManifest.xml _Pvt_Extensions # Paket dependency manager .paket/paket.exe paket-files/ # FAKE - F# Make .fake/ # JetBrains Rider .idea/ *.sln.iml # CodeRush .cr/ # Python Tools for Visual Studio (PTVS) __pycache__/ *.pyc # Mac Only settings file .DS_Store # Nuke build tool .nuke/temp /publish.cmd ================================================ FILE: .nuke/build.schema.json ================================================ { "$schema": "http://json-schema.org/draft-04/schema#", "definitions": { "Host": { "type": "string", "enum": [ "AppVeyor", "AzurePipelines", "Bamboo", "Bitbucket", "Bitrise", "GitHubActions", "GitLab", "Jenkins", "Rider", "SpaceAutomation", "TeamCity", "Terminal", "TravisCI", "VisualStudio", "VSCode" ] }, "ExecutableTarget": { "type": "string", "enum": [ "Clean", "Compile", "Default", "Package", "PrePublish", "Publish", "PublishPackages", "PublishPreRelease", "PublishRelease", "Restore", "RunUnitTests" ] }, "Verbosity": { "type": "string", "description": "", "enum": [ "Verbose", "Normal", "Minimal", "Quiet" ] }, "NukeBuild": { "properties": { "Continue": { "type": "boolean", "description": "Indicates to continue a previously failed build attempt" }, "Help": { "type": "boolean", "description": "Shows the help text for this build assembly" }, "Host": { "description": "Host for execution. Default is 'automatic'", "$ref": "#/definitions/Host" }, "NoLogo": { "type": "boolean", "description": "Disables displaying the NUKE logo" }, "Partition": { "type": "string", "description": "Partition to use on CI" }, "Plan": { "type": "boolean", "description": "Shows the execution plan (HTML)" }, "Profile": { "type": "array", "description": "Defines the profiles to load", "items": { "type": "string" } }, "Root": { "type": "string", "description": "Root directory during build execution" }, "Skip": { "type": "array", "description": "List of targets to be skipped. Empty list skips all dependencies", "items": { "$ref": "#/definitions/ExecutableTarget" } }, "Target": { "type": "array", "description": "List of targets to be invoked. Default is '{default_target}'", "items": { "$ref": "#/definitions/ExecutableTarget" } }, "Verbosity": { "description": "Logging verbosity during build execution. Default is 'Normal'", "$ref": "#/definitions/Verbosity" } } } }, "allOf": [ { "properties": { "CommonPropsFilePath": { "type": "string", "description": "common.props file path - to determine the configured version" }, "Configuration": { "type": "string", "description": "Configuration to build - Default is 'Debug' (local) or 'Release' (server)", "enum": [ "Debug", "Release" ] }, "ReleaseNotesFilePath": { "type": "string", "description": "ReleaseNotesFilePath - To determine the lates changelog version" }, "Solution": { "type": "string", "description": "Path to a solution file that is automatically loaded" } } }, { "$ref": "#/definitions/NukeBuild" } ] } ================================================ FILE: .nuke/parameters.json ================================================ { "$schema": "./build.schema.json", "Solution": "src/ElectronNET.Lean.sln" } ================================================ FILE: .vscode/launch.json ================================================ { // Use IntelliSense to find out which attributes exist for C# debugging // Use hover for the description of the existing attributes // For further information visit https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md "version": "0.2.0", "configurations": [ { "name": ".NET Core Launch (console)", "type": "coreclr", "request": "launch", "preLaunchTask": "build", // If you have changed target frameworks, make sure to update the program path. "program": "${workspaceRoot}/src/ElectronNET.CLI/bin/Debug/net8.0/dotnet-electronize.dll", "args": [], "cwd": "${workspaceRoot}/src/ElectronNET.CLI", // For more information about the 'console' field, see https://github.com/OmniSharp/omnisharp-vscode/blob/master/debugger-launchjson.md#console-terminal-window "console": "internalConsole", "stopAtEntry": false, "internalConsoleOptions": "openOnSessionStart" }, { "name": ".NET Core Attach", "type": "coreclr", "request": "attach", "processId": "${command:pickProcess}" } ] } ================================================ FILE: .vscode/tasks.json ================================================ { "version": "2.0.0", "command": "dotnet", "args": [], "tasks": [ { "label": "build", "type": "shell", "command": "dotnet", "args": ["build", "${workspaceRoot}/src/ElectronNET.CLI/ElectronNET.CLI.csproj"], "problemMatcher": "$msCompile", "group": { "_id": "build", "isDefault": false } } ] } ================================================ FILE: Changelog.md ================================================ # 0.4.1 ## ElectronNET.Core - Updated documentation for preload scripts (#1031) @AeonSake - Updated timeout for electron-builder (#1013) @softworkz - Updated disposal avoiding exceptions on teardown (#1026) @softworkz - Updated migration guide (#1015) @hilin - Fixed handling of `Center` property for windows (#1001) - Fixed false alarm for `ELECTRON001`, `ELECTRON008`, and `ELECTRON009` (#1012) @softworkz - Added missing methods on `Cookies` (#1000) - Added overload for `GetAllDisplaysAsync` with timeout (#1033) @softworkz - Added `OnBoundsChanged` event (#1014) @softworkz - Added new events for `ipcMain` (#1019) @DYH1319 # 0.4.0 ## ElectronNET.Core - Fixed ElectronSingleInstance handling (#996) @softworkz - Fixed `PackageId` handling (#993) @softworkz - Added cross-platform npm restore and check mismatch on publish (#988) @softworkz # 0.3.1 ## ElectronNET.Core - Fixed issue transforming the project ID (#989, #990) @softworkz # 0.3.0 ## ElectronNET.Core - Updated infrastructure (#937, #939) @softworkz - Updated all model classes to Electron API 39.2 (#949) @softworkz - Fixed output path for `electron-builder` (#942) @softworkz - Fixed floating point display resolution (#944) @softworkz - Fixed error in case of missing electron-host-hook (#978) - Fixed previous API break using exposed `JsonElement` objects (#938) @softworkz - Fixed and improved several test cases (#962) @softworkz - Fixed startup of Electron.NET from VS Code Debug Adapter (#952) - Fixed the `BrowserWindowOptions` (#945) @softworkz - Fixed example for `AutoMenuHide` to reflect platform capabilities (#982) @markatosi - Added several migration checks for publishing (#966) @softworkz - Added more test runners for E2E tests (#950, #951) @agracio - Added dynamic updates for tray menu (#973) @davidroth - Added matrix tests with 6 runners and 2 electron version (#948) @softworkz - Added additional APIs for WebContents (#958) @agracio - Added documentation for MacOS package publish (#983) @markatosi - Added sample application for `ElectronHostHook` (#967) @adityashirsatrao007 # 0.2.0 ## ElectronNET.Core - Updated dependencies (#930) @softworkz - Updated integration tests (#931) @softworkz - Updated `ElectronNET.Host` (#935) @softworkz - Removed transition period specific build configuration (#928) @softworkz - Added `IsRunningBlazor` option to `BrowserWindowOptions` (#926) - Added platform support attributes (#929) @softworkz # 0.1.0 ## ElectronNET.Core - Updated `PrintToPDFOptions` to also allow specifying the `PageSize` with an object (#769) - Updated splashscreen image to have 0 margin (#622) - Updated the IPC API w.r.t. naming and consistency (#905) @agracio - Updated the IPC bridge w.r.t. synchronization and thread-safety (#918) @agracio - Updated serialization to use `System.Text.Json` replacing `Newtonsoft.Json` (#917) @Denny09310 - Fixed parameter handling for the `sendToIpcRenderer` function (#922) @softworkz - Fixed synchronization on removing event handlers (#921) @softworkz - Fixed creation of windows with `contextIsolation` enabled (#906) @NimbusFox - Fixed single instance behavior using the `ElectronSingleInstance` property (#901) - Fixed potential race conditions (#908) @softworkz - Added option to use `ElectronSplashScreen` with an HTML file (#799) - Added option to provide floating point value as aspect ratios with `SetAspectRatio` (#793) - Added option to provide `TitleBarOverlay` as an object (#911) @Denny09310 - Added `TitleBarOverlay` property to `BrowserWindowOptions` (#909) - Added `RoundedCorners` property to `BrowserWindowOptions` - Added integration tests and robustness checks (#913) @softworkz - Added .NET 10 as an explicit target # 0.0.18 ## ElectronNET.Core ### Highlights - **Complete MSBuild Integration**: Eliminated CLI tool dependency, moved all build processes to MSBuild with deep Visual Studio integration - **Modernized Architecture**: Restructured process lifecycle with .NET launching first and running Electron as child process for better control and reliability - **Cross-Platform Development**: Build and debug Linux applications directly from Windows Visual Studio via WSL integration - **Flexible Electron Versioning**: Removed version lock-in, users can now select any Electron version with build-time validation - **Enhanced Debugging Experience**: ASP.NET-first debugging with Hot Reload support and improved process termination handling - **Console App Support**: No longer requires ASP.NET - now works with simple console applications for file system or remote server HTML/JS ### Build System & Project Structure - Eliminated electron.manifest.json configuration file, replaced with MSBuild project properties - Introduced new package structure: ElectronNET.Core (main package), ElectronNET.Core.Api (API definitions), ElectronNET.Core.AspNet (ASP.NET integration) - Added Runtime Identifier (RID) selection as part of project configuration - Restructured build folder layout to use standard .NET format (bin\net8.0\win-x64) instead of bin\Desktop - Implemented incremental build support for Electron assets to improve build performance - Added custom MSBuild tasks for Electron-specific build operations ### Development Experience - Implemented unpackaged run-mode for development using regular .NET builds with unpackaged Electron configuration - Added support for building Linux packages on Windows via WSL integration - Enabled running and debugging Linux application outputs on Windows through WSL - Integrated TypeScript compilation with ASP.NET tooling for consistent builds - Added process orchestration supporting 8 different launch scenarios (packaged/unpackaged × console/ASP.NET × dotnet-first/electron-first) ### Debugging & Runtime - Dramatically improved debugging experience with ASP.NET-first launch mode - Added Hot Reload support for ASP.NET code during development - Implemented proper process termination handling for all exit scenarios - Minimized startup times through optimized build and launch procedures ### Technical Improvements - Enhanced splash screen handling with automatic path resolution - Improved ElectronHostHook integration as proper npm package dependency - Updated to latest TypeScript version with ESLint configuration - Added support for custom main.js files in projects - Implemented version management through common.props file - Added build-time Electron version compatibility validation ### Package & Distribution - Integrated MSBuild publishing mechanisms for creating Electron packages - Added folder publishing support with improved parameter handling - Implemented automated package.json generation from MSBuild properties - Added GitHub release automation with proper versioning - Reduced package sizes by eliminating unnecessary TypeScript dependencies ### Migration & Compatibility - Maintained backward compatibility for existing ElectronHostHook implementations - Removed ASP.NET requirement: Now works with simple console applications for file system or remote server HTML/JS scenarios - Added support for both console and ASP.NET Core application types - Preserved all existing Electron API functionality while modernizing architecture - Added migration path for existing projects through updated package structure This represents a comprehensive modernization of Electron.NET, addressing the major pain points around debugging, build complexity, and platform limitations while maintaining full API compatibility. ================================================ FILE: LICENSE ================================================ MIT License Copyright (c) 2017-2025 Gregor Biswanger, Robert Mühsig, Florian Rappl Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ================================================ FILE: NuGet.config ================================================ ================================================ FILE: README.md ================================================ [![Electron.NET Logo](https://github.com/ElectronNET/Electron.NET/raw/main/assets/images/electron.net-logo.png)](https://github.com/ElectronNET/Electron.NET) [![donate](https://img.shields.io/badge/Donate-Donorbox-green.svg)](https://donorbox.org/electron-net) [![Gitter](https://badges.gitter.im/ElectronNET/community.svg)](https://gitter.im/ElectronNET/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Build status](https://github.com/ElectronNET/Electron.NET/actions/workflows/ci.yml/badge.svg)](https://github.com/ElectronNET/Electron.NET/actions/workflows/ci.yml) # Electron.NET Core is here! ## A Complete Transformation `ElectronNET.Core` represents a fundamental modernization of Electron.NET, addressing years of accumulated pain points while preserving full API compatibility. This isn't just an update — it's a complete rethinking of how .NET developers build and debug cross-platform desktop applications with Electron. Read more: [**What's New in `ElectronNET.Core`**](https://github.com/ElectronNET/Electron.NET/wiki/What's-New) Build cross platform desktop applications with .NET 6/8/10 - from console apps to ASP.NET Core (Razor Pages, MVC) to Blazor. ## Wait - how does that work exactly? Well... there are lots of different approaches how to get a X-plat desktop app running. Electron.NET provides a range of ways to build .NET-based solutions using Electron at the side of presentation. While the classic Electron.NET setup (using an ASP.NET host run by the Electron side) is still the primary way, there's more flexibility now. Both .NET and Electron are now able to launch the other for better lifetime management, and when you don't need a local web server (like when running content from files or remote servers), you can drop the ASP.NET stack altogether and go with a lightweight console app instead. ## 📦 NuGet * ElectronNET.Core: [![NuGet](https://img.shields.io/nuget/v/ElectronNET.Core.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.Core.API/) * ElectronNET.Core.API: [![NuGet](https://img.shields.io/nuget/v/ElectronNET.Core.API.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.Core.API/) * ElectronNET.Core.AspNet: [![NuGet](https://img.shields.io/nuget/v/ElectronNET.Core.AspNet.svg?style=flat-square)](https://www.nuget.org/packages/ElectronNET.Core.AspNet/) ## 🛠 Requirements to Run You should have installed: * .NET 6/8 or later. * The minimum base OS is the same as [.NET 6](https://github.com/dotnet/core/blob/main/release-notes/6.0/supported-os.md) / [.NET 8](https://github.com/dotnet/core/blob/main/release-notes/8.0/supported-os.md). * Node.JS using at least [Version 22.x](https://nodejs.org). ## 👩‍🏫 Usage with ASP.NET - Create a new ASP.NET Core project - Install the following two NuGet packages: ```ps1 dotnet add package ElectronNET.Core dotnet add package ElectronNET.Core.AspNet ``` ### Classic ASP.NET Core #### Enable Electron.NET on Startup To do so, use the `UseElectron` extension method on a `WebApplicationBuilder`, an `IWebHostBuilder` or any descendants. > [!NOTE] > New in Electron.NET Core is that you provide a callback method as an argument to `UseElectron()`, which ensures that you get to know the right moment to set up your application UI. #### Program.cs ```csharp using ElectronNET.API; using ElectronNET.API.Entities; public static void Main(string[] args) { WebHost.CreateDefaultBuilder(args) .UseElectron(args, ElectronAppReady) .UseStartup() .Build() .Run(); } public static async Task ElectronAppReady() { var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false }); browserWindow.OnReadyToShow += () => browserWindow.Show(); } ``` ### Minimal API Example For a minimal API you can use: ```csharp using ElectronNET; using ElectronNET.API; using ElectronNET.API.Entities; var builder = WebApplication.CreateBuilder(args); builder.Services.AddRazorPages(); builder.Services.AddElectron(); // <- might be useful to set up DI builder.UseElectron(args, async () => { var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false, AutoHideMenuBar = true }); browserWindow.OnReadyToShow += () => browserWindow.Show(); }); var app = builder.Build(); // Configure the HTTP request pipeline. if (!app.Environment.IsDevelopment()) { app.UseExceptionHandler("/Error"); } app.UseStaticFiles(); app.UseRouting(); app.UseAuthorization(); app.MapRazorPages(); app.Run(); ``` ### Blazor For a project with Blazor you can use: ```cs using ElectronNET.API; using ElectronNET.API.Entities; var builder = WebApplication.CreateBuilder(args); builder.Services .AddRazorComponents() .AddInteractiveWebAssemblyComponents(); builder.Services.AddElectron(); // <-- might be useful to set up DI builder.UseElectron(args, async () => { var options = new BrowserWindowOptions { Show = false, IsRunningBlazor = true, // <-- crucial }; if (OperatingSystem.IsWindows() || OperatingSystem.IsLinux()) options.AutoHideMenuBar = true; var browserWindow = await Electron.WindowManager.CreateWindowAsync(options); browserWindow.OnReadyToShow += () => browserWindow.Show(); }); var app = builder.Build(); // Configure the HTTP request pipeline. if (app.Environment.IsDevelopment()) { app.UseWebAssemblyDebugging(); } else { app.UseExceptionHandler("/Error", createScopeForErrors: true); } app.UseStaticFiles(); app.UseAntiforgery(); app.MapRazorComponents() .AddInteractiveWebAssemblyRenderMode(); app.Run(); ``` The `IsRunningBlazor` option makes sure to set up the renderer in a way that Blazor can just run without any interference. This includes things such as HMR for development. ## 🚀 Starting and Debugging the Application Just press `F5` in Visual Studio or use dotnet for debugging. ## 📔 Usage of the Electron API Complete documentation is available on the Wiki. In this YouTube video, we show you how you can create a new project, use the Electron.NET API, debug a application and build an executable desktop app for Windows: [Electron.NET - Getting Started](https://www.youtube.com/watch?v=nuM6AojRFHk) > [!NOTE] > The video hasn't been updated for the changes in ElectronNET.Core, so it is partially outdated. ## 👨‍💻 Authors * **[Gregor Biswanger](https://github.com/GregorBiswanger)** - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - [Cross-Platform-Blog](http://www.cross-platform-blog.com) - Twitter [@BFreakout](https://www.twitter.com/BFreakout) * **[Dr. Florian Rappl](https://github.com/FlorianRappl)** - Software Developer - from Munich, Germany. Microsoft MVP & Web Geek. - [The Art of Micro Frontends](https://microfrontends.art) - [Homepage](https://florian-rappl.de) - Twitter [@florianrappl](https://twitter.com/florianrappl) * **[softworkz](https://github.com/softworkz)** - Full Range Developer - likes to start where others gave up. MS MVP alumni and Munich citizen as well. * **[Robert Muehsig](https://github.com/robertmuehsig)** - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - [codeinside Blog](https://blog.codeinside.eu) - Twitter [@robert0muehsig](https://twitter.com/robert0muehsig) See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project. ## 🙋‍♀️🙋‍♂ Contributing Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues). Please make sure all commits are properly documented. ## 🙏 Donate We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you! [![donate](https://img.shields.io/badge/Donate-Donorbox-green.svg)](https://donorbox.org/electron-net) Alternatively, consider using a GitHub sponsorship for the core maintainers: - [Gregor Biswanger](https://github.com/sponsors/GregorBiswanger) - [Florian Rappl](https://github.com/sponsors/FlorianRappl) Any support appreciated! 🍻 ## 🎉 License MIT-licensed. See [LICENSE](https://github.com/ElectronNET/Electron.NET/blob/main/LICENSE) for details. **Enjoy!** ================================================ FILE: artifacts/.gitkeep ================================================ ================================================ FILE: build.cmd ================================================ :; set -eo pipefail :; SCRIPT_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd) :; ${SCRIPT_DIR}/build.sh "$@" :; exit $? @ECHO OFF powershell -ExecutionPolicy ByPass -NoProfile -File "%~dp0build.ps1" %* ================================================ FILE: build.ps1 ================================================ [CmdletBinding()] Param( [Parameter(Position=0,Mandatory=$false,ValueFromRemainingArguments=$true)] [string[]]$BuildArguments ) Write-Output "PowerShell $($PSVersionTable.PSEdition) version $($PSVersionTable.PSVersion)" Set-StrictMode -Version 2.0; $ErrorActionPreference = "Stop"; $ConfirmPreference = "None"; trap { Write-Error $_ -ErrorAction Continue; exit 1 } $PSScriptRoot = Split-Path $MyInvocation.MyCommand.Path -Parent ########################################################################### # CONFIGURATION ########################################################################### $BuildProjectFile = "$PSScriptRoot\nuke\_build.csproj" $TempDirectory = "$PSScriptRoot\\.nuke\temp" $DotNetGlobalFile = "$PSScriptRoot\\global.json" $DotNetInstallUrl = "https://dot.net/v1/dotnet-install.ps1" $DotNetChannel = "Current" $env:DOTNET_SKIP_FIRST_TIME_EXPERIENCE = 1 $env:DOTNET_CLI_TELEMETRY_OPTOUT = 1 $env:DOTNET_MULTILEVEL_LOOKUP = 0 ########################################################################### # EXECUTION ########################################################################### function ExecSafe([scriptblock] $cmd) { & $cmd if ($LASTEXITCODE) { exit $LASTEXITCODE } } # If dotnet CLI is installed globally and it matches requested version, use for execution if ($null -ne (Get-Command "dotnet" -ErrorAction SilentlyContinue) -and ` $(dotnet --version) -and $LASTEXITCODE -eq 0) { $env:DOTNET_EXE = (Get-Command "dotnet").Path } else { # Download install script $DotNetInstallFile = "$TempDirectory\dotnet-install.ps1" New-Item -ItemType Directory -Path $TempDirectory -Force | Out-Null [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 (New-Object System.Net.WebClient).DownloadFile($DotNetInstallUrl, $DotNetInstallFile) # If global.json exists, load expected version if (Test-Path $DotNetGlobalFile) { $DotNetGlobal = $(Get-Content $DotNetGlobalFile | Out-String | ConvertFrom-Json) if ($DotNetGlobal.PSObject.Properties["sdk"] -and $DotNetGlobal.sdk.PSObject.Properties["version"]) { $DotNetVersion = $DotNetGlobal.sdk.version } } # Install by channel or version $DotNetDirectory = "$TempDirectory\dotnet-win" if (!(Test-Path variable:DotNetVersion)) { ExecSafe { & powershell $DotNetInstallFile -InstallDir $DotNetDirectory -Channel $DotNetChannel -NoPath } } else { ExecSafe { & powershell $DotNetInstallFile -InstallDir $DotNetDirectory -Version $DotNetVersion -NoPath } } $env:DOTNET_EXE = "$DotNetDirectory\dotnet.exe" } Write-Output "Microsoft (R) .NET SDK version $(& $env:DOTNET_EXE --version)" ExecSafe { & $env:DOTNET_EXE build $BuildProjectFile /nodeReuse:false /p:UseSharedCompilation=false -nologo -clp:NoSummary --verbosity quiet } ExecSafe { & $env:DOTNET_EXE run --project $BuildProjectFile --no-build -- $BuildArguments } ================================================ FILE: build.sh ================================================ #!/usr/bin/env bash bash --version 2>&1 | head -n 1 set -eo pipefail SCRIPT_DIR=$(cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd) ########################################################################### # CONFIGURATION ########################################################################### BUILD_PROJECT_FILE="$SCRIPT_DIR/nuke/_build.csproj" TEMP_DIRECTORY="$SCRIPT_DIR//.nuke/temp" DOTNET_GLOBAL_FILE="$SCRIPT_DIR//global.json" DOTNET_INSTALL_URL="https://dot.net/v1/dotnet-install.sh" DOTNET_CHANNEL="Current" export DOTNET_CLI_TELEMETRY_OPTOUT=1 export DOTNET_SKIP_FIRST_TIME_EXPERIENCE=1 export DOTNET_MULTILEVEL_LOOKUP=0 ########################################################################### # EXECUTION ########################################################################### function FirstJsonValue { perl -nle 'print $1 if m{"'"$1"'": "([^"]+)",?}' <<< "${@:2}" } # If dotnet CLI is installed globally and it matches requested version, use for execution if [ -x "$(command -v dotnet)" ] && dotnet --version &>/dev/null; then export DOTNET_EXE="$(command -v dotnet)" else # Download install script DOTNET_INSTALL_FILE="$TEMP_DIRECTORY/dotnet-install.sh" mkdir -p "$TEMP_DIRECTORY" curl -Lsfo "$DOTNET_INSTALL_FILE" "$DOTNET_INSTALL_URL" chmod +x "$DOTNET_INSTALL_FILE" # If global.json exists, load expected version if [[ -f "$DOTNET_GLOBAL_FILE" ]]; then DOTNET_VERSION=$(FirstJsonValue "version" "$(cat "$DOTNET_GLOBAL_FILE")") if [[ "$DOTNET_VERSION" == "" ]]; then unset DOTNET_VERSION fi fi # Install by channel or version DOTNET_DIRECTORY="$TEMP_DIRECTORY/dotnet-unix" if [[ -z ${DOTNET_VERSION+x} ]]; then "$DOTNET_INSTALL_FILE" --install-dir "$DOTNET_DIRECTORY" --channel "$DOTNET_CHANNEL" --no-path else "$DOTNET_INSTALL_FILE" --install-dir "$DOTNET_DIRECTORY" --version "$DOTNET_VERSION" --no-path fi export DOTNET_EXE="$DOTNET_DIRECTORY/dotnet" fi echo "Microsoft (R) .NET SDK version $("$DOTNET_EXE" --version)" "$DOTNET_EXE" build "$BUILD_PROJECT_FILE" /nodeReuse:false /p:UseSharedCompilation=false -nologo -clp:NoSummary --verbosity quiet "$DOTNET_EXE" run --project "$BUILD_PROJECT_FILE" --no-build -- "$@" ================================================ FILE: docs/.docproj/DocProj.props ================================================ 8.1 true true **/*.md;**/*.markdown **/*.png;**/*.bmp;**/*.jpg;**/*.gif;**/*.mp4 **/*.css;**/*.js;**/*.json ================================================ FILE: docs/.docproj/DocProj.targets ================================================ ================================================ FILE: docs/API/App.md ================================================ # Electron.App Control your application's event lifecycle. ## Overview The `Electron.App` API provides comprehensive control over your application's lifecycle, including startup, shutdown, window management, and system integration. It handles application-level events and provides methods for managing the overall application state. ## Properties #### 📋 `CommandLine` A `CommandLine` object that allows you to read and manipulate the command line arguments that Chromium uses. #### 📋 `IsReady` Application host fully started. #### 📋 `Name` A string property that indicates the current application's name, which is the name in the application's package.json file. Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You should usually also specify a productName field, which is your application's full capitalized name, and which will be preferred over name by Electron. #### 📋 `NameAsync` A `Task` property that indicates the current application's name, which is the name in the application's package.json file. Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You should usually also specify a productName field, which is your application's full capitalized name, and which will be preferred over name by Electron. #### 📋 `UserAgentFallback` A string which is the user agent string Electron will use as a global fallback. This is the user agent that will be used when no user agent is set at the webContents or session level. It is useful for ensuring that your entire app has the same user agent. Set to a custom value as early as possible in your app's initialization to ensure that your overridden value is used. #### 📋 `UserAgentFallbackAsync` A `Task` which is the user agent string Electron will use as a global fallback. This is the user agent that will be used when no user agent is set at the webContents or session level. It is useful for ensuring that your entire app has the same user agent. Set to a custom value as early as possible in your app's initialization to ensure that your overridden value is used. ## Methods #### 🧊 `void AddRecentDocument(string path)` Adds path to the recent documents list. This list is managed by the OS. On Windows you can visit the list from the task bar, and on macOS you can visit it from dock menu. #### 🧊 `void ClearRecentDocuments()` Clears the recent documents list. #### 🧊 `void Exit(int exitCode = 0)` All windows will be closed immediately without asking user and the BeforeQuit and WillQuit events will not be emitted. **Parameters:** - `exitCode` - Exits immediately with exitCode. exitCode defaults to 0. #### 🧊 `void Focus()` On Linux, focuses on the first visible window. On macOS, makes the application the active app. On Windows, focuses on the application's first window. #### 🧊 `void Focus(FocusOptions focusOptions)` On Linux, focuses on the first visible window. On macOS, makes the application the active app. On Windows, focuses on the application's first window. You should seek to use the `FocusOptions.Steal` option as sparingly as possible. **Parameters:** - `focusOptions` - Focus options #### 🧊 `Task GetAppMetricsAsync(CancellationToken cancellationToken = default)` Memory and cpu usage statistics of all the processes associated with the app. **Returns:** Array of ProcessMetric objects that correspond to memory and cpu usage statistics of all the processes associated with the app. #### 🧊 `Task GetAppPathAsync(CancellationToken cancellationToken = default)` The current application directory. **Returns:** The current application directory. #### 🧊 `Task GetBadgeCountAsync(CancellationToken cancellationToken = default)` The current value displayed in the counter badge. **Returns:** The current value displayed in the counter badge. #### 🧊 `Task GetCurrentActivityTypeAsync(CancellationToken cancellationToken = default)` The type of the currently running activity. **Returns:** The type of the currently running activity. #### 🧊 `Task GetGpuFeatureStatusAsync(CancellationToken cancellationToken = default)` The Graphics Feature Status from chrome://gpu/. Note: This information is only usable after the gpu-info-update event is emitted. **Returns:** The Graphics Feature Status from chrome://gpu/. #### 🧊 `Task GetJumpListSettingsAsync(CancellationToken cancellationToken = default)` Jump List settings for the application. **Returns:** Jump List settings. #### 🧊 `Task GetLocaleAsync(CancellationToken cancellationToken = default)` The current application locale. Possible return values are documented [here](https://www.electronjs.org/docs/api/locales). Note: When distributing your packaged app, you have to also ship the locales folder. Note: On Windows, you have to call it after the Ready events gets emitted. **Returns:** The current application locale. #### 🧊 `Task GetLoginItemSettingsAsync(CancellationToken cancellationToken = default)` If you provided path and args options to SetLoginItemSettings then you need to pass the same arguments here for LoginItemSettings.OpenAtLogin to be set correctly. **Returns:** Login item settings. #### 🧊 `Task GetPathAsync(PathName pathName, CancellationToken cancellationToken = default)` The path to a special directory. If GetPathAsync is called without called SetAppLogsPath being called first, a default directory will be created equivalent to calling SetAppLogsPath without a path parameter. **Parameters:** - `pathName` - Special directory. **Returns:** A path to a special directory or file associated with name. #### 🧊 `Task GetVersionAsync(CancellationToken cancellationToken = default)` The version of the loaded application. If no version is found in the application's package.json file, the version of the current bundle or executable is returned. **Returns:** The version of the loaded application. #### 🧊 `Task HasSingleInstanceLockAsync(CancellationToken cancellationToken = default)` This method returns whether or not this instance of your app is currently holding the single instance lock. You can request the lock with RequestSingleInstanceLockAsync and release with ReleaseSingleInstanceLock. **Returns:** Whether this instance of your app is currently holding the single instance lock. #### 🧊 `void Hide()` Hides all application windows without minimizing them. #### 🧊 `Task ImportCertificateAsync(ImportCertificateOptions options, CancellationToken cancellationToken = default)` Imports the certificate in pkcs12 format into the platform certificate store. callback is called with the result of import operation, a value of 0 indicates success while any other value indicates failure according to chromium net_error_list. **Parameters:** - `options` - Import certificate options - `cancellationToken` - The cancellation token **Returns:** Result of import. Value of 0 indicates success. #### 🧊 `void InvalidateCurrentActivity()` Invalidates the current Handoff user activity. #### 🧊 `Task IsAccessibilitySupportEnabledAsync(CancellationToken cancellationToken = default)` true if Chrome's accessibility support is enabled, false otherwise. This API will return true if the use of assistive technologies, such as screen readers, has been detected. See Chromium's accessibility docs for more details. **Returns:** true if Chrome's accessibility support is enabled, false otherwise. #### 🧊 `Task IsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default)` This method checks if the current executable is the default handler for a protocol (aka URI scheme). Note: On macOS, you can use this method to check if the app has been registered as the default protocol handler for a protocol. You can also verify this by checking ~/Library/Preferences/com.apple.LaunchServices.plist on the macOS machine. Please refer to Apple's documentation for details. The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally. **Parameters:** - `protocol` - The name of your protocol, without :// - `cancellationToken` - The cancellation token **Returns:** Whether the current executable is the default handler for a protocol (aka URI scheme). #### 🧊 `Task IsUnityRunningAsync(CancellationToken cancellationToken = default)` Whether the current desktop environment is Unity launcher. **Returns:** Whether the current desktop environment is Unity launcher. #### 🧊 `void Quit()` Try to close all windows. The BeforeQuit event will be emitted first. If all windows are successfully closed, the WillQuit event will be emitted and by default the application will terminate. This method guarantees that all beforeunload and unload event handlers are correctly executed. It is possible that a window cancels the quitting by returning false in the beforeunload event handler. #### 🧊 `void ReleaseSingleInstanceLock()` Releases all locks that were created by makeSingleInstance. This will allow multiple instances of the application to once again run side by side. #### 🧊 `void Relaunch()` Relaunches the app when current instance exits. By default the new instance will use the same working directory and command line arguments with current instance. Note that this method does not quit the app when executed, you have to call Quit or Exit after calling Relaunch() to make the app restart. When Relaunch() is called for multiple times, multiple instances will be started after current instance exited. #### 🧊 `void Relaunch(RelaunchOptions relaunchOptions)` Relaunches the app when current instance exits. By default the new instance will use the same working directory and command line arguments with current instance. When RelaunchOptions.Args is specified, the RelaunchOptions.Args will be passed as command line arguments instead. When RelaunchOptions.ExecPath is specified, the RelaunchOptions.ExecPath will be executed for relaunch instead of current app. Note that this method does not quit the app when executed, you have to call Quit or Exit after calling Relaunch() to make the app restart. When Relaunch() is called for multiple times, multiple instances will be started after current instance exited. **Parameters:** - `relaunchOptions` - Options for the relaunch #### 🧊 `Task RemoveAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default)` This method checks if the current executable as the default handler for a protocol (aka URI scheme). If so, it will remove the app as the default handler. **Parameters:** - `protocol` - The name of your protocol, without :// - `cancellationToken` - The cancellation token **Returns:** Whether the call succeeded. #### 🧊 `Task RequestSingleInstanceLockAsync(Action newInstanceOpened, CancellationToken cancellationToken = default)` The return value of this method indicates whether or not this instance of your application successfully obtained the lock. If it failed to obtain the lock, you can assume that another instance of your application is already running with the lock and exit immediately. I.e.This method returns true if your process is the primary instance of your application and your app should continue loading. It returns false if your process should immediately quit as it has sent its parameters to another instance that has already acquired the lock. On macOS, the system enforces single instance automatically when users try to open a second instance of your app in Finder, and the open-file and open-url events will be emitted for that.However when users start your app in command line, the system's single instance mechanism will be bypassed, and you have to use this method to ensure single instance. **Parameters:** - `newInstanceOpened` - Lambda with an array of the second instance's command line arguments. The second parameter is the working directory path. - `cancellationToken` - The cancellation token **Returns:** This method returns false if your process is the primary instance of the application and your app should continue loading. And returns true if your process has sent its parameters to another instance, and you should immediately quit. #### 🧊 `void ResignCurrentActivity()` Marks the current Handoff user activity as inactive without invalidating it. #### 🧊 `void SetAccessibilitySupportEnabled(bool enabled)` Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. See Chromium's accessibility docs for more details. Disabled (false) by default. This API must be called after the Ready event is emitted. Note: Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. **Parameters:** - `enabled` - Enable or disable accessibility tree rendering #### 🧊 `void SetAppLogsPath(string path)` Sets or creates a directory your app's logs which can then be manipulated with GetPathAsync or SetPath. Calling SetAppLogsPath without a path parameter will result in this directory being set to ~/Library/Logs/YourAppName on macOS, and inside the userData directory on Linux and Windows. **Parameters:** - `path` - A custom path for your logs. Must be absolute #### 🧊 `void SetAppUserModelId(string id)` Changes the Application User Model ID to id. **Parameters:** - `id` - Model Id #### 🧊 `Task SetAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default)` Sets the current executable as the default handler for a protocol (aka URI scheme). It allows you to integrate your app deeper into the operating system. Once registered, all links with your-protocol:// will be opened with the current executable. The whole link, including protocol, will be passed to your application as a parameter. Note: On macOS, you can only register protocols that have been added to your app's info.plist, which cannot be modified at runtime. However, you can change the file during build time via Electron Forge, Electron Packager, or by editing info.plist with a text editor. Please refer to Apple's documentation for details. Note: In a Windows Store environment (when packaged as an appx) this API will return true for all calls but the registry key it sets won't be accessible by other applications. In order to register your Windows Store application as a default protocol handler you must declare the protocol in your manifest. The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally. **Parameters:** - `protocol` - The name of your protocol, without ://. For example, if you want your app to handle electron:// links, call this method with electron as the parameter. - `cancellationToken` - The cancellation token **Returns:** Whether the call succeeded. #### 🧊 `Task SetBadgeCountAsync(int count, CancellationToken cancellationToken = default)` Sets the counter badge for current app. Setting the count to 0 will hide the badge. On macOS it shows on the dock icon. On Linux it only works for Unity launcher. Note: Unity launcher requires the existence of a .desktop file to work, for more information please read Desktop Environment Integration. **Parameters:** - `count` - Counter badge - `cancellationToken` - The cancellation token **Returns:** Whether the call succeeded. #### 🧊 `void SetJumpList(JumpListCategory[] categories)` Sets or removes a custom Jump List for the application. If categories is null the previously set custom Jump List (if any) will be replaced by the standard Jump List for the app (managed by Windows). Note: If a JumpListCategory object has neither the Type nor the Name property set then its Type is assumed to be tasks. If the Name property is set but the Type property is omitted then the Type is assumed to be custom. Note: Users can remove items from custom categories, and Windows will not allow a removed item to be added back into a custom category until after the next successful call to SetJumpList. Any attempt to re-add a removed item to a custom category earlier than that will result in the entire custom category being omitted from the Jump List. The list of removed items can be obtained using GetJumpListSettingsAsync. **Parameters:** - `categories` - Array of JumpListCategory objects #### 🧊 `void SetLoginItemSettings(LoginSettings loginSettings)` Set the app's login item settings. To work with Electron's autoUpdater on Windows, which uses Squirrel, you'll want to set the launch path to Update.exe, and pass arguments that specify your application name. **Parameters:** - `loginSettings` - Login settings #### 🧊 `void SetPath(PathName name, string path)` Overrides the path to a special directory or file associated with name. If the path specifies a directory that does not exist, an Error is thrown. In that case, the directory should be created with fs.mkdirSync or similar. You can only override paths of a name defined in GetPathAsync. By default, web pages' cookies and caches will be stored under the PathName.UserData directory. If you want to change this location, you have to override the PathName.UserData path before the Ready event of the App module is emitted. **Parameters:** - `name` - Special directory name - `path` - New path to a special directory #### 🧊 `void SetUserActivity(string type, object userInfo)` Creates an NSUserActivity and sets it as the current activity. The activity is eligible for Handoff to another device afterward. **Parameters:** - `type` - Uniquely identifies the activity. Maps to NSUserActivity.activityType. - `userInfo` - App-specific state to store for use by another device #### 🧊 `Task SetUserTasksAsync(UserTask[] userTasks, CancellationToken cancellationToken = default)` Adds tasks to the UserTask category of the JumpList on Windows. Note: If you'd like to customize the Jump List even more use SetJumpList instead. **Parameters:** - `userTasks` - Array of UserTask objects - `cancellationToken` - The cancellation token **Returns:** Whether the call succeeded. #### 🧊 `void Show()` Shows application windows after they were hidden. Does not automatically focus them. #### 🧊 `void ShowAboutPanel()` Show the app's about panel options. These options can be overridden with SetAboutPanelOptions. ## Events #### ⚡ `AccessibilitySupportChanged` Emitted when Chrome's accessibility support changes. This event fires when assistive technologies, such as screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details. #### ⚡ `BrowserWindowBlur` Emitted when a BrowserWindow blurred. #### ⚡ `BrowserWindowCreated` Emitted when a new BrowserWindow is created. #### ⚡ `BrowserWindowFocus` Emitted when a BrowserWindow gets focused. #### ⚡ `OpenFile` Emitted when a macOS user wants to open a file with the application. The open-file event is usually emitted when the application is already open and the OS wants to reuse the application to open the file. open-file is also emitted when a file is dropped onto the dock and the application is not yet running. On Windows, you have to parse the arguments using App.CommandLine to get the filepath. #### ⚡ `OpenUrl` Emitted when a macOS user wants to open a URL with the application. Your application's Info.plist file must define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication. #### ⚡ `Quitting` Emitted when the application is quitting. Note: On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout. #### ⚡ `Ready` Emitted when the application has finished basic startup. #### ⚡ `WebContentsCreated` Emitted when a new WebContents is created. #### ⚡ `WillQuit` Emitted when all windows have been closed and the application will quit. See the description of the WindowAllClosed event for the differences between the WillQuit and WindowAllClosed events. Note: On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout. #### ⚡ `WindowAllClosed` Emitted when all windows have been closed. If you do not subscribe to this event and all windows are closed, the default behavior is to quit the app; however, if you subscribe, you control whether the app quits or not.If the user pressed Cmd + Q, or the developer called Quit, Electron will first try to close all the windows and then emit the WillQuit event, and in this case the WindowAllClosed event would not be emitted. ## Usage Examples ### Application Lifecycle ```csharp // Handle app startup Electron.App.Ready += () => { Console.WriteLine("App is ready!"); }; // Handle window management Electron.App.WindowAllClosed += () => { if (!RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { Electron.App.Quit(); } }; // Prevent quit Electron.App.BeforeQuit += async (args) => { var result = await Electron.Dialog.ShowMessageBoxAsync("Do you want to quit?"); if (result.Response == 1) // Cancel { args.PreventDefault = true; } }; ``` ### Protocol Handling ```csharp // Register custom protocol var success = await Electron.App.SetAsDefaultProtocolClientAsync("myapp"); // Check if registered var isDefault = await Electron.App.IsDefaultProtocolClientAsync("myapp"); ``` ### Jump List (Windows) ```csharp // Set user tasks await Electron.App.SetUserTasksAsync(new[] { new UserTask { Program = "myapp.exe", Arguments = "--new-document", Title = "New Document", Description = "Create a new document" } }); ``` ### Application Information ```csharp // Get app information var appPath = await Electron.App.GetAppPathAsync(); var version = await Electron.App.GetVersionAsync(); var locale = await Electron.App.GetLocaleAsync(); // Set app name await Electron.App.NameAsync; // Get current name Electron.App.Name = "My Custom App Name"; ``` ### Badge Count (macOS/Linux) ```csharp // Set badge count await Electron.App.SetBadgeCountAsync(5); // Get current badge count var count = await Electron.App.GetBadgeCountAsync(); ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Window creation and management - [Electron.Dialog](Dialog.md) - User interaction dialogs - [Electron.Menu](Menu.md) - Application menus ## Additional Resources - [Electron App Documentation](https://electronjs.org/docs/api/app) - Official Electron app API - [Startup Methods](../Using/Startup-Methods.md) - Different application startup modes ================================================ FILE: docs/API/AutoUpdater.md ================================================ # Electron.AutoUpdater Handle application updates and installation processes. ## Overview The `Electron.AutoUpdater` API provides comprehensive functionality for handling application updates, including checking for updates, downloading, and installation. It supports multiple update providers and platforms with automatic update capabilities. ## Properties #### 📋 `bool AllowDowngrade` Whether to allow version downgrade. Default is false. #### 📋 `bool AllowPrerelease` GitHub provider only. Whether to allow update to pre-release versions. Defaults to true if application version contains prerelease components. #### 📋 `bool AutoDownload` Whether to automatically download an update when it is found. Default is true. #### 📋 `bool AutoInstallOnAppQuit` Whether to automatically install a downloaded update on app quit. Applicable only on Windows and Linux. #### 📋 `string Channel` Get the update channel. Not applicable for GitHub. Doesn't return channel from the update configuration, only if was previously set. #### 📋 `Task ChannelAsync` Get the update channel. Not applicable for GitHub. Doesn't return channel from the update configuration, only if was previously set. #### 📋 `Task CurrentVersionAsync` Get the current application version. #### 📋 `bool FullChangelog` GitHub provider only. Get all release notes (from current version to latest), not just the latest. Default is false. #### 📋 `Dictionary RequestHeaders` The request headers. #### 📋 `Task> RequestHeadersAsync` Get the current request headers. #### 📋 `string UpdateConfigPath` For test only. Configuration path for updates. ## Methods #### 🧊 `Task CheckForUpdatesAndNotifyAsync()` Asks the server whether there is an update and notifies the user if an update is available. #### 🧊 `Task CheckForUpdatesAsync()` Asks the server whether there is an update. #### 🧊 `Task DownloadUpdateAsync()` Start downloading update manually. Use this method if AutoDownload option is set to false. **Returns:** Path to downloaded file. #### 🧊 `Task GetFeedURLAsync()` Get the current feed URL. **Returns:** Feed URL. #### 🧊 `void QuitAndInstall(bool isSilent = false, bool isForceRunAfter = false)` Restarts the app and installs the update after it has been downloaded. Should only be called after update-downloaded has been emitted. Note: QuitAndInstall() will close all application windows first and only emit before-quit event on app after that. This is different from the normal quit event sequence. **Parameters:** - `isSilent` - Windows-only: Runs the installer in silent mode. Defaults to false - `isForceRunAfter` - Run the app after finish even on silent install. Not applicable for macOS ## Events #### ⚡ `OnCheckingForUpdate` Emitted when checking if an update has started. #### ⚡ `OnDownloadProgress` Emitted on download progress. #### ⚡ `OnError` Emitted when there is an error while updating. #### ⚡ `OnUpdateAvailable` Emitted when there is an available update. The update is downloaded automatically if AutoDownload is true. #### ⚡ `OnUpdateDownloaded` Emitted on download complete. #### ⚡ `OnUpdateNotAvailable` Emitted when there is no available update. ## Usage Examples ### Basic Auto-Update Setup ```csharp // Configure auto-updater Electron.AutoUpdater.AutoDownload = true; Electron.AutoUpdater.AutoInstallOnAppQuit = true; // Check for updates var updateCheck = await Electron.AutoUpdater.CheckForUpdatesAsync(); if (updateCheck.UpdateInfo != null) { Console.WriteLine($"Update available: {updateCheck.UpdateInfo.Version}"); } ``` ### Manual Update Management ```csharp // Disable auto-download for manual control Electron.AutoUpdater.AutoDownload = false; // Check for updates var result = await Electron.AutoUpdater.CheckForUpdatesAsync(); if (result.UpdateInfo != null) { Console.WriteLine($"Update found: {result.UpdateInfo.Version}"); // Ask user confirmation var confirmResult = await Electron.Dialog.ShowMessageBoxAsync( "Update Available", $"Version {result.UpdateInfo.Version} is available. Download now?"); if (confirmResult.Response == 1) // Yes { // Download update manually var downloadPath = await Electron.AutoUpdater.DownloadUpdateAsync(); Console.WriteLine($"Downloaded to: {downloadPath}"); // Install update Electron.AutoUpdater.QuitAndInstall(); } } ``` ### Update Event Handling ```csharp // Handle update events Electron.AutoUpdater.OnCheckingForUpdate += () => { Console.WriteLine("Checking for updates..."); }; Electron.AutoUpdater.OnUpdateAvailable += (updateInfo) => { Console.WriteLine($"Update available: {updateInfo.Version}"); }; Electron.AutoUpdater.OnUpdateNotAvailable += (updateInfo) => { Console.WriteLine("No updates available"); }; Electron.AutoUpdater.OnDownloadProgress += (progressInfo) => { Console.WriteLine($"Download progress: {progressInfo.Percent}%"); }; Electron.AutoUpdater.OnUpdateDownloaded += (updateInfo) => { Console.WriteLine($"Update downloaded: {updateInfo.Version}"); // Show notification to user Electron.Notification.Show(new NotificationOptions { Title = "Update Downloaded", Body = $"Version {updateInfo.Version} is ready to install.", Actions = new[] { new NotificationAction { Text = "Install Now", Type = NotificationActionType.Button }, new NotificationAction { Text = "Later", Type = NotificationActionType.Button } } }); }; Electron.AutoUpdater.OnError += (error) => { Console.WriteLine($"Update error: {error}"); Electron.Dialog.ShowErrorBox("Update Error", $"Failed to update: {error}"); }; ``` ### GitHub Provider Configuration ```csharp // Configure for GitHub releases Electron.AutoUpdater.AllowPrerelease = true; // Allow pre-release versions Electron.AutoUpdater.FullChangelog = true; // Get full changelog Electron.AutoUpdater.AllowDowngrade = false; // Prevent downgrades // Set request headers if needed Electron.AutoUpdater.RequestHeaders = new Dictionary { ["Authorization"] = "token your-github-token", ["User-Agent"] = "MyApp-Updater" }; ``` ### Update Installation ```csharp // Install update immediately if (updateDownloaded) { Electron.AutoUpdater.QuitAndInstall(); } // Silent install (Windows only) Electron.AutoUpdater.QuitAndInstall(isSilent: true, isForceRunAfter: true); ``` ### Version Management ```csharp // Get current version var currentVersion = await Electron.AutoUpdater.CurrentVersionAsync; Console.WriteLine($"Current version: {currentVersion}"); // Get update channel var channel = await Electron.AutoUpdater.ChannelAsync; Console.WriteLine($"Update channel: {channel}"); // Set custom feed URL // Note: This would typically be configured in electron-builder.json var feedUrl = await Electron.AutoUpdater.GetFeedURLAsync(); Console.WriteLine($"Feed URL: {feedUrl}"); ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle events during updates - [Electron.Notification](Notification.md) - Notify users about update status - [Electron.Dialog](Dialog.md) - Show update confirmation dialogs ## Additional Resources - [Electron AutoUpdater Documentation](https://electronjs.org/docs/api/auto-updater) - Official Electron auto-updater API ================================================ FILE: docs/API/Clipboard.md ================================================ # Electron.Clipboard Perform copy and paste operations on the system clipboard. ## Overview The `Electron.Clipboard` API provides comprehensive access to the system clipboard, supporting multiple data formats including text, HTML, RTF, images, and custom data. It enables reading from and writing to the clipboard with platform-specific behavior. ## Methods #### 🧊 `Task AvailableFormatsAsync(string type = "")` Get an array of supported formats for the clipboard type. **Parameters:** - `type` - Clipboard type **Returns:** An array of supported formats for the clipboard type. #### 🧊 `void Clear(string type = "")` Clears the clipboard content. **Parameters:** - `type` - Clipboard type #### 🧊 `Task ReadBookmarkAsync()` Returns an Object containing title and url keys representing the bookmark in the clipboard. The title and url values will be empty strings when the bookmark is unavailable. **Returns:** Object containing title and url keys representing the bookmark in the clipboard. #### 🧊 `Task ReadFindTextAsync()` macOS: The text on the find pasteboard. This method uses synchronous IPC when called from the renderer process. The cached value is reread from the find pasteboard whenever the application is activated. **Returns:** The text on the find pasteboard. #### 🧊 `Task ReadHTMLAsync(string type = "")` Read the content in the clipboard as HTML markup. **Parameters:** - `type` - Clipboard type **Returns:** The content in the clipboard as markup. #### 🧊 `Task ReadImageAsync(string type = "")` Read an image from the clipboard. **Parameters:** - `type` - Clipboard type **Returns:** An image from the clipboard. #### 🧊 `Task ReadRTFAsync(string type = "")` Read the content in the clipboard as RTF. **Parameters:** - `type` - Clipboard type **Returns:** The content in the clipboard as RTF. #### 🧊 `Task ReadTextAsync(string type = "")` Read the content in the clipboard as plain text. **Parameters:** - `type` - Clipboard type **Returns:** The content in the clipboard as plain text. #### 🧊 `void Write(Data data, string type = "")` Writes data to the clipboard. **Parameters:** - `data` - Data object to write - `type` - Clipboard type #### 🧊 `void WriteBookmark(string title, string url, string type = "")` Writes the title and url into the clipboard as a bookmark. Note: Most apps on Windows don't support pasting bookmarks into them so you can use clipboard.write to write both a bookmark and fallback text to the clipboard. **Parameters:** - `title` - Bookmark title - `url` - Bookmark URL - `type` - Clipboard type #### 🧊 `void WriteFindText(string text)` macOS: Writes the text into the find pasteboard as plain text. This method uses synchronous IPC when called from the renderer process. **Parameters:** - `text` - Text to write to find pasteboard #### 🧊 `void WriteHTML(string markup, string type = "")` Writes markup to the clipboard. **Parameters:** - `markup` - HTML markup to write - `type` - Clipboard type #### 🧊 `void WriteImage(NativeImage image, string type = "")` Writes an image to the clipboard. **Parameters:** - `image` - Image to write to clipboard - `type` - Clipboard type #### 🧊 `void WriteRTF(string text, string type = "")` Writes the text into the clipboard in RTF. **Parameters:** - `text` - RTF content to write - `type` - Clipboard type #### 🧊 `void WriteText(string text, string type = "")` Writes the text into the clipboard as plain text. **Parameters:** - `text` - Text content to write - `type` - Clipboard type ## Usage Examples ### Basic Text Operations ```csharp // Read text from clipboard var text = await Electron.Clipboard.ReadTextAsync(); Console.WriteLine($"Clipboard text: {text}"); // Write text to clipboard Electron.Clipboard.WriteText("Hello, Electron.NET!"); // Read with specific type var html = await Electron.Clipboard.ReadHTMLAsync("public.main"); ``` ### Rich Content Handling ```csharp // Copy formatted text var htmlContent = "

Title

Some bold text

"; Electron.Clipboard.WriteHTML(htmlContent); // Read RTF content var rtf = await Electron.Clipboard.ReadRTFAsync(); Console.WriteLine($"RTF content: {rtf}"); ``` ### Image Operations ```csharp // Read image from clipboard var image = await Electron.Clipboard.ReadImageAsync(); if (image != null) { Console.WriteLine($"Image size: {image.Size.Width}x{image.Size.Height}"); } // Write image to clipboard var nativeImage = NativeImage.CreateFromPath("screenshot.png"); Electron.Clipboard.WriteImage(nativeImage); ``` ### Bookmark Management ```csharp // Read bookmark from clipboard var bookmark = await Electron.Clipboard.ReadBookmarkAsync(); if (!string.IsNullOrEmpty(bookmark.Title)) { Console.WriteLine($"Bookmark: {bookmark.Title} -> {bookmark.Url}"); } // Write bookmark to clipboard Electron.Clipboard.WriteBookmark("Electron.NET", "https://github.com/ElectronNET/Electron.NET"); ``` ### Advanced Clipboard Operations ```csharp // Check available formats var formats = await Electron.Clipboard.AvailableFormatsAsync(); Console.WriteLine($"Available formats: {string.Join(", ", formats)}"); // Clear clipboard Electron.Clipboard.Clear(); // Write custom data var data = new Data { Text = "Custom data", Html = "

Custom HTML

", Image = nativeImage }; Electron.Clipboard.Write(data); ``` ### macOS Find Pasteboard ```csharp // macOS specific find pasteboard operations if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { // Read find text var findText = await Electron.Clipboard.ReadFindTextAsync(); Console.WriteLine($"Find text: {findText}"); // Write find text Electron.Clipboard.WriteFindText("search term"); } ``` ## Related APIs - [Electron.Shell](Shell.md) - Work with file paths from clipboard - [Electron.Notification](Notification.md) - Show clipboard operation results ## Additional Resources - [Electron Clipboard Documentation](https://electronjs.org/docs/api/clipboard) - Official Electron clipboard API ================================================ FILE: docs/API/Dialog.md ================================================ # Electron.Dialog Display native system dialogs for opening and saving files, alerting, etc. ## Overview The `Electron.Dialog` API provides access to native system dialogs for file operations, message boxes, and certificate trust dialogs. These dialogs are modal and provide a consistent user experience across different platforms. ## Methods #### 🧊 `Task ShowMessageBoxAsync(BrowserWindow browserWindow, MessageBoxOptions messageBoxOptions)` Shows a message box, it will block the process until the message box is closed. It returns the index of the clicked button. If a callback is passed, the dialog will not block the process. **Parameters:** - `browserWindow` - The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. - `messageBoxOptions` - Message content and configuration **Returns:** The API call will be asynchronous and the result will be passed via MessageBoxResult. #### 🧊 `Task ShowMessageBoxAsync(BrowserWindow browserWindow, string message)` Shows a message box, it will block the process until the message box is closed. It returns the index of the clicked button. If a callback is passed, the dialog will not block the process. **Parameters:** - `browserWindow` - The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. - `message` - Message content **Returns:** The API call will be asynchronous and the result will be passed via MessageBoxResult. #### 🧊 `Task ShowMessageBoxAsync(MessageBoxOptions messageBoxOptions)` Shows a message box, it will block the process until the message box is closed. It returns the index of the clicked button. If a callback is passed, the dialog will not block the process. **Parameters:** - `messageBoxOptions` - Message content and configuration **Returns:** The API call will be asynchronous and the result will be passed via MessageBoxResult. #### 🧊 `Task ShowMessageBoxAsync(string message)` Shows a message box, it will block the process until the message box is closed. It returns the index of the clicked button. If a callback is passed, the dialog will not block the process. **Parameters:** - `message` - Message content **Returns:** The API call will be asynchronous and the result will be passed via MessageBoxResult. #### 🧊 `Task ShowOpenDialogAsync(BrowserWindow browserWindow, OpenDialogOptions options)` Note: On Windows and Linux an open dialog can not be both a file selector and a directory selector, so if you set properties to ['openFile', 'openDirectory'] on these platforms, a directory selector will be shown. **Parameters:** - `browserWindow` - The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. - `options` - Dialog configuration options **Returns:** An array of file paths chosen by the user #### 🧊 `Task ShowSaveDialogAsync(BrowserWindow browserWindow, SaveDialogOptions options)` Dialog for save files. **Parameters:** - `browserWindow` - The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. - `options` - Dialog configuration options **Returns:** Returns String, the path of the file chosen by the user, if a callback is provided it returns an empty string. #### 🧊 `void ShowErrorBox(string title, string content)` Displays a modal dialog that shows an error message. This API can be called safely before the ready event the app module emits, it is usually used to report errors in early stage of startup.If called before the app readyevent on Linux, the message will be emitted to stderr, and no GUI dialog will appear. **Parameters:** - `title` - The title to display in the error box. - `content` - The text content to display in the error box. #### 🧊 `Task ShowCertificateTrustDialogAsync(BrowserWindow browserWindow, CertificateTrustDialogOptions options)` On macOS, this displays a modal dialog that shows a message and certificate information, and gives the user the option of trusting/importing the certificate. If you provide a browserWindow argument the dialog will be attached to the parent window, making it modal. **Parameters:** - `browserWindow` - Parent window for modal behavior - `options` - Certificate trust dialog options #### 🧊 `Task ShowCertificateTrustDialogAsync(CertificateTrustDialogOptions options)` On macOS, this displays a modal dialog that shows a message and certificate information, and gives the user the option of trusting/importing the certificate. If you provide a browserWindow argument the dialog will be attached to the parent window, making it modal. **Parameters:** - `options` - Certificate trust dialog options ## Usage Examples ### File Operations ```csharp // Open multiple files var files = await Electron.Dialog.ShowOpenDialogAsync(window, new OpenDialogOptions { Properties = new[] { OpenDialogProperty.OpenFile, OpenDialogProperty.MultiSelections } }); // Save with custom extension var path = await Electron.Dialog.ShowSaveDialogAsync(window, new SaveDialogOptions { DefaultPath = "backup.json", Filters = new[] { new FileFilter { Name = "JSON", Extensions = new[] { "json" } } } }); ``` ### User Confirmation ```csharp // Confirmation dialog var result = await Electron.Dialog.ShowMessageBoxAsync(window, new MessageBoxOptions { Type = MessageBoxType.Question, Title = "Confirm Delete", Message = $"Delete {filename}?", Buttons = new[] { "Cancel", "Delete" }, DefaultId = 0, CancelId = 0 }); if (result.Response == 1) { // Delete file } ``` ### Error Handling ```csharp // Error dialog Electron.Dialog.ShowErrorBox("Save Failed", "Could not save file. Please check permissions and try again."); // Warning dialog await Electron.Dialog.ShowMessageBoxAsync(new MessageBoxOptions { Type = MessageBoxType.Warning, Title = "Warning", Message = "This operation may take several minutes.", Buttons = new[] { "Continue", "Cancel" } }); ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Parent windows for modal dialogs - [Electron.App](App.md) - Application lifecycle events - [Electron.Shell](Shell.md) - File operations with selected paths ## Additional Resources - [Electron Dialog Documentation](https://electronjs.org/docs/api/dialog) - Official Electron dialog API ================================================ FILE: docs/API/Dock.md ================================================ # Electron.Dock Control your app in the macOS dock. ## Overview The `Electron.Dock` API provides control over your application's appearance and behavior in the macOS dock. This includes bouncing the dock icon, setting badges, managing menus, and controlling visibility. ## Properties #### 📋 `IReadOnlyCollection MenuItems` Gets a read-only collection of all current dock menu items. ## Methods #### 🧊 `Task BounceAsync(DockBounceType type, CancellationToken cancellationToken = default)` When `DockBounceType.Critical` is passed, the dock icon will bounce until either the application becomes active or the request is canceled. When `DockBounceType.Informational` is passed, the dock icon will bounce for one second. However, the request remains active until either the application becomes active or the request is canceled. Note: This method can only be used while the app is not focused; when the app is focused it will return -1. **Parameters:** - `type` - Can be critical or informational. The default is informational. - `cancellationToken` - The cancellation token **Returns:** An ID representing the request. #### 🧊 `void CancelBounce(int id)` Cancel the bounce of id. **Parameters:** - `id` - Id of the request #### 🧊 `void DownloadFinished(string filePath)` Bounces the Downloads stack if the filePath is inside the Downloads folder. **Parameters:** - `filePath` - Path to the downloaded file #### 🧊 `Task GetBadgeAsync(CancellationToken cancellationToken = default)` Gets the string to be displayed in the dock's badging area. **Returns:** The badge string of the dock. #### 🧊 `Task GetMenu(CancellationToken cancellationToken = default)` Gets the application's dock menu. **Returns:** The application's dock menu. #### 🧊 `void Hide()` Hides the dock icon. #### 🧊 `Task IsVisibleAsync(CancellationToken cancellationToken = default)` Whether the dock icon is visible. The app.dock.show() call is asynchronous so this method might not return true immediately after that call. **Returns:** Whether the dock icon is visible. #### 🧊 `void SetBadge(string text)` Sets the string to be displayed in the dock's badging area. **Parameters:** - `text` - Badge text to display #### 🧊 `void SetIcon(string image)` Sets the image associated with this dock icon. **Parameters:** - `image` - Icon image path #### 🧊 `void SetMenu(MenuItem[] menuItems)` Sets the application's dock menu. **Parameters:** - `menuItems` - Array of menu items for the dock menu #### 🧊 `void Show()` Shows the dock icon. ## Usage Examples ### Basic Dock Operations ```csharp // Hide/Show dock icon Electron.Dock.Hide(); await Task.Delay(2000); Electron.Dock.Show(); // Check visibility var isVisible = await Electron.Dock.IsVisibleAsync(); Console.WriteLine($"Dock visible: {isVisible}"); ``` ### Badge Notifications ```csharp // Set badge count Electron.Dock.SetBadge("5"); // Get current badge var badge = await Electron.Dock.GetBadgeAsync(); Console.WriteLine($"Current badge: {badge}"); // Clear badge Electron.Dock.SetBadge(""); ``` ### Dock Icon Animation ```csharp // Bounce for attention var bounceId = await Electron.Dock.BounceAsync(DockBounceType.Critical); Console.WriteLine($"Bounce ID: {bounceId}"); // Cancel bounce after 3 seconds await Task.Delay(3000); Electron.Dock.CancelBounce(bounceId); // Informational bounce await Electron.Dock.BounceAsync(DockBounceType.Informational); ``` ### Dock Menu ```csharp // Create dock menu var dockMenuItems = new[] { new MenuItem { Label = "Show Window", Click = () => ShowMainWindow() }, new MenuItem { Label = "Settings", Click = () => OpenSettings() }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Label = "Exit", Click = () => Electron.App.Quit() } }; // Set dock menu Electron.Dock.SetMenu(dockMenuItems); // Get current menu var currentMenu = await Electron.Dock.GetMenu(); Console.WriteLine($"Menu items: {Electron.Dock.MenuItems.Count}"); ``` ### Download Notifications ```csharp // Notify about completed download var downloadPath = "/Users/username/Downloads/document.pdf"; Electron.Dock.DownloadFinished(downloadPath); ``` ### Custom Dock Icon ```csharp // Set custom dock icon Electron.Dock.SetIcon("assets/custom-dock-icon.png"); // Set icon based on status if (isConnected) { Electron.Dock.SetIcon("assets/connected-icon.png"); } else { Electron.Dock.SetIcon("assets/disconnected-icon.png"); } ``` ### Application Integration ```csharp // Update dock badge based on unread count UpdateDockBadge(unreadMessageCount); void UpdateDockBadge(int count) { if (count > 0) { Electron.Dock.SetBadge(count.ToString()); } else { Electron.Dock.SetBadge(""); } } // Animate dock when receiving message private async void OnMessageReceived() { await Electron.Dock.BounceAsync(DockBounceType.Informational); Electron.Dock.SetBadge((unreadCount + 1).ToString()); } ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle events - [Electron.Notification](Notification.md) - Desktop notifications - [Electron.Menu](Menu.md) - Menu items for dock menu ## Additional Resources - [Electron Dock Documentation](https://electronjs.org/docs/api/dock) - Official Electron dock API ================================================ FILE: docs/API/GlobalShortcut.md ================================================ # Electron.GlobalShortcut Register global keyboard shortcuts that work even when the application is not focused. ## Overview The `Electron.GlobalShortcut` API provides the ability to register global keyboard shortcuts that can be triggered even when the application does not have keyboard focus. This is useful for creating system-wide hotkeys and shortcuts. ## Methods #### 🧊 `Task IsRegisteredAsync(string accelerator)` Check if the accelerator is registered. **Parameters:** - `accelerator` - Keyboard shortcut to check **Returns:** Whether this application has registered the accelerator. #### 🧊 `void Register(string accelerator, Action function)` Registers a global shortcut of accelerator. The callback is called when the registered shortcut is pressed by the user. **Parameters:** - `accelerator` - Keyboard shortcut combination - `function` - Callback function to execute when shortcut is pressed #### 🧊 `void Unregister(string accelerator)` Unregisters the global shortcut of accelerator. **Parameters:** - `accelerator` - Keyboard shortcut to unregister #### 🧊 `void UnregisterAll()` Unregisters all of the global shortcuts. ## Usage Examples ### Basic Global Shortcuts ```csharp // Register global shortcuts Electron.GlobalShortcut.Register("CommandOrControl+N", () => { CreateNewDocument(); }); Electron.GlobalShortcut.Register("CommandOrControl+O", () => { OpenDocument(); }); Electron.GlobalShortcut.Register("CommandOrControl+S", () => { SaveDocument(); }); ``` ### Media Control Shortcuts ```csharp // Media playback shortcuts Electron.GlobalShortcut.Register("MediaPlayPause", () => { TogglePlayback(); }); Electron.GlobalShortcut.Register("MediaNextTrack", () => { NextTrack(); }); Electron.GlobalShortcut.Register("MediaPreviousTrack", () => { PreviousTrack(); }); ``` ### Application Control Shortcuts ```csharp // Application control shortcuts Electron.GlobalShortcut.Register("CommandOrControl+Shift+Q", async () => { var result = await Electron.Dialog.ShowMessageBoxAsync("Quit Application?", "Are you sure you want to quit?"); if (result.Response == 1) // Yes { Electron.App.Quit(); } }); Electron.GlobalShortcut.Register("CommandOrControl+Shift+H", () => { ToggleMainWindow(); }); ``` ### Dynamic Shortcut Management ```csharp // Register shortcuts based on user preferences public void RegisterUserShortcuts(Dictionary shortcuts) { foreach (var shortcut in shortcuts) { Electron.GlobalShortcut.Register(shortcut.Key, shortcut.Value); } } // Check if shortcut is available public async Task IsShortcutAvailable(string accelerator) { return await Electron.GlobalShortcut.IsRegisteredAsync(accelerator); } // Unregister specific shortcut public void UnregisterShortcut(string accelerator) { Electron.GlobalShortcut.Unregister(accelerator); } ``` ### Platform-Specific Shortcuts ```csharp // macOS specific shortcuts if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { Electron.GlobalShortcut.Register("Command+Comma", () => { OpenPreferences(); }); Electron.GlobalShortcut.Register("Command+H", () => { Electron.App.Hide(); }); } // Windows/Linux shortcuts else { Electron.GlobalShortcut.Register("Ctrl+Shift+P", () => { OpenPreferences(); }); Electron.GlobalShortcut.Register("Alt+F4", () => { Electron.App.Quit(); }); } ``` ### Shortcut Validation ```csharp // Validate shortcuts before registration public async Task TryRegisterShortcut(string accelerator, Action callback) { if (await Electron.GlobalShortcut.IsRegisteredAsync(accelerator)) { Console.WriteLine($"Shortcut {accelerator} is already registered"); return false; } try { Electron.GlobalShortcut.Register(accelerator, callback); Console.WriteLine($"Successfully registered shortcut: {accelerator}"); return true; } catch (Exception ex) { Console.WriteLine($"Failed to register shortcut {accelerator}: {ex.Message}"); return false; } } ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle events - [Electron.Menu](Menu.md) - Menu-based shortcuts - [Electron.WindowManager](WindowManager.md) - Window focus management ## Additional Resources - [Electron GlobalShortcut Documentation](https://electronjs.org/docs/api/global-shortcut) - Official Electron global shortcut API ================================================ FILE: docs/API/HostHook.md ================================================ # Electron.HostHook Execute native JavaScript/TypeScript code from the host process. ## Overview The `Electron.HostHook` API allows you to execute native JavaScript/TypeScript code from the host process. This enables advanced integration scenarios where you need to run custom JavaScript code or access Node.js APIs directly. ## Methods #### 🧊 `void Call(string socketEventName, params dynamic[] arguments)` Execute native JavaScript/TypeScript code synchronously. **Parameters:** - `socketEventName` - Socket name registered on the host - `arguments` - Optional parameters #### 🧊 `Task CallAsync(string socketEventName, params dynamic[] arguments)` Execute native JavaScript/TypeScript code asynchronously with type-safe return values. **Parameters:** - `T` - Expected return type - `socketEventName` - Socket name registered on the host - `arguments` - Optional parameters **Returns:** Task with the result from the executed host code. ## Usage Examples ### Basic Host Hook Execution ```csharp // Execute simple JavaScript function Electron.HostHook.Call("myFunction", "parameter1", 42); // Execute with callback-style result var result = await Electron.HostHook.CallAsync("getUserName", userId); Console.WriteLine($"User name: {result}"); ``` ### Advanced Integration ```csharp // Call custom Electron API var fileContent = await Electron.HostHook.CallAsync("readFile", "config.json"); Console.WriteLine($"Config: {fileContent}"); // Execute with multiple parameters var processedData = await Electron.HostHook.CallAsync("processData", rawData, options); // Call with complex objects var settings = new { theme = "dark", language = "en" }; var updatedSettings = await Electron.HostHook.CallAsync("updateSettings", settings); ``` ### Error Handling ```csharp try { // Execute host function with error handling var result = await Electron.HostHook.CallAsync("riskyOperation", inputData); Console.WriteLine($"Success: {result}"); } catch (Exception ex) { // Handle execution errors Console.WriteLine($"Host hook error: {ex.Message}"); Electron.Dialog.ShowErrorBox("Operation Failed", "Could not execute host function."); } ``` ### Type-Safe Operations ```csharp // Strongly typed return values var userInfo = await Electron.HostHook.CallAsync("getUserInfo", userId); Console.WriteLine($"User: {userInfo.Name}, Email: {userInfo.Email}"); // Array results var fileList = await Electron.HostHook.CallAsync("listFiles", directoryPath); foreach (var file in fileList) { Console.WriteLine($"File: {file}"); } // Complex object results var systemStats = await Electron.HostHook.CallAsync("getSystemStats"); Console.WriteLine($"CPU: {systemStats.CpuUsage}%, Memory: {systemStats.MemoryUsage}%"); ``` ### Custom ElectronHostHook Setup ```csharp // In your ElectronHostHook/index.ts import { app } from 'electron'; export function getAppVersion(): string { return app.getVersion(); } export async function readConfigFile(): Promise { const fs = require('fs').promises; return await fs.readFile('config.json', 'utf8'); } export function customNotification(message: string): void { // Custom notification logic console.log(`Custom notification: ${message}`); } ``` ### Integration with .NET Code ```csharp // Use host hook in your application logic public async Task GetApplicationVersion() { return await Electron.HostHook.CallAsync("getAppVersion"); } public async Task LoadConfiguration() { try { var config = await Electron.HostHook.CallAsync("readConfigFile"); ApplyConfiguration(config); } catch (Exception ex) { Console.WriteLine($"Failed to load config: {ex.Message}"); UseDefaultConfiguration(); } } public void ShowCustomNotification(string message) { Electron.HostHook.Call("customNotification", message); } ``` ## Related APIs - [Electron.IpcMain](IpcMain.md) - Inter-process communication - [Electron.App](App.md) - Application lifecycle events - [Electron.WebContents](WebContents.md) - Web content integration ## Additional Resources - [Host Hook Documentation](../Core/Advanced-Migration-Topics.md) - Setting up custom host hooks ================================================ FILE: docs/API/IpcMain.md ================================================ # Electron.IpcMain Communicate asynchronously from the main process to renderer processes. ## Overview The `Electron.IpcMain` API provides inter-process communication between the main process and renderer processes. It allows you to send messages, listen for events, and handle communication between different parts of your Electron application. ## Methods #### 🧊 `Task On(string channel, Action listener)` Listens to channel, when a new message arrives listener would be called with listener(event, args...). **Parameters:** - `channel` - Channel name to listen on - `listener` - Callback method to handle incoming messages #### 🧊 `void OnSync(string channel, Func listener)` Send a message to the renderer process synchronously via channel. Note: Sending a synchronous message will block the whole renderer process. **Parameters:** - `channel` - Channel name to listen on - `listener` - Synchronous callback method #### 🧊 `void Once(string channel, Action listener)` Adds a one time listener method for the event. This listener is invoked only the next time a message is sent to channel, after which it is removed. **Parameters:** - `channel` - Channel name to listen on - `listener` - Callback method to handle the message once #### 🧊 `void RemoveAllListeners(string channel)` Removes all listeners of the specified channel. **Parameters:** - `channel` - Channel name to remove listeners from #### 🧊 `void Send(BrowserView browserView, string channel, params object[] data)` Send a message to the BrowserView renderer process asynchronously via channel. **Parameters:** - `browserView` - Target browser view - `channel` - Channel name to send on - `data` - Arguments to send #### 🧊 `void Send(BrowserWindow browserWindow, string channel, params object[] data)` Send a message to the renderer process asynchronously via channel. **Parameters:** - `browserWindow` - Target browser window - `channel` - Channel name to send on - `data` - Arguments to send ## Usage Examples ### Basic Message Handling ```csharp // Listen for messages from renderer await Electron.IpcMain.On("request-data", (args) => { Console.WriteLine($"Received request: {args}"); // Process the request and send response }); // Send response back to renderer Electron.IpcMain.Send(mainWindow, "data-response", processedData); ``` ### Synchronous Communication ```csharp // Handle synchronous requests Electron.IpcMain.OnSync("get-user-info", (request) => { var userId = request.ToString(); var userInfo = GetUserInfo(userId); return userInfo; }); ``` ### One-time Event Handling ```csharp // Handle initialization request once Electron.IpcMain.Once("app-initialized", (args) => { Console.WriteLine("App initialized, setting up..."); InitializeApplication(); }); ``` ### Complex Data Exchange ```csharp // Send complex data to renderer var appData = new { Version = "1.0.0", Features = new[] { "feature1", "feature2" }, Settings = new { Theme = "dark", Language = "en" } }; Electron.IpcMain.Send(mainWindow, "app-config", appData); // Listen for settings updates await Electron.IpcMain.On("update-settings", (settings) => { var config = JsonConvert.DeserializeObject(settings.ToString()); ApplySettings(config); }); ``` ### Multi-Window Communication ```csharp // Send message to specific window var settingsWindow = await Electron.WindowManager.CreateWindowAsync(); Electron.IpcMain.Send(settingsWindow, "show-settings", currentSettings); // Broadcast to all windows foreach (var window in Electron.WindowManager.BrowserWindows) { Electron.IpcMain.Send(window, "notification", message); } ``` ### Error Handling ```csharp // Handle IPC errors gracefully await Electron.IpcMain.On("risky-operation", async (args) => { try { var result = await PerformRiskyOperation(args); Electron.IpcMain.Send(mainWindow, "operation-success", result); } catch (Exception ex) { Electron.IpcMain.Send(mainWindow, "operation-error", ex.Message); } }); ``` ### Integration with Host Hooks ```csharp // Use with custom host functionality await Electron.IpcMain.On("execute-host-function", async (args) => { var functionName = args.ToString(); var result = await Electron.HostHook.CallAsync(functionName); Electron.IpcMain.Send(mainWindow, "function-result", result); }); ``` ## Related APIs - [Electron.HostHook](HostHook.md) - Execute custom JavaScript functions - [Electron.WindowManager](WindowManager.md) - Target specific windows for communication - [Electron.WebContents](WebContents.md) - Send messages to web content ## Additional Resources - [Electron IPC Documentation](https://electronjs.org/docs/api/ipc-main) - Official Electron IPC API ================================================ FILE: docs/API/Menu.md ================================================ # Electron.Menu Create application menus, context menus, and menu items with full keyboard shortcut support. ## Overview The `Electron.Menu` API provides comprehensive control over application menus and context menus. It supports native platform menus with custom menu items, submenus, keyboard shortcuts, and role-based menu items. ## Properties #### 📋 `IReadOnlyDictionary> ContextMenuItems` Gets a read-only dictionary of all current context menu items, keyed by browser window ID. #### 📋 `IReadOnlyCollection MenuItems` Gets a read-only collection of all current application menu items. ## Methods #### 🧊 `void ContextMenuPopup(BrowserWindow browserWindow)` Shows the context menu for the specified browser window. **Parameters:** - `browserWindow` - The browser window to show the context menu for #### 🧊 `void SetApplicationMenu(MenuItem[] menuItems)` Sets the application menu for the entire application. **Parameters:** - `menuItems` - Array of MenuItem objects defining the application menu #### 🧊 `void SetContextMenu(BrowserWindow browserWindow, MenuItem[] menuItems)` Sets a context menu for a specific browser window. **Parameters:** - `browserWindow` - The browser window to attach the context menu to - `menuItems` - Array of MenuItem objects defining the context menu ## Usage Examples ### Application Menu ```csharp // Create application menu var menuItems = new[] { new MenuItem { Label = "File", Submenu = new[] { new MenuItem { Label = "New", Click = () => CreateNewDocument() }, new MenuItem { Label = "Open", Click = () => OpenDocument() }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Label = "Exit", Click = () => Electron.App.Quit() } } }, new MenuItem { Label = "Edit", Submenu = new[] { new MenuItem { Role = MenuRole.Undo }, new MenuItem { Role = MenuRole.Redo }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Role = MenuRole.Cut }, new MenuItem { Role = MenuRole.Copy }, new MenuItem { Role = MenuRole.Paste } } }, new MenuItem { Label = "View", Submenu = new[] { new MenuItem { Role = MenuRole.Reload }, new MenuItem { Role = MenuRole.ForceReload }, new MenuItem { Role = MenuRole.ToggleDevTools }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Role = MenuRole.ResetZoom }, new MenuItem { Role = MenuRole.ZoomIn }, new MenuItem { Role = MenuRole.ZoomOut } } }, new MenuItem { Label = "Window", Submenu = new[] { new MenuItem { Role = MenuRole.Minimize }, new MenuItem { Role = MenuRole.Close } } } }; // Set application menu Electron.Menu.SetApplicationMenu(menuItems); ``` ### Context Menu ```csharp // Create context menu for specific window var contextMenuItems = new[] { new MenuItem { Label = "Copy", Click = () => CopySelectedText() }, new MenuItem { Label = "Paste", Click = () => PasteText() }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Label = "Inspect Element", Click = () => InspectElement() } }; // Set context menu for window Electron.Menu.SetContextMenu(mainWindow, contextMenuItems); // Show context menu programmatically Electron.Menu.ContextMenuPopup(mainWindow); ``` ### Menu with Keyboard Shortcuts ```csharp // Create menu with keyboard shortcuts var menuItems = new[] { new MenuItem { Label = "File", Submenu = new[] { new MenuItem { Label = "New", Accelerator = "CmdOrCtrl+N", Click = () => CreateNewDocument() }, new MenuItem { Label = "Open", Accelerator = "CmdOrCtrl+O", Click = () => OpenDocument() }, new MenuItem { Label = "Save", Accelerator = "CmdOrCtrl+S", Click = () => SaveDocument() } } } }; Electron.Menu.SetApplicationMenu(menuItems); ``` ### Dynamic Menu Updates ```csharp // Update menu items dynamically var fileMenu = Electron.Menu.MenuItems.FirstOrDefault(m => m.Label == "File"); if (fileMenu?.Submenu != null) { var saveItem = fileMenu.Submenu.FirstOrDefault(m => m.Label == "Save"); if (saveItem != null) { saveItem.Enabled = HasUnsavedChanges; } } ``` ### Platform-Specific Menus ```csharp // macOS specific menu items if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { var macMenuItems = new[] { new MenuItem { Label = "MyApp", Submenu = new[] { new MenuItem { Role = MenuRole.About }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Role = MenuRole.Services }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Role = MenuRole.Hide }, new MenuItem { Role = MenuRole.HideOthers }, new MenuItem { Role = MenuRole.Unhide }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Role = MenuRole.Quit } } } }; // Insert before File menu var allMenus = new List(macMenuItems); allMenus.AddRange(menuItems); Electron.Menu.SetApplicationMenu(allMenus.ToArray()); } ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Windows for context menus - [Electron.App](App.md) - Application lifecycle events - [Electron.GlobalShortcut](GlobalShortcut.md) - Global keyboard shortcuts ## Additional Resources - [Electron Menu Documentation](https://electronjs.org/docs/api/menu) - Official Electron menu API ================================================ FILE: docs/API/NativeTheme.md ================================================ # Electron.NativeTheme Detect and respond to changes in Chromium's native color theme. ## Overview The `Electron.NativeTheme` API provides access to Chromium's native color theme information and allows you to detect and respond to changes in the system's dark/light mode settings. This enables your application to automatically adapt to the user's theme preferences. ## Methods #### 🧊 `Task GetThemeSourceAsync()` Get the current theme source setting. **Returns:** A `ThemeSourceMode` property that can be `ThemeSourceMode.System`, `ThemeSourceMode.Light` or `ThemeSourceMode.Dark`. #### 🧊 `void SetThemeSource(ThemeSourceMode themeSourceMode)` Setting this property to `ThemeSourceMode.System` will remove the override and everything will be reset to the OS default. By default 'ThemeSource' is `ThemeSourceMode.System`. **Parameters:** - `themeSourceMode` - The new ThemeSource #### 🧊 `Task ShouldUseDarkColorsAsync()` Check if the system is currently using dark colors. **Returns:** A bool for if the OS / Chromium currently has a dark mode enabled or is being instructed to show a dark-style UI. #### 🧊 `Task ShouldUseHighContrastColorsAsync()` Check if the system is currently using high contrast colors. **Returns:** A bool for if the OS / Chromium currently has high-contrast mode enabled or is being instructed to show a high-contrast UI. #### 🧊 `Task ShouldUseInvertedColorSchemeAsync()` Check if the system is currently using an inverted color scheme. **Returns:** A bool for if the OS / Chromium currently has an inverted color scheme or is being instructed to use an inverted color scheme. ## Events #### ⚡ `Updated` Emitted when something in the underlying NativeTheme has changed. This normally means that either the value of ShouldUseDarkColorsAsync, ShouldUseHighContrastColorsAsync or ShouldUseInvertedColorSchemeAsync has changed. ## Usage Examples ### Basic Theme Detection ```csharp // Check current theme var isDarkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); Console.WriteLine($"Dark mode: {isDarkMode}"); // Get current theme source var themeSource = await Electron.NativeTheme.GetThemeSourceAsync(); Console.WriteLine($"Theme source: {themeSource}"); ``` ### Theme Change Monitoring ```csharp // Monitor theme changes Electron.NativeTheme.Updated += () => { Console.WriteLine("Theme updated"); UpdateApplicationTheme(); }; async void UpdateApplicationTheme() { var isDarkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); var isHighContrast = await Electron.NativeTheme.ShouldUseHighContrastColorsAsync(); // Update application appearance ApplyTheme(isDarkMode, isHighContrast); } ``` ### Manual Theme Control ```csharp // Force dark theme Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Dark); // Force light theme Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Light); // Follow system theme Electron.NativeTheme.SetThemeSource(ThemeSourceMode.System); ``` ### Application Theme Integration ```csharp public async Task InitializeThemeSupport() { // Set initial theme based on system preference var isDarkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); ApplyTheme(isDarkMode); // Monitor theme changes Electron.NativeTheme.Updated += async () => { var darkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); ApplyTheme(darkMode); }; } private void ApplyTheme(bool isDarkMode) { if (isDarkMode) { // Apply dark theme SetDarkThemeColors(); UpdateWindowTheme("dark"); } else { // Apply light theme SetLightThemeColors(); UpdateWindowTheme("light"); } } ``` ### Advanced Theme Management ```csharp // Check all theme properties var isDarkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); var isHighContrast = await Electron.NativeTheme.ShouldUseHighContrastColorsAsync(); var isInverted = await Electron.NativeTheme.ShouldUseInvertedColorSchemeAsync(); Console.WriteLine($"Dark mode: {isDarkMode}"); Console.WriteLine($"High contrast: {isHighContrast}"); Console.WriteLine($"Inverted: {isInverted}"); // Apply appropriate theme if (isHighContrast) { ApplyHighContrastTheme(); } else if (isDarkMode) { ApplyDarkTheme(); } else { ApplyLightTheme(); } ``` ### Theme-Aware Window Creation ```csharp // Create window with theme-appropriate settings var isDarkMode = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); var windowOptions = new BrowserWindowOptions { Width = 1200, Height = 800, Title = "My Application", BackgroundColor = isDarkMode ? "#1a1a1a" : "#ffffff", WebPreferences = new WebPreferences { // Additional web preferences based on theme } }; var window = await Electron.WindowManager.CreateWindowAsync(windowOptions); ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Apply theme to windows - [Electron.Screen](Screen.md) - Screen-related theme considerations - [Electron.App](App.md) - Application-level theme events ## Additional Resources - [Electron NativeTheme Documentation](https://electronjs.org/docs/api/native-theme) - Official Electron native theme API - [Theme Support](../Core/What's-New.md) - Understanding theme functionality - [User Experience](../Using/Configuration.md) - Design theme-aware applications ================================================ FILE: docs/API/Notification.md ================================================ # Electron.Notification Show native desktop notifications with custom content and actions. ## Overview The `Electron.Notification` API provides the ability to show native desktop notifications with custom titles, bodies, icons, and actions. Notifications work across Windows, macOS, and Linux with platform-specific behavior. ## Methods #### 🧊 `Task IsSupportedAsync()` Check if desktop notifications are supported on the current platform. **Returns:** Whether or not desktop notifications are supported on the current system. #### 🧊 `void Show(NotificationOptions notificationOptions)` Create OS desktop notifications with the specified options. **Parameters:** - `notificationOptions` - Notification configuration options ## Usage Examples ### Basic Notification ```csharp // Simple notification Electron.Notification.Show(new NotificationOptions { Title = "My Application", Body = "This is a notification message", Icon = "assets/notification-icon.png" }); ``` ### Notification with Actions ```csharp // Notification with reply action Electron.Notification.Show(new NotificationOptions { Title = "New Message", Body = "You have a new message from John", Icon = "assets/message-icon.png", Actions = new[] { new NotificationAction { Text = "Reply", Type = NotificationActionType.Button }, new NotificationAction { Text = "View", Type = NotificationActionType.Button } }, OnClick = () => OpenMessageWindow(), OnAction = (action) => { if (action == "Reply") { ShowReplyDialog(); } else if (action == "View") { OpenMessageWindow(); } } }); ``` ### Rich Notifications ```csharp // Rich notification with all options Electron.Notification.Show(new NotificationOptions { Title = "Download Complete", Subtitle = "Your file has finished downloading", Body = "document.pdf has been downloaded to your Downloads folder.", Icon = "assets/download-icon.png", ImageUrl = "file://" + Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "assets/preview.png"), Sound = NotificationSound.Default, Urgency = NotificationUrgency.Normal, Category = "transfer.complete", Tag = "download-123", Actions = new[] { new NotificationAction { Text = "Open", Type = NotificationActionType.Button }, new NotificationAction { Text = "Show in Folder", Type = NotificationActionType.Button } }, OnShow = () => Console.WriteLine("Notification shown"), OnClick = () => OpenDownloadedFile(), OnClose = () => Console.WriteLine("Notification closed"), OnAction = (action) => { if (action == "Open") { OpenDownloadedFile(); } else if (action == "Show in Folder") { ShowInFolder(); } } }); ``` ### Platform-Specific Notifications ```csharp // Windows toast notification if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { Electron.Notification.Show(new NotificationOptions { Title = "Background Task", Body = "Your backup is complete", Icon = "assets/app-icon.ico", Tag = "backup-complete", RequireInteraction = true }); } // macOS notification with sound else if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { Electron.Notification.Show(new NotificationOptions { Title = "Alert", Body = "Something needs your attention", Sound = NotificationSound.Default, Actions = new[] { new NotificationAction { Text = "View", Type = NotificationActionType.Button } } }); } ``` ### Notification Management ```csharp // Check notification support var isSupported = await Electron.Notification.IsSupportedAsync(); Console.WriteLine($"Notifications supported: {isSupported}"); // Create notification with events var notification = new NotificationOptions { Title = "Task Complete", Body = "Your long-running task has finished", OnShow = () => Console.WriteLine("Notification displayed"), OnClick = () => OpenTaskResults(), OnClose = () => Console.WriteLine("Notification dismissed") }; Electron.Notification.Show(notification); ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle events - [Electron.Tray](Tray.md) - System tray integration with notifications - [Electron.Screen](Screen.md) - Position notifications based on screen layout ## Additional Resources - [Electron Notification Documentation](https://electronjs.org/docs/api/notification) - Official Electron notification API ================================================ FILE: docs/API/Overview.md ================================================ # API Reference Overview The ElectronNET.Core API provides comprehensive access to Electron's native desktop functionality through a .NET interface. This section documents all the available API classes and their methods, events, and usage patterns. ## API Classes ### Core Application Management - **[Electron.App](App.md)** - Control your application's event lifecycle, manage app metadata, and handle system-level operations - **[Electron.WindowManager](WindowManager.md)** - Create and manage browser windows, control window behavior and appearance - **[Electron.Menu](Menu.md)** - Create application menus, context menus, and menu items with full keyboard shortcut support ### User Interface & Interaction - **[Electron.Dialog](Dialog.md)** - Display native system dialogs for opening/saving files, showing messages and alerts - **[Electron.Notification](Notification.md)** - Show native desktop notifications with custom content and actions - **[Electron.Tray](Tray.md)** - Create system tray icons with context menus and tooltip support - **[Electron.Dock](Dock.md)** - macOS dock integration for bounce effects and badge counts ### System Integration - **[Electron.Shell](Shell.md)** - Desktop integration for opening files, URLs, and accessing system paths - **[Electron.Clipboard](Clipboard.md)** - Read from and write to the system clipboard with multiple data formats - **[Electron.Screen](Screen.md)** - Access display and screen information for responsive layouts - **[Electron.NativeTheme](NativeTheme.md)** - Detect and respond to system theme changes (light/dark mode) ### Communication & Automation - **[Electron.IpcMain](IpcMain.md)** - Inter-process communication between main process and renderer processes - **[Electron.HostHook](HostHook.md)** - Custom host hook functionality for advanced integration scenarios - **[Electron.GlobalShortcut](GlobalShortcut.md)** - Register global keyboard shortcuts that work even when app is not focused - **[Electron.AutoUpdater](AutoUpdater.md)** - Handle application updates and installation processes ### System Monitoring - **[Electron.PowerMonitor](PowerMonitor.md)** - Monitor system power events like sleep, wake, and battery status ## API Relationships ### Window and Dialog Integration - Use `BrowserWindow` instances as parent windows for dialogs - Dialogs automatically become modal when parent window is provided - Window events coordinate with application lifecycle events ### IPC Communication - `IpcMain` handles communication from renderer processes - Use with `Electron.WindowManager` for window-specific messaging - Coordinate with `Electron.App` events for application-wide communication ### System Integration - `Shell` operations work with file paths from `Dialog` operations - `Screen` information helps create properly sized windows - `Notification` and `Tray` provide complementary user interaction methods ## 🚀 Next Steps - **[Electron.App](App.md)** - Start with application lifecycle management - **[Electron.WindowManager](WindowManager.md)** - Learn window creation and management - **[Electron.Dialog](Dialog.md)** - Add file operations and user interactions - **[Electron.Menu](Menu.md)** - Implement application menus and shortcuts ## 📚 Additional Resources - **[Electron Documentation](https://electronjs.org/docs)** - Official Electron API reference - **[Getting Started](../GettingStarted/ASP.Net.md)** - Development setup guides - **[Migration Guide](../Core/Migration-Guide.md)** - Moving from previous versions ================================================ FILE: docs/API/PowerMonitor.md ================================================ # Electron.PowerMonitor Monitor system power events like sleep, wake, and battery status. ## Overview The `Electron.PowerMonitor` API provides access to system power events and state changes. This includes monitoring when the system is going to sleep, waking up, or changing power sources. ## Events #### ⚡ `OnAC` Emitted when the system changes to AC power. #### ⚡ `OnBattery` Emitted when system changes to battery power. #### ⚡ `OnLockScreen` Emitted when the system is about to lock the screen. #### ⚡ `OnResume` Emitted when system is resuming. #### ⚡ `OnShutdown` Emitted when the system is about to reboot or shut down. #### ⚡ `OnSuspend` Emitted when the system is suspending. #### ⚡ `OnUnLockScreen` Emitted when the system is about to unlock the screen. ## Usage Examples ### Basic Power Event Monitoring ```csharp // Monitor system sleep/wake Electron.PowerMonitor.OnSuspend += () => { Console.WriteLine("System going to sleep"); // Save application state SaveApplicationState(); }; Electron.PowerMonitor.OnResume += () => { Console.WriteLine("System waking up"); // Restore application state RestoreApplicationState(); }; ``` ### Screen Lock/Unlock Monitoring ```csharp // Handle screen lock events Electron.PowerMonitor.OnLockScreen += () => { Console.WriteLine("Screen locking"); // Pause real-time operations PauseRealTimeOperations(); }; Electron.PowerMonitor.OnUnLockScreen += () => { Console.WriteLine("Screen unlocking"); // Resume real-time operations ResumeRealTimeOperations(); }; ``` ### Power Source Changes ```csharp // Monitor power source changes Electron.PowerMonitor.OnAC += () => { Console.WriteLine("Switched to AC power"); // Adjust power-intensive operations EnablePowerIntensiveFeatures(); }; Electron.PowerMonitor.OnBattery += () => { Console.WriteLine("Switched to battery power"); // Reduce power consumption EnablePowerSavingMode(); }; ``` ### System Shutdown Handling ```csharp // Handle system shutdown Electron.PowerMonitor.OnShutdown += () => { Console.WriteLine("System shutting down"); // Save critical data and exit gracefully SaveAndExit(); }; ``` ### Application State Management ```csharp private bool isSuspended = false; public void InitializePowerMonitoring() { // Track suspension state Electron.PowerMonitor.OnSuspend += () => { isSuspended = true; OnSystemSleep(); }; Electron.PowerMonitor.OnResume += () => { isSuspended = false; OnSystemWake(); }; // Handle screen lock for security Electron.PowerMonitor.OnLockScreen += () => { OnScreenLocked(); }; } private void OnSystemSleep() { // Pause network operations PauseNetworkOperations(); // Save unsaved work AutoSaveDocuments(); // Reduce resource usage MinimizeResourceUsage(); } private void OnSystemWake() { // Resume network operations ResumeNetworkOperations(); // Check for updates CheckForUpdates(); // Restore full functionality RestoreFullFunctionality(); } private void OnScreenLocked() { // Hide sensitive information HideSensitiveData(); // Pause real-time features PauseRealTimeFeatures(); } ``` ### Battery Status Monitoring ```csharp // Monitor battery status changes Electron.PowerMonitor.OnAC += () => { Console.WriteLine("Plugged in - full performance mode"); EnableFullPerformanceMode(); }; Electron.PowerMonitor.OnBattery += () => { Console.WriteLine("On battery - power saving mode"); EnablePowerSavingMode(); }; ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle events - [Electron.Notification](Notification.md) - Notify users about power events ## Additional Resources - [Electron PowerMonitor Documentation](https://electronjs.org/docs/api/power-monitor) - Official Electron power monitor API ================================================ FILE: docs/API/Screen.md ================================================ # Electron.Screen Access display and screen information for responsive layouts. ## Overview The `Electron.Screen` API provides access to screen and display information, including screen size, display metrics, cursor position, and multi-monitor configurations. This is essential for creating responsive applications that adapt to different screen configurations. ## Methods #### 🧊 `Task GetAllDisplaysAsync()` Gets information about all available displays. **Returns:** An array of displays that are currently available. #### 🧊 `Task GetCursorScreenPointAsync()` Gets the current position of the mouse cursor on screen. **Returns:** The current absolute position of the mouse pointer. #### 🧊 `Task GetDisplayMatchingAsync(Rectangle rectangle)` Gets the display that most closely intersects the provided bounds. **Parameters:** - `rectangle` - The rectangle to find the matching display for **Returns:** The display that most closely intersects the provided bounds. #### 🧊 `Task GetDisplayNearestPointAsync(Point point)` Gets the display that is closest to the specified point. **Parameters:** - `point` - The point to find the nearest display for **Returns:** The display nearest the specified point. #### 🧊 `Task GetMenuBarHeightAsync()` macOS: The height of the menu bar in pixels. **Returns:** The height of the menu bar in pixels. #### 🧊 `Task GetPrimaryDisplayAsync()` Gets information about the primary display (main screen). **Returns:** The primary display. ## Events #### ⚡ `OnDisplayAdded` Emitted when a new Display has been added. #### ⚡ `OnDisplayMetricsChanged` Emitted when one or more metrics change in a display. The changedMetrics is an array of strings that describe the changes. Possible changes are bounds, workArea, scaleFactor and rotation. #### ⚡ `OnDisplayRemoved` Emitted when oldDisplay has been removed. ## Usage Examples ### Display Information ```csharp // Get primary display var primaryDisplay = await Electron.Screen.GetPrimaryDisplayAsync(); Console.WriteLine($"Primary display: {primaryDisplay.Size.Width}x{primaryDisplay.Size.Height}"); // Get all displays var displays = await Electron.Screen.GetAllDisplaysAsync(); Console.WriteLine($"Available displays: {displays.Length}"); // Get display near cursor var cursorPoint = await Electron.Screen.GetCursorScreenPointAsync(); var nearestDisplay = await Electron.Screen.GetDisplayNearestPointAsync(cursorPoint); Console.WriteLine($"Nearest display scale factor: {nearestDisplay.ScaleFactor}"); ``` ### Multi-Monitor Setup ```csharp // Get all displays for multi-monitor setup var displays = await Electron.Screen.GetAllDisplaysAsync(); foreach (var display in displays) { Console.WriteLine($"Display {display.Id}:"); Console.WriteLine($" Size: {display.Size.Width}x{display.Size.Height}"); Console.WriteLine($" Position: {display.Bounds.X},{display.Bounds.Y}"); Console.WriteLine($" Scale Factor: {display.ScaleFactor}"); Console.WriteLine($" Work Area: {display.WorkArea.Width}x{display.WorkArea.Height}"); } ``` ### Responsive Window Placement ```csharp // Create window on appropriate display var displays = await Electron.Screen.GetAllDisplaysAsync(); var targetDisplay = displays.FirstOrDefault(d => d.Bounds.X > 0) ?? displays.First(); var windowOptions = new BrowserWindowOptions { Width = Math.Min(1200, targetDisplay.WorkArea.Width), Height = Math.Min(800, targetDisplay.WorkArea.Height), X = targetDisplay.WorkArea.X + (targetDisplay.WorkArea.Width - 1200) / 2, Y = targetDisplay.WorkArea.Y + (targetDisplay.WorkArea.Height - 800) / 2 }; var window = await Electron.WindowManager.CreateWindowAsync(windowOptions); ``` ### Display Change Monitoring ```csharp // Monitor display changes Electron.Screen.OnDisplayAdded += (display) => { Console.WriteLine($"Display added: {display.Id}"); UpdateWindowPositions(); }; Electron.Screen.OnDisplayRemoved += (display) => { Console.WriteLine($"Display removed: {display.Id}"); UpdateWindowPositions(); }; Electron.Screen.OnDisplayMetricsChanged += (display, metrics) => { Console.WriteLine($"Display {display.Id} metrics changed: {string.Join(", ", metrics)}"); UpdateWindowPositions(); }; void UpdateWindowPositions() { // Recalculate window positions based on current displays } ``` ### macOS Menu Bar Height ```csharp // Account for menu bar height on macOS if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { var menuBarHeight = await Electron.Screen.GetMenuBarHeightAsync(); var windowOptions = new BrowserWindowOptions { Y = menuBarHeight, // Position below menu bar TitleBarStyle = TitleBarStyle.Hidden // Hide title bar for custom look }; } ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Position windows based on screen information - [Electron.App](App.md) - Handle display-related application events ## Additional Resources - [Electron Screen Documentation](https://electronjs.org/docs/api/screen) - Official Electron screen API ================================================ FILE: docs/API/Shell.md ================================================ # Electron.Shell Desktop integration for opening files, URLs, and accessing system paths. ## Overview The `Electron.Shell` API provides system integration functionality for opening files and URLs with their default applications, managing trash/recycle bin, and creating/reading shortcut links. ## Methods #### 🧊 `void Beep()` Play the beep sound. #### 🧊 `Task OpenExternalAsync(string url)` Open the given external protocol URL in the desktop's default manner (e.g., mailto: URLs in the user's default mail agent). **Parameters:** - `url` - Max 2081 characters on windows **Returns:** The error message corresponding to the failure if a failure occurred, otherwise empty string. #### 🧊 `Task OpenExternalAsync(string url, OpenExternalOptions options)` Open the given external protocol URL with additional options. **Parameters:** - `url` - Max 2081 characters on windows - `options` - Controls the behavior of OpenExternal **Returns:** The error message corresponding to the failure if a failure occurred, otherwise empty string. #### 🧊 `Task OpenPathAsync(string path)` Open the given file in the desktop's default manner. **Parameters:** - `path` - The path to the directory or file **Returns:** The error message corresponding to the failure if a failure occurred, otherwise empty string. #### 🧊 `Task ReadShortcutLinkAsync(string shortcutPath)` Resolves the shortcut link at shortcutPath. An exception will be thrown when any error happens. **Parameters:** - `shortcutPath` - The path to the shortcut **Returns:** ShortcutDetails of the shortcut. #### 🧊 `Task ShowItemInFolderAsync(string fullPath)` Show the given file in a file manager. If possible, select the file. **Parameters:** - `fullPath` - The full path to the directory or file #### 🧊 `Task TrashItemAsync(string fullPath)` Move the given file to trash and returns a bool status for the operation. **Parameters:** - `fullPath` - The full path to the directory or file **Returns:** Whether the item was successfully moved to the trash. #### 🧊 `Task WriteShortcutLinkAsync(string shortcutPath, ShortcutLinkOperation operation, ShortcutDetails options)` Creates or updates a shortcut link at shortcutPath. **Parameters:** - `shortcutPath` - The path to the shortcut - `operation` - Default is ShortcutLinkOperation.Create - `options` - Structure of a shortcut **Returns:** Whether the shortcut was created successfully. ## Usage Examples ### File Operations ```csharp // Open file with default application var error = await Electron.Shell.OpenPathAsync(filePath); if (string.IsNullOrEmpty(error)) { Console.WriteLine("File opened successfully"); } else { Console.WriteLine($"Failed to open file: {error}"); } // Show file in file manager await Electron.Shell.ShowItemInFolderAsync(filePath); // Move file to trash var trashed = await Electron.Shell.TrashItemAsync(filePath); Console.WriteLine($"File trashed: {trashed}"); ``` ### URL Operations ```csharp // Open URL in default browser var error = await Electron.Shell.OpenExternalAsync("https://electron.net"); if (!string.IsNullOrEmpty(error)) { Console.WriteLine($"Failed to open URL: {error}"); } // Open email client await Electron.Shell.OpenExternalAsync("mailto:user@example.com"); // Open with options var error = await Electron.Shell.OpenExternalAsync("https://example.com", new OpenExternalOptions { Activate = true }); ``` ### System Integration ```csharp // Play system beep Electron.Shell.Beep(); // Create desktop shortcut var success = await Electron.Shell.WriteShortcutLinkAsync( @"C:\Users\Public\Desktop\MyApp.lnk", ShortcutLinkOperation.Create, new ShortcutDetails { Target = "C:\\Program Files\\MyApp\\MyApp.exe", Description = "My Application", WorkingDirectory = "C:\\Program Files\\MyApp" } ); // Read shortcut information var details = await Electron.Shell.ReadShortcutLinkAsync(@"C:\Users\Public\Desktop\MyApp.lnk"); Console.WriteLine($"Target: {details.Target}"); ``` ### Integration with Dialog API ```csharp // Use with file dialog results var files = await Electron.Dialog.ShowOpenDialogAsync(window, options); if (files.Length > 0) { var selectedFile = files[0]; // Open the selected file await Electron.Shell.OpenPathAsync(selectedFile); // Show in file manager await Electron.Shell.ShowItemInFolderAsync(selectedFile); } ``` ## Related APIs - [Electron.Dialog](Dialog.md) - Select files to open with Shell - [Electron.App](App.md) - Application lifecycle events - [Electron.Clipboard](Clipboard.md) - Copy file paths for Shell operations ## Additional Resources - [Electron Shell Documentation](https://electronjs.org/docs/api/shell) - Official Electron shell API ================================================ FILE: docs/API/Tray.md ================================================ # Electron.Tray Add icons and context menus to the system's notification area. ## Overview The `Electron.Tray` API provides the ability to add icons and context menus to the system's notification area (system tray). This allows applications to provide quick access to common functions and maintain a presence in the system even when windows are closed. ## Properties #### 📋 `IReadOnlyCollection MenuItems` Gets a read-only collection of all current tray menu items. ## Methods #### 🧊 `void Destroy()` Destroys the tray icon immediately. #### 🧊 `void DisplayBalloon(DisplayBalloonOptions options)` Windows: Displays a tray balloon notification. **Parameters:** - `options` - Balloon notification options #### 🧊 `Task IsDestroyedAsync()` Check if the tray icon has been destroyed. **Returns:** Whether the tray icon is destroyed. #### 🧊 `void SetImage(string image)` Sets the image associated with this tray icon. **Parameters:** - `image` - New image for the tray icon #### 🧊 `void SetPressedImage(string image)` Sets the image associated with this tray icon when pressed on macOS. **Parameters:** - `image` - Image for pressed state #### 🧊 `void SetTitle(string title)` macOS: Sets the title displayed aside of the tray icon in the status bar. **Parameters:** - `title` - Title text #### 🧊 `void SetToolTip(string toolTip)` Sets the hover text for this tray icon. **Parameters:** - `toolTip` - Tooltip text #### 🧊 `void Show(string image)` Shows the tray icon without a context menu. **Parameters:** - `image` - The image to use for the tray icon #### 🧊 `void Show(string image, MenuItem menuItem)` Shows the tray icon with a single menu item. **Parameters:** - `image` - The image to use for the tray icon - `menuItem` - Single menu item for the tray context menu #### 🧊 `void Show(string image, MenuItem[] menuItems)` Shows the tray icon with multiple menu items. **Parameters:** - `image` - The image to use for the tray icon - `menuItems` - Array of menu items for the tray context menu ## Events #### ⚡ `OnBalloonClick` Windows: Emitted when the tray balloon is clicked. #### ⚡ `OnBalloonClosed` Windows: Emitted when the tray balloon is closed because of timeout or user manually closes it. #### ⚡ `OnBalloonShow` Windows: Emitted when the tray balloon shows. #### ⚡ `OnClick` Emitted when the tray icon is clicked. #### ⚡ `OnDoubleClick` macOS, Windows: Emitted when the tray icon is double clicked. #### ⚡ `OnRightClick` macOS, Windows: Emitted when the tray icon is right clicked. ## Usage Examples ### Basic Tray Icon ```csharp // Simple tray icon await Electron.Tray.Show("assets/tray-icon.png"); // Tray icon with single menu item await Electron.Tray.Show("assets/tray-icon.png", new MenuItem { Label = "Show Window", Click = () => ShowMainWindow() }); ``` ### Tray with Context Menu ```csharp // Tray with multiple menu items var trayMenuItems = new[] { new MenuItem { Label = "Show Window", Click = () => ShowMainWindow() }, new MenuItem { Label = "Settings", Click = () => OpenSettings() }, new MenuItem { Type = MenuType.Separator }, new MenuItem { Label = "Exit", Click = () => Electron.App.Quit() } }; await Electron.Tray.Show("assets/tray-icon.png", trayMenuItems); ``` ### Dynamic Tray Updates ```csharp // Update tray tooltip based on status await Electron.Tray.SetToolTip("MyApp - Connected"); // Change tray icon based on state if (isConnected) { await Electron.Tray.SetImage("assets/connected.png"); } else { await Electron.Tray.SetImage("assets/disconnected.png"); } ``` ### Tray Event Handling ```csharp // Handle tray clicks Electron.Tray.OnClick += (clickArgs, bounds) => { if (clickArgs.AltKey || clickArgs.ShiftKey) { // Alt+Click or Shift+Click - show context menu Electron.Menu.ContextMenuPopup(Electron.WindowManager.BrowserWindows.First()); } else { // Regular click - toggle main window ToggleMainWindow(); } }; Electron.Tray.OnRightClick += (clickArgs, bounds) => { // Show context menu on right click Electron.Menu.ContextMenuPopup(Electron.WindowManager.BrowserWindows.First()); }; ``` ### Windows Balloon Notifications ```csharp // Show Windows balloon notification await Electron.Tray.DisplayBalloon(new DisplayBalloonOptions { Title = "Background Task Complete", Content = "Your file has been processed successfully.", Icon = "assets/notification-icon.ico" }); // Handle balloon events Electron.Tray.OnBalloonClick += () => { ShowMainWindow(); Electron.WindowManager.BrowserWindows.First().Focus(); }; ``` ### macOS Tray Features ```csharp // macOS specific tray features if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { await Electron.Tray.SetTitle("MyApp"); // Use template image for dark mode support await Electron.Tray.SetImage("assets/tray-template.png"); await Electron.Tray.SetPressedImage("assets/tray-pressed-template.png"); } ``` ### Application Integration ```csharp // Integrate with application lifecycle Electron.App.WindowAllClosed += () => { // Keep app running in tray when windows are closed if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { Electron.App.Hide(); } }; // Handle tray double-click Electron.Tray.OnDoubleClick += (clickArgs, bounds) => { ShowMainWindow(); Electron.WindowManager.BrowserWindows.First().Focus(); }; ``` ## Related APIs - [Electron.Menu](Menu.md) - Context menus for tray icons - [Electron.Notification](Notification.md) - Desktop notifications - [Electron.App](App.md) - Application lifecycle events - [Electron.WindowManager](WindowManager.md) - Windows to show/hide from tray ## Additional Resources - [Electron Tray Documentation](https://electronjs.org/docs/api/tray) - Official Electron tray API ================================================ FILE: docs/API/WebContents.md ================================================ # Electron.WebContents Render and control web pages. ## Overview The `Electron.WebContents` API provides control over web page content within Electron windows. It handles page loading, navigation, JavaScript execution, and web page lifecycle events. ## Properties #### 📋 `int Id` Gets the unique identifier for this web contents. #### 📋 `Session Session` Manage browser sessions, cookies, cache, proxy settings, etc. ## Methods #### 🧊 `void ExecuteJavaScriptAsync(string code, bool userGesture = false)` Evaluates script code in page. In the browser window some HTML APIs like `requestFullScreen` can only be invoked by a gesture from the user. Setting `userGesture` to `true` will remove this limitation. Code execution will be suspended until web page stop loading. **Parameters:** - `code` - The code to execute - `userGesture` - if set to `true` simulate a user gesture **Returns:** The result of the executed code. #### 🧊 `Task GetPrintersAsync()` Get system printers. **Returns:** Array of available printers. #### 🧊 `Task GetUrl()` Get the URL of the loaded page. It's useful if a web-server redirects you and you need to know where it redirects. For instance, It's useful in case of Implicit Authorization. **Returns:** URL of the loaded page. #### 🧊 `void InsertCSS(bool isBrowserWindow, string path)` Inserts CSS into the web page. See: https://www.electronjs.org/docs/api/web-contents#contentsinsertcsscss-options Works for both BrowserWindows and BrowserViews. **Parameters:** - `isBrowserWindow` - Whether the webContents belong to a BrowserWindow or not (the other option is a BrowserView) - `path` - Absolute path to the CSS file location #### 🧊 `Task LoadURLAsync(string url)` Loads the url in the window. The url must contain the protocol prefix. The async method will resolve when the page has finished loading, and rejects if the page fails to load. A noop rejection handler is already attached, which avoids unhandled rejection errors. Loads the `url` in the window. The `url` must contain the protocol prefix, e.g. the `http://` or `file://`. If the load should bypass http cache then use the `pragma` header to achieve it. **Parameters:** - `url` - URL to load #### 🧊 `Task LoadURLAsync(string url, LoadURLOptions options)` Loads the url with additional options. The async method will resolve when the page has finished loading, and rejects if the page fails to load. A noop rejection handler is already attached, which avoids unhandled rejection errors. Loads the `url` in the window. The `url` must contain the protocol prefix, e.g. the `http://` or `file://`. If the load should bypass http cache then use the `pragma` header to achieve it. **Parameters:** - `url` - URL to load - `options` - Loading options #### 🧊 `void OpenDevTools()` Opens the devtools. #### 🧊 `void OpenDevTools(OpenDevToolsOptions openDevToolsOptions)` Opens the devtools with options. **Parameters:** - `openDevToolsOptions` - Developer tools options #### 🧊 `Task PrintAsync(PrintOptions options = null)` Prints window's web page. **Parameters:** - `options` - Print options **Returns:** Whether the print operation succeeded. #### 🧊 `Task PrintToPDFAsync(string path, PrintToPDFOptions options = null)` Prints window's web page as PDF with Chromium's preview printing custom settings.The landscape will be ignored if @page CSS at-rule is used in the web page. By default, an empty options will be regarded as: Use page-break-before: always; CSS style to force to print to a new page. **Parameters:** - `path` - Output file path - `options` - PDF generation options **Returns:** Whether the PDF generation succeeded. ## Events #### ⚡ `InputEvent` Emitted when an input event is sent to the WebContents. #### ⚡ `OnCrashed` Emitted when the renderer process crashes or is killed. #### ⚡ `OnDidFailLoad` Emitted when the load failed. #### ⚡ `OnDidFinishLoad` Emitted when the navigation is done, i.e. the spinner of the tab has stopped spinning, and the onload event was dispatched. #### ⚡ `OnDidNavigate` Emitted when a main frame navigation is done. #### ⚡ `OnDidRedirectNavigation` Emitted after a server side redirect occurs during navigation. #### ⚡ `OnDidStartNavigation` Emitted when any frame (including main) starts navigating. #### ⚡ `OnDomReady` Emitted when the document in the top-level frame is loaded. #### ⚡ `OnWillRedirect` Emitted when a server side redirect occurs during navigation. ## Usage Examples ### Page Loading ```csharp // Load URL with options await webContents.LoadURLAsync("https://example.com", new LoadURLOptions { UserAgent = "MyApp/1.0", ExtraHeaders = "Authorization: Bearer token123" }); // Load local file await webContents.LoadURLAsync("file://" + Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "app/index.html")); // Get current URL var currentUrl = await webContents.GetUrl(); Console.WriteLine($"Current URL: {currentUrl}"); ``` ### JavaScript Execution ```csharp // Execute simple JavaScript var result = await webContents.ExecuteJavaScriptAsync("document.title"); Console.WriteLine($"Page title: {result}"); // Execute with user gesture simulation await webContents.ExecuteJavaScriptAsync("document.requestFullscreen()", true); // Execute complex code var userAgent = await webContents.ExecuteJavaScriptAsync("navigator.userAgent"); Console.WriteLine($"User agent: {userAgent}"); ``` ### Developer Tools ```csharp // Open dev tools webContents.OpenDevTools(); // Open with specific options webContents.OpenDevTools(new OpenDevToolsOptions { Mode = DevToolsMode.Detached, Activate = true }); ``` ### CSS Injection ```csharp // Inject CSS file webContents.InsertCSS(true, "styles/custom-theme.css"); // Inject CSS for BrowserView webContents.InsertCSS(false, "styles/browser-view.css"); ``` ### Printing Operations ```csharp // Print web page var printSuccess = await webContents.PrintAsync(new PrintOptions { Silent = false, PrintBackground = true, DeviceName = "My Printer" }); if (printSuccess) { Console.WriteLine("Print job sent successfully"); } ``` ### PDF Generation ```csharp // Generate PDF var pdfSuccess = await webContents.PrintToPDFAsync("document.pdf", new PrintToPDFOptions { MarginsType = PrintToPDFMarginsType.None, PageSize = PrintToPDFPageSize.A4, PrintBackground = true, Landscape = false }); if (pdfSuccess) { Console.WriteLine("PDF generated successfully"); } ``` ### Navigation Monitoring ```csharp // Monitor navigation events webContents.OnDidStartNavigation += (url) => { Console.WriteLine($"Starting navigation to: {url}"); }; webContents.OnDidNavigate += (navInfo) => { Console.WriteLine($"Navigated to: {navInfo.Url}"); }; webContents.OnDidFinishLoad += () => { Console.WriteLine("Page finished loading"); }; webContents.OnDidFailLoad += (failInfo) => { Console.WriteLine($"Page failed to load: {failInfo.ErrorCode} - {failInfo.ErrorDescription}"); }; ``` ### Content Interaction ```csharp // Wait for DOM ready webContents.OnDomReady += () => { Console.WriteLine("DOM is ready"); // Safe to execute DOM-related JavaScript now }; // Handle page crashes webContents.OnCrashed += (killed) => { Console.WriteLine($"Renderer crashed, killed: {killed}"); // Optionally reload the page }; ``` ## Related APIs - [Electron.WindowManager](WindowManager.md) - Windows containing web contents - [Electron.Session](Session.md) - Session management for web contents - [Electron.IpcMain](IpcMain.md) - Communication with web contents ## Additional Resources - [Electron WebContents Documentation](https://electronjs.org/docs/api/web-contents) - Official Electron web contents API - [Web Content Management](../Core/What's-New.md) - Understanding web content handling - [Security Considerations](../Using/Configuration.md) - Secure web content integration ================================================ FILE: docs/API/WindowManager.md ================================================ # Electron.WindowManager Create and manage browser windows, control window behavior and appearance. ## Overview The `Electron.WindowManager` API provides comprehensive control over browser windows in your Electron application. It handles window creation, management, and coordination with the application lifecycle. ## Properties #### 📋 `IReadOnlyCollection BrowserViews` Gets a read-only collection of all currently open browser views. #### 📋 `IReadOnlyCollection BrowserWindows` Gets a read-only collection of all currently open browser windows. #### 📋 `bool IsQuitOnWindowAllClosed` Controls whether the application quits when all windows are closed. Default is true. ## Methods #### 🧊 `Task CreateBrowserViewAsync()` Creates a new browser view with default options. **Returns:** The created BrowserView instance. #### 🧊 `Task CreateBrowserViewAsync(BrowserViewConstructorOptions options)` Creates a new browser view with custom options. **Parameters:** - `options` - Browser view configuration options **Returns:** The created BrowserView instance. #### 🧊 `Task CreateWindowAsync(string loadUrl = "http://localhost")` Creates a new browser window with default options. **Parameters:** - `loadUrl` - URL to load in the window. Defaults to "http://localhost" **Returns:** The created BrowserWindow instance. #### 🧊 `Task CreateWindowAsync(BrowserWindowOptions options, string loadUrl = "http://localhost")` Creates a new browser window with custom options. **Parameters:** - `options` - Window configuration options - `loadUrl` - URL to load in the window. Defaults to "http://localhost" **Returns:** The created BrowserWindow instance. ## Usage Examples ### Basic Window Creation ```csharp // Create window with default options var mainWindow = await Electron.WindowManager.CreateWindowAsync(); // Create window with custom options var settingsWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Width = 800, Height = 600, Show = false, Title = "Settings", WebPreferences = new WebPreferences { NodeIntegration = false, ContextIsolation = true } }, "https://localhost:5001/settings"); ``` ### Window Management ```csharp // Get all windows var windows = Electron.WindowManager.BrowserWindows; Console.WriteLine($"Open windows: {windows.Count}"); // Configure quit behavior Electron.WindowManager.IsQuitOnWindowAllClosed = false; // Keep app running when windows close // Handle window lifecycle Electron.App.WindowAllClosed += () => { Console.WriteLine("All windows closed"); if (Electron.WindowManager.IsQuitOnWindowAllClosed) { Electron.App.Quit(); } }; ``` ### Browser View Integration ```csharp // Create browser view var browserView = await Electron.WindowManager.CreateBrowserViewAsync(new BrowserViewConstructorOptions { WebPreferences = new WebPreferences { NodeIntegration = false, ContextIsolation = true } }); // Add to window await mainWindow.SetBrowserViewAsync(browserView); await browserView.WebContents.LoadURLAsync("https://example.com"); // Set view bounds await mainWindow.SetBoundsAsync(browserView, new Rectangle { X = 0, Y = 100, Width = 800, Height = 400 }); ``` ### Window Options Configuration ```csharp // Comprehensive window options var options = new BrowserWindowOptions { Width = 1200, Height = 800, MinWidth = 600, MinHeight = 400, MaxWidth = 1920, MaxHeight = 1080, X = 100, Y = 100, Center = true, Frame = true, Title = "My Application", Icon = "assets/app-icon.png", Show = false, AlwaysOnTop = false, SkipTaskbar = false, Kiosk = false, TitleBarStyle = TitleBarStyle.Default, BackgroundColor = "#FFFFFF", DarkTheme = false, Transparent = false, WebPreferences = new WebPreferences { NodeIntegration = false, ContextIsolation = true, EnableWebSQL = false, Partition = "persist:electron", ZoomFactor = 1.0f, DevTools = true } }; ``` ### Multi-Window Applications ```csharp // Create main window var mainWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Width = 1200, Height = 800, Show = false }); // Create secondary window var secondaryWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Width = 600, Height = 400, Parent = mainWindow, Modal = true, Show = false }); // Load different content await mainWindow.WebContents.LoadURLAsync("https://localhost:5001"); await secondaryWindow.WebContents.LoadURLAsync("https://localhost:5001/settings"); // Show windows when ready mainWindow.OnReadyToShow += () => mainWindow.Show(); secondaryWindow.OnReadyToShow += () => secondaryWindow.Show(); ``` ## Related APIs - [Electron.App](App.md) - Application lifecycle and window events - [Electron.Dialog](Dialog.md) - Parent windows for modal dialogs - [Electron.Menu](Menu.md) - Window-specific menus - [Electron.WebContents](WebContents.md) - Window content management ## Additional Resources - [Electron Window Management Documentation](https://electronjs.org/docs/api/browser-window) - Official Electron window API ================================================ FILE: docs/About.md ================================================ # About this Project Electron.NET has been developed by a small number of people in the hope that it may be useful for others. Support for this project in all forms is very welcome, no matter whether in form of code contributions or donations. ## 💬 Community [![Gitter](https://badges.gitter.im/ElectronNET/community.svg)](https://gitter.im/ElectronNET/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) Besides the chat on Gitter and the issues [discussed here](https://github.com/ElectronNET/Electron.NET/issues) you can also use [StackOverflow](https://stackoverflow.com/questions/tagged/electron.net) with the tag `electron.net`. ## 🙋‍♀️🙋‍♂ Contributing Feel free to submit a pull request if you find any bugs (to see a list of active issues, visit the [Issues section](https://github.com/ElectronNET/Electron.NET/issues). Please make sure all commits are properly documented. ## 🙏 Donate We do this open source work in our free time. If you'd like us to invest more time on it, please [donate](https://donorbox.org/electron-net). Donation can be used to increase some issue priority. Thank you! [![donate](https://img.shields.io/badge/Donate-Donorbox-green.svg)](https://donorbox.org/electron-net) Alternatively, consider using a GitHub sponsorship for the core maintainers: - [Gregor Biswanger](https://github.com/sponsors/GregorBiswanger) - [Florian Rappl](https://github.com/sponsors/FlorianRappl) Any support appreciated! 🍻 ## 👨‍💻 Authors * **[Gregor Biswanger](https://github.com/GregorBiswanger)** - (Microsoft MVP, Intel Black Belt and Intel Software Innovator) is a freelance lecturer, consultant, trainer, author and speaker. He is a consultant for large and medium-sized companies, organizations and agencies for software architecture, web- and cross-platform development. You can find Gregor often on the road attending or speaking at international conferences. - [Cross-Platform-Blog](http://www.cross-platform-blog.com) - Twitter [@BFreakout](https://www.twitter.com/BFreakout)   * **[Dr. Florian Rappl](https://github.com/FlorianRappl)** - Software Developer - from Munich, Germany. Microsoft MVP & Web Geek. - [The Art of Micro Frontends](https://microfrontends.art) - [Homepage](https://florian-rappl.de) - Twitter [@florianrappl](https://twitter.com/florianrappl)   * [**softworkz**](https://github.com/softworkz) - full range developer - likes to start where others gave up - MS MVP alumni and Munich citizen as well. Has not been involved in the evolution of Electron.NET but rather dropped off the update and overhaul for ElectronNET.Core in a kind-of drive-by action.   * **[Robert Muehsig](https://github.com/robertmuehsig)** - Software Developer - from Dresden, Germany, now living & working in Switzerland. Microsoft MVP & Web Geek. - [codeinside Blog](https://blog.codeinside.eu) - Twitter [@robert0muehsig](https://twitter.com/robert0muehsig) See also the list of [contributors](https://github.com/ElectronNET/Electron.NET/graphs/contributors) who participated in this project. ## 🎉 License MIT-licensed. See [LICENSE](https://github.com/ElectronNET/Electron.NET?tab=MIT-1-ov-file#readme) for details. ================================================ FILE: docs/Core/Advanced-Migration-Topics.md ================================================ # Advanced Migration Topics This guide covers advanced scenarios and edge cases that may require additional configuration when migrating to ElectronNET.Core. ## Custom ASP.NET Port Configuration ### Port Configuration Changes **Previous Approach:** Specifying the WebPort in `electron.manifest.json` is no longer supported because the ASP.NET-first launch mode makes this timing-dependent. **New Approach:** Configure custom ASP.NET ports through MSBuild metadata: ```xml ``` ## Custom ElectronHostHook Configuration > [!NOTE] > These changes are only required in case you are using a custom ElectronHostHook implementation! > If you have an ElectronHostHook folder in your project but you did not customize that code and aren't using its demo features (Excel and ZIP), you can also just remove that folder from your project. ### TypeScript and Node.js Updates **Update package.json:** This shows the relevant changes only: All shown versions are the new required minimum versions. ```json { "devDependencies": { "@types/node": "^22.18", "typescript": "^5.9.3" }, "dependencies": { "socket.io": "^4.8.1", } } ``` **Update Project File:** The below modifications will allow you to use the latest TypeScript compiler in your ASP.Net project. ```xml commonjs true ElectronHostHook/tsconfig.json ``` ### Integration Benefits - **Modern TypeScript** - Latest language features and better type checking - **Updated Node.js Types** - Compatibility with Node.js 22.x APIs - **ESLint Integration** - Better code quality and consistency - **MSBuild Compilation** - Integrated with Visual Studio build process ## Troubleshooting Advanced Scenarios ### Multi-Project Solutions When using ElectronNET.Core in multi-project solutions: 1. **Install ElectronNET.Core.Api** in class library projects 2. **Install ElectronNET.Core and ElectronNET.Core.AspNet** only in the startup project 3. **Share configuration** through project references or shared files ## Next Steps - **[Migration Guide](Migration-Guide.md)** - Complete migration process - **[What's New?](What's-New.md)** - Overview of all ElectronNET.Core features - **[Getting Started](../GettingStarted/ASP.Net.md)** - Development workflows ================================================ FILE: docs/Core/Migration-Checks.md ================================================ # Migration Checks Electron.NET includes automatic build-time validation checks that help users migrating from previous versions avoid common configuration issues. These checks run automatically during the build process and provide helpful guidance when problems are detected. ## Overview When you build an Electron.NET project, the following validation checks are performed: | Code | Check | Description | |------|-------|-------------| | [ELECTRON001](#1-packagejson-rules) | package.json location rules | Ensures `package.json`/`package-lock.json` aren’t present in unsupported locations (root `package.json` handled separately) | | [ELECTRON008](#1-packagejson-rules) | root package.json contains electron | Warns when root `package.json` contains the word `electron` (case-insensitive) | | [ELECTRON009](#1-packagejson-rules) | root package.json copied to output | Warns when root `package.json` is configured to be copied to output/publish | | [ELECTRON002](#2-electron-manifestjson-not-allowed) | electron-manifest.json not allowed | Detects deprecated manifest files | | [ELECTRON003](#3-electron-builderjson-location) | electron-builder.json location | Verifies electron-builder.json exists in Properties folder | | [ELECTRON004](#3-electron-builderjson-location) | electron-builder.json wrong location | Warns if electron-builder.json is found in incorrect locations | | [ELECTRON005](#4-parent-paths-not-allowed-in-electron-builderjson) | Parent paths not allowed | Checks for `..` references in config | | [ELECTRON006](#5-publish-profile-validation) | ASP.NET publish profile mismatch | Warns when ASP.NET projects have console-style profiles | | [ELECTRON007](#5-publish-profile-validation) | Console publish profile mismatch | Warns when console projects have ASP.NET-style profiles | --- ## 1. package.json rules **Warning Codes:** `ELECTRON001`, `ELECTRON008`, `ELECTRON009` ### What is checked The build system scans for `package.json` and `package-lock.json` files in your project directory. Rules: - **ELECTRON001**: `package.json` / `package-lock.json` must not exist in the project directory or subdirectories - Exception: `ElectronHostHook` folder is allowed - Note: a **root** `package.json` is **excluded** from `ELECTRON001` and validated by `ELECTRON008` / `ELECTRON009` - **ELECTRON008**: If a root `package.json` exists, it must **not** contain electron-related dependencies or configuration. - **ELECTRON009**: If a root `package.json` exists, it must **not** be configured to be copied to output/publish (for example via `CopyToOutputDirectory` / `CopyToPublishDirectory` metadata) ### Why this matters Electron.NET generates its Electron-related `package.json` during publishing based on MSBuild properties. A user-maintained Electron-related `package.json` can conflict with that process. Also, ensuring the root `package.json` is not copied prevents accidentally shipping it with the published app. ### Exception A `package.json` / `package-lock.json` file **is allowed** in the `ElectronHostHook` folder if you're using custom host hooks. ### How to fix If you have an Electron-related `package.json` from older Electron.NET versions: 1. **Open your project's `.csproj` file** 2. **Add the required properties** to a PropertyGroup with the label `ElectronNetCommon`: ```xml my-electron-app My Electron App 1.0.0 My awesome Electron.NET application My Company Copyright © 2025 30.0.9 ``` 3. **Delete** Electron-related `package.json` / `package-lock.json` files (except those under `ElectronHostHook` if applicable) If you keep a root `package.json` for non-Electron reasons: - Ensure it does **not** contain electron dependencies or configuration (fixes `ELECTRON008`) - Ensure it is **not** copied to output/publish (fixes `ELECTRON009`) > **See also:** [Migration Guide](Migration-Guide.md) for complete migration instructions. --- ## 2. electron-manifest.json not allowed **Warning Code:** `ELECTRON002` ### What is checked The build system checks for the presence of `electron.manifest.json` or `electron-manifest.json` files in your project. ### Why this matters The `electron.manifest.json` file format is deprecated. All configuration should now be specified using: - MSBuild properties in your `.csproj` file (for application metadata) - The `electron-builder.json` file in the `Properties` folder (for build configuration) ### How to fix 1. **Migrate application properties** to your `.csproj` file (see [Migration Guide](Migration-Guide.md)) 2. **Move the `build` section** from `electron.manifest.json` to `Properties/electron-builder.json` 3. **Delete the old `electron.manifest.json`** file **Example electron-builder.json:** ```json { "compression": "maximum", "win": { "icon": "Assets/app.ico", "target": ["nsis", "portable"] }, "linux": { "icon": "Assets/app.png", "target": ["AppImage", "deb"] }, "mac": { "icon": "Assets/app.icns", "target": ["dmg", "zip"] } } ``` --- ## 3. electron-builder.json Location **Warning Codes:** `ELECTRON003`, `ELECTRON004` ### What is checked - `ELECTRON003`: Verifies that an `electron-builder.json` file exists in the `Properties` folder - `ELECTRON004`: Warns if `electron-builder.json` is found in incorrect locations ### Why this matters The `electron-builder.json` file must be located in the `Properties` folder so it can be properly copied to the output directory during publishing. ### How to fix 1. **Create the Properties folder** if it doesn't exist 2. **Move or create** `electron-builder.json` in `Properties/electron-builder.json` 3. **Remove** any `electron-builder.json` files from other locations **Expected structure:** ``` MyProject/ ├── Properties/ │ ├── electron-builder.json ✅ Correct location │ ├── launchSettings.json │ └── PublishProfiles/ ├── MyProject.csproj └── Program.cs ``` --- ## 4. Parent paths not allowed in electron-builder.json **Warning Code:** `ELECTRON005` ### What is checked The build system scans the `electron-builder.json` file for parent-path references (`..`). ### Why this matters During the publish process, the `electron-builder.json` file is copied to the build output directory. Any relative paths in this file are resolved from that location, not from your project directory. Parent-path references (`../`) will not work correctly because they would point outside the published application. ### How to fix 1. **Move resource files** (icons, installers, etc.) inside your project folder structure 2. **Configure the files** to be copied to the output directory in your `.csproj`: ```xml PreserveNewest ``` 3. **Update paths** in `electron-builder.json` to use relative paths without `..`: **Before (incorrect):** ```json { "win": { "icon": "../SharedAssets/app.ico" } } ``` **After (correct):** ```json { "win": { "icon": "Assets/app.ico" } } ``` --- ## 5. Publish Profile Validation **Warning Codes:** `ELECTRON006`, `ELECTRON007` ### What is checked The build system examines `.pubxml` files in the `Properties/PublishProfiles` folder and validates that they match the project type: - **ELECTRON006**: For **ASP.NET projects** (using `Microsoft.NET.Sdk.Web`), checks that publish profiles include `WebPublishMethod`. This property is required for proper ASP.NET publishing. - **ELECTRON007**: For **console/other projects** (not using the Web SDK), checks that publish profiles do NOT include the `WebPublishMethod` property. These ASP.NET-specific properties are incorrect for non-web applications. ### Why this matters Electron.NET supports both ASP.NET and console application project types, each requiring different publish profile configurations: | Project Type | SDK | Expected Properties | |--------------|-----|---------------------| | ASP.NET (Razor Pages, MVC, Blazor) | `Microsoft.NET.Sdk.Web` | `WebPublishMethod`, no `PublishProtocol` | | Console Application | `Microsoft.NET.Sdk` | `PublishProtocol`, no `WebPublishMethod` | Using the wrong publish profile type can lead to incomplete or broken builds. ### How to fix 1. **Delete existing publish profiles** from `Properties/PublishProfiles/` 2. **Create new publish profiles** using the Visual Studio Publishing Wizard: - Right-click on the project in Solution Explorer - Select **Publish...** - Follow the wizard to create a **Folder** publish profile For correct publish profile examples for both ASP.NET and Console applications, see **[Package Building](../Using/Package-Building.md#step-1-create-publish-profiles)**. --- ## Disabling Migration Checks If you need to disable specific migration checks (not recommended), you can set the following properties in your `.csproj` file: ```xml true ``` > ⚠️ **Warning:** Disabling migration checks may result in build or runtime errors. Only disable checks if you fully understand the implications. --- ## See Also - [Migration Guide](Migration-Guide.md) - Complete step-by-step migration instructions - [Advanced Migration Topics](Advanced-Migration-Topics.md) - Complex migration scenarios - [Configuration](../Using/Configuration.md) - Project configuration options - [Package Building](../Using/Package-Building.md) - Building distributable packages ================================================ FILE: docs/Core/Migration-Guide.md ================================================ # Migration Guide Migrating from previous versions of Electron.NET to ElectronNET.Core is straightforward but requires several important changes. This guide walks you through the process step by step. ## 📋 Prerequisites Before starting the migration: - **Backup your project** - Ensure you have a working backup - **Update development tools** - Install Node.js 22.x and .NET 8.0+ - **Review current setup** - Note your current Electron and ASP.NET versions ## 🚀 Migration Steps ### Step 1: Update NuGet Packages **Uninstall old packages:** ```powershell dotnet remove package ElectronNET.API ``` **Install new packages:** ```powershell dotnet add package ElectronNET.Core dotnet add package ElectronNET.Core.AspNet # For ASP.NET projects ``` > **Note**: The API package is automatically included as a dependency of `ElectronNET.Core`. See [Package Description](../RelInfo/Package-Description.md) for details about the package structure. ### Step 2: Configure Project Settings **Auto-generated Configuration:** ElectronNET.Core automatically creates `electron-builder.json` in the `Properties` folder of your project during the first build or NuGet restore. No manual configuration is needed for basic setups. **Migrate Existing Configuration:** If you have an existing `electron.manifest.json` file: 1. **Open the generated `electron-builder.json`** file in your project 2. **Locate the 'build' section** in your old `electron.manifest.json` 3. **Copy the contents** of the build section (not the "build" key itself) into the new `electron-builder.json` 4. **Use Visual Studio Project Designer** to configure Electron settings through the UI 5. **Delete the old `electron.manifest.json`** file **Alternative: Manual Configuration** You can also manually edit `electron-builder.json`: ```json { "linux": { "target": [ "tar.xz" ] }, "win": { "target": [ { "target": "portable", "arch": "x64" } ] } } ``` **Modify Launch Settings:** ElectronNET.Core no longer needs a separate CLI tool (electronize.exe) for launching. You should update your launch settings to use either the ASP.NET-first or Electron-first approach. See [Debugging](../Using/Debugging.md) for details. ## 🎯 Testing Migration After completing the migration steps: 1. **Build your project** to ensure no compilation errors 2. **Test debugging** using the new ASP.NET-first approach 3. **Verify packaging** works with the new configuration 4. **Check cross-platform builds** if targeting multiple platforms ## 🚨 Common Migration Issues ### Build Errors - **Node.js version**: Verify Node.js 22.x is installed and in PATH - **Package conflicts**: Clean NuGet cache if needed ### Runtime Errors - **Missing electron-builder.json**: Trigger rebuild or manual NuGet restore - **Process termination**: Use .NET-first startup mode for better cleanup ## 🚀 Next Steps - **[What's New?](What's-New.md)** - Complete overview of ElectronNET.Core features - **[Advanced Migration Topics](Advanced-Migration-Topics.md)** - Handle complex scenarios - **[Getting Started](../GettingStarted/ASP.Net.md)** - Learn about new development workflows ## 💡 Migration Benefits ✅ **Simplified Configuration** - No more CLI tools or JSON files ✅ **Better Debugging** - Native Visual Studio experience with Hot Reload ✅ **Modern Architecture** - .NET-first process lifecycle ✅ **Cross-Platform Ready** - Build Linux apps from Windows ✅ **Future-Proof** - Flexible Electron version selection ### Step 3: Update Startup Code **Update UseElectron() calls** to include the new callback parameter. This callback executes at the right moment to initialize your Electron UI. #### Modern ASP.NET Core (WebApplication) ```csharp using ElectronNET.API; using ElectronNET.API.Entities; public static void Main(string[] args) { var builder = WebApplication.CreateBuilder(args); builder.UseElectron(args, ElectronAppReady); var app = builder.Build(); app.Run(); } public static async Task ElectronAppReady() { var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false }); browserWindow.OnReadyToShow += () => browserWindow.Show(); } ``` #### Traditional ASP.NET Core (IWebHostBuilder) ```csharp using ElectronNET.API; using ElectronNET.API.Entities; public static void Main(string[] args) { WebHost.CreateDefaultBuilder(args) .UseElectron(args, ElectronAppReady) .UseStartup() .Build() .Run(); } public static async Task ElectronAppReady() { var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false }); browserWindow.OnReadyToShow += () => browserWindow.Show(); } ``` ### Step 4: Update Development Tools See [System Requirements](../GettingStarted/System-Requirements.md). ### Step 5: Update Debugging Setup **Watch Feature Removal:** The old 'watch' feature is no longer supported. Instead, use the new ASP.NET-first debugging with Hot Reload: - **Old approach**: Manual process attachment and slow refresh - **New approach**: Native Visual Studio debugging with Hot Reload - **Benefits**: Faster development cycle, better debugging experience **Update Launch Settings:** Replace old watch configurations with new debugging profiles. See [Debugging](../GettingStarted/Debugging.md) for detailed setup instructions. ================================================ FILE: docs/Core/What's-New.md ================================================ # What's New in ElectronNET.Core ## A Complete Transformation ElectronNET.Core represents a fundamental modernization of Electron.NET, addressing years of accumulated pain points while preserving full API compatibility. This isn't just an update—it's a complete rethinking of how .NET developers build and debug cross-platform desktop applications with Electron. ## Complete Build System Overhaul ### From CLI Complexity to MSBuild Simplicity The most visible change is the complete elimination of the CLI tool dependency. Where developers once needed to manage complex command-line operations and JSON configuration files, everything now flows through Visual Studio's native project system. The old `electron.manifest.json` file is gone, replaced by clean MSBuild project properties that integrate seamlessly with Visual Studio's project designer. This provides not just a better development experience, but also eliminates entire categories of configuration errors that plagued earlier versions. ### Intelligent Package Structure The new package architecture reflects a clearer separation of concerns: - **ElectronNET.Core** - The main package containing build logic and project system integration - **ElectronNET.Core.Api** - Pure API definitions for Electron integration - **ElectronNET.Core.AspNet** - ASP.NET-specific runtime components This modular approach allows projects to include only what they need while maintaining the flexibility to scale from simple console applications to complex web applications. More about the available nuget packages: [Package Description](../RelInfo/Package-Description.md). ## Beyond ASP.NET: Console Application Support ### A Shift in Accessibility A major new opportunity in ElectronNET.Core is the removal of the ASP.NET requirement. Developers can now build Electron solutions using simple DotNet console applications, expanding the use cases and removing a major barrier to adoption for a number of use cases. ### Flexible Content Sources Console applications with ElectronNET.Core support multiple content scenarios: - **File System HTML/JS**: Serve static web content directly from the file system - **Remote Server Integration**: Connect to existing web servers or APIs - **Lightweight Architecture**: Avoid the overhead of ASP.NET when it's not needed - **Simplified Deployment**: Package and distribute with minimal dependencies This capability transforms ElectronNET from a web-focused framework into a versatile platform that can integrate with any HTML/JS content source, making it accessible to a much broader range of development scenarios and team structures. ## Revolutionary Development Experience ### Debugging Reimagined The debugging experience has been completely transformed. The new DotNet-first launch mode means developers can now debug their .NET code directly, with full access to familiar debugging tools and Hot Reload capabilities. No more attaching to processes or working around limited debugging scenarios — the development workflow now matches standard .NET development patterns. ### Cross-Platform Development Without Compromises One of the most significant breakthroughs is the ability to build and debug Linux applications directly from Windows Visual Studio through WSL integration. Developers can now: - Build Linux packages while working on Windows - Debug Linux application behavior in real-time - Test cross-platform functionality without context switching - Deploy to Linux targets with confidence This capability eliminates the traditional barriers between Windows development environments and Linux deployment targets. ### Flexible Runtime Identifier Support Runtime Identifier (RID) selection is now a first-class part of the project configuration, allowing developers to explicitly target specific platforms and architectures. The build system automatically structures output folders using standard .NET conventions (`bin\net8.0\win-x64`) instead of the ambiguous `bin\Desktop` layout, making multi-target builds clean and predictable. ## Modernized Architecture ### Process Lifecycle Revolution The underlying process architecture has been fundamentally redesigned. Instead of Electron launching first and managing the .NET process, ElectronNET.Core puts .NET in control. The .NET application launches first and runs Electron as a child process, providing: - Better process lifecycle management - More reliable application termination - Enhanced error handling and recovery - Cleaner separation between web and native concerns This architecture supports eight different launch scenarios, covering every combination of packaged/unpackaged deployment, console/ASP.NET hosting, and dotnet-first/electron-first initialization. The Electron-first launch method is still available or course. For more details, see: [Startup Methods](../GettingStarted/Startup-Methods.md). ### Unpackaged Development Mode The new unpackaged run-mode transforms development workflows by using regular .NET builds with unpackaged Electron configurations. This approach leverages .NET's incremental build capabilities for both managed and native code, dramatically reducing rebuild times and improving the development feedback loop. ## Enhanced Technical Foundation ### TypeScript Integration TypeScript compilation is now fully integrated with ASP.NET tooling, providing consistent builds across different development environments. The updated toolchain uses modern TypeScript versions with ESLint configuration, eliminating the compatibility issues that previously affected custom ElectronHostHook implementations. ### API Enhancements The improved splash screen handling with automatic path resolution eliminates common configuration pitfalls, while maintaining full backward compatibility with existing ElectronHostHook code. ### Performance Optimizations Package sizes have been reduced by eliminating unnecessary dependencies, while build performance has improved through intelligent incremental compilation. The new architecture also minimizes startup times through optimized build and launch procedures. ## Seamless Migration Path ### Backward Compatibility Focus Despite the extensive changes, ElectronNET.Core maintains complete API compatibility with existing applications. The modular package structure allows for incremental adoption, and existing ElectronHostHook implementations continue to work without modification. ### Clear Upgrade Journey The migration path is designed to be straightforward: 1. Update package references to the new structure 2. Remove the old manifest file 3. Configure project properties through Visual Studio 4. Adopt new debugging workflows at your own pace Further reading: [Migration Guide](Migration-Guide.md). ## Future Horizons ### Unlocked Possibilities This modernization removes the technical debt that was limiting Electron.NET's evolution. The flexible Electron versioning, integrated build system, and cross-platform capabilities create a foundation for: - More frequent updates and feature additions - Enhanced community contributions - Better tooling and IDE integration - Expanded platform support ### Version Independence The removal of rigid Electron version coupling means developers can now choose the Electron version that best fits their needs, with build-time validation ensuring compatibility. This approach encourages community feedback and enables faster adoption of new Electron features. ## Conclusion ElectronNET.Core represents more than just new features—it's a complete reimagining of what .NET + Electron development can be. By eliminating friction points, removing the ASP.NET requirement to support console applications, improving debugging experiences, and enabling true cross-platform development, it transforms Electron.NET from a challenging framework to work with into a modern, efficient platform for building cross-platform desktop applications. The changes address the core issues that were driving developers away from Electron.NET while opening new possibilities for the future. This foundation will enable more rapid innovation and better support for the growing demands of cross-platform .NET development. ================================================ FILE: docs/Docs.shproj ================================================ 06caadc7-de5b-47b4-ab2a-e9501459a2d1 ================================================ FILE: docs/GettingStarted/ASP.Net.md ================================================ # ASP.NET Core Setup ASP.NET Core remains the recommended approach for complex web applications with ElectronNET.Core, providing all the benefits of the ASP.NET ecosystem along with enhanced Electron integration. ## 🛠 System Requirements See [System Requirements](../GettingStarted/System-Requirements.md). ## 🚀 Quick Start ### 1. Create ASP.NET Core Project #### Visual Studio Create a new ASP.NET Core Web App in Visual Studio by selecting **New Project** and choosing one of the ASP.NET Core project templates. #### From the command line ```bash dotnet new webapp -n MyElectronWebApp cd MyElectronWebApp ``` ### 2. Install NuGet Packages #### Visual Studio Right-click the solution and select **Manage Nuget Packages**. Finr and install `ElectronNET.Core` as well as `ElectronNET.Core.AspNet`. #### From the command line ```powershell dotnet add package ElectronNET.Core dotnet add package ElectronNET.Core.AspNet ``` > [!Note] > The API package is automatically included as a dependency of `ElectronNET.Core`. ### 3. Configure Program.cs Update your `Program.cs` to enable Electron.NET: ```csharp using ElectronNET.API; using ElectronNET.API.Entities; public class Program { public static void Main(string[] args) { var builder = WebApplication.CreateBuilder(args); builder.Services.AddRazorPages(); // Add this line to enable Electron.NET: builder.UseElectron(args, ElectronAppReady); var app = builder.Build(); if (!app.Environment.IsDevelopment()) { app.UseExceptionHandler("/Error"); } app.UseStaticFiles(); app.UseRouting(); app.UseAuthorization(); app.MapRazorPages(); app.Run(); } public static async Task ElectronAppReady() { var browserWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = false }); browserWindow.OnReadyToShow += () => browserWindow.Show(); } } ``` #### ASP.NET Port If you want to launch a specific URL, you can retrieve the actual ASP.NET port from the new `ElectronNetRuntime` static class, for example: ```csharp await browserWindow.WebContents .LoadURLAsync($"http://localhost:{ElectronNetRuntime.AspNetWebPort}/mypage.html"); ``` ### 4. Alternative: IWebHostBuilder Setup For projects using the traditional `Startup.cs` pattern, please see "Traditional ASP.NET Core" in the [Migration Guide](../Core/Migration-Guide.md). ### 5. Dependency Injection ElectronNET.API can be added to your DI container within the `Startup` class. All of the modules available in Electron will be added as Singletons. ```csharp using ElectronNET.API; public void ConfigureServices(IServiceCollection services) { services.AddElectron(); } ``` ## 🚀 Next Steps - **[Debugging](../Using/Debugging.md)** - Learn about ASP.NET debugging features - **[Package Building](../Using/Package-Building.md)** - Create distributable packages - **[Startup Methods](../Using/Startup-Methods.md)** - Understanding launch scenarios ## 💡 Benefits of ASP.NET + Electron ✅ **Full Web Stack** - Use MVC, Razor Pages, Blazor, and all ASP.NET features ✅ **Hot Reload** - Edit ASP.NET code and see changes instantly ✅ **Rich Ecosystem** - Access to thousands of ASP.NET packages ✅ **Modern Development** - Latest C# features and ASP.NET patterns ✅ **Scalable Architecture** - Build complex, maintainable applications ================================================ FILE: docs/GettingStarted/Console-App.md ================================================ # Console Application Setup A major benefit in ElectronNET.Core is the ability to build Electron applications using simple console applications instead of requiring ASP.NET Core. This removes a significant barrier and enables many more use cases. ## 🎯 What You Can Build Console applications with ElectronNET.Core support multiple content scenarios: - **File System HTML/JS** - Serve static web content directly from the file system - **Remote Server Integration** - Connect to existing web servers or APIs - **Lightweight Architecture** - Avoid ASP.NET overhead when not needed - **Simplified Deployment** - Package and distribute with minimal dependencies ## 📋 Prerequisites See [System Requirements](../GettingStarted/System-Requirements.md). ## 🚀 Quick Start ### 1. Create Console Application #### Visual Studio Create a new console application in Visual Studio by selecting **New Project** and choosing one of the project templates for console apps. #### From the command line ```bash dotnet new console -n MyElectronApp cd MyElectronApp ``` ### 2. Install NuGet Packages ```powershell dotnet add package ElectronNET.Core ``` > [!Note] > The API package is automatically included as a dependency of `ElectronNET.Core`. ### 3. Configure Project File Add the Electron.NET configuration to your `.csproj` file: ```xml Exe net10.0 win-x64 ``` > [!WARNING] > Specifying `OutputType` property is crucial in order to get the ability of WSL debugging. Especially it is not included in ASP.NET projects. > When you migrate from ASP.NET to a console application, be sure to add this to the project file. ### 4. Implement Basic Structure Here's a complete console application example: ```csharp using System; using System.Threading.Tasks; using ElectronNET.API.Entities; namespace MyElectronApp public class Program { public static async Task Main(string[] args) { var runtimeController = ElectronNetRuntime.RuntimeController; try { // Start Electron runtime await runtimeController.Start(); await runtimeController.WaitReadyTask; // Initialize your Electron app await InitializeApp(); // Wait for shutdown await runtimeController.WaitStoppedTask.ConfigureAwait(false); } catch (Exception ex) { Console.WriteLine($"Error: {ex.Message}"); await runtimeController.Stop().ConfigureAwait(false); await runtimeController.WaitStoppedTask.WaitAsync(TimeSpan.FromSeconds(2)).ConfigureAwait(false); } } private static async Task InitializeApp() { // Create main window var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false, WebPreferences = new WebPreferences { // Add these two when using file:// URLs WebSecurity = false, AllowRunningInsecureContent = true, NodeIntegration = false, ContextIsolation = true } }); // Load your content (file system, remote URL, etc.) await browserWindow.WebContents.LoadURLAsync("https://example.com"); // Show window when ready browserWindow.OnReadyToShow += () => browserWindow.Show(); } } ``` ## 📁 Content Sources ### File System Content Serve HTML/JS files from your project: ```csharp // In your project root, create wwwroot/index.html var fileInfo = new FileInfo(Environment.ProcessPath); var exeFolder = fileInfo.DirectoryName; var htmlPath = Path.Combine(exeFolder, "wwwroot/index.html"); var url = new Uri(htmlPath, UriKind.Absolute); await browserWindow.WebContents.LoadFileAsync(url.ToString()); ``` ### Remote Content Load content from any web server: ```csharp await browserWindow.WebContents.LoadURLAsync("https://your-server.com/app"); ``` ## 🚀 Next Steps - **[Debugging](../Using/Debugging.md)** - Learn about debugging console applications - **[Package Building](../Using/Package-Building.md)** - Create distributable packages - **[Migration Guide](../Core/Migration-Guide.md)** - Moving from ASP.NET projects ## 💡 Benefits of Console Apps ✅ **Simpler Architecture** - No ASP.NET complexity when not needed ✅ **Flexible Content** - Use any HTML/JS source ✅ **Faster Development** - Less overhead for simple applications ✅ **Easy Deployment** - Minimal dependencies ✅ **Better Performance** - Lighter weight than full web applications ================================================ FILE: docs/GettingStarted/System-Requirements.md ================================================ ## 🛠 System Requirements ### Required Software - **.NET 8.0** or later - **Node.js 22.x** or later (see below) - **Visual Studio 2022** (recommended) or other .NET IDE ### Supported Operating Systems - **Windows 10/11** (x64, ARM64) - **macOS 11+** (Intel, Apple Silicon) - **Linux** (most distributions with glibc 2.31+) > [!Note] > For Linux development on Windows, install [WSL2](https://docs.microsoft.com/windows/wsl/install) to build and debug Linux packages. > Do not forget to install NodeJS 22.x (LTS) on WSL. > Visual Studio will automatically install .NET when debugging on WSL. In all other cases you will need to install a matching .NET SDK on WSL as well. ### NodeJS Installation ElectronNET.Core requires Node.js 22.x. Update your installation: **Windows:** 1. Download from [nodejs.org](https://nodejs.org) 2. Run the installer 3. Verify: `node --version` should show v22.x.x **Linux:** ```bash # Using Node Version Manager (recommended) curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash source ~/.bashrc nvm install 22 nvm use 22 # Or using package manager sudo apt update sudo apt install nodejs=22.* ``` ## 🚀 Next Steps - **[Debugging](../Using/Debugging.md)** - Learn about ASP.NET debugging features - **[Package Building](../Using/Package-Building.md)** - Create distributable packages - **[Startup Methods](../Using/Startup-Methods.md)** - Understanding launch scenarios ================================================ FILE: docs/Home.md ================================================ # Electron.NET Wiki Home Welcome to the **Electron.NET Core** documentation! This wiki covers everything you need to know about building cross-platform desktop applications with ASP.NET Core and Electron.NET. ## 🚀 What is Electron.NET Core? Electron.NET Core is a complete modernization of Electron.NET that eliminates the CLI tool dependency and integrates deeply with Visual Studio's MSBuild system. It transforms the development experience by providing: - **Native Visual Studio Integration** - No more CLI tools or JSON configuration files - **Console Application Support** - Build Electron apps with simple console applications, not just ASP.NET - **Cross-Platform Development** - Build and debug Linux applications from Windows via WSL - **Enhanced Debugging** - ASP.NET-first debugging with Hot Reload support - **Flexible Architecture** - Choose any Electron version and target multiple platforms ## 📚 Documentation Sections ### [Core Documentation](Core/What's-New.md) - **[What's New?](Core/What's-New.md)** - Complete overview of ElectronNET.Core features and improvements - **[Migration Guide](Core/Migration-Guide.md)** - Step-by-step migration from previous versions - **[Advanced Migration Topics](Core/Advanced-Migration-Topics.md)** - Technical details for complex scenarios ### [Getting Started](GettingStarted/ASP.Net.md) - **[ASP.NET Applications](GettingStarted/ASP.Net.md)** - Build Electron apps with ASP.NET Core - **[Console Applications](GettingStarted/Console-App.md)** - Use console apps for file system or remote content - **[Startup Methods](GettingStarted/Startup-Methods.md)** - Understanding different launch scenarios - **[Debugging](GettingStarted/Debugging.md)** - Debug Electron apps effectively in Visual Studio - **[Package Building](GettingStarted/Package-Building.md)** - Create distributable packages ### [Release Information](RelInfo/Package-Description.md) - **[Package Description](RelInfo/Package-Description.md)** - Understanding the three NuGet packages - **[Changelog](../Changelog.md)** - Complete list of changes and improvements ## 🛠 System Requirements See [System Requirements](GettingStarted/System-Requirements.md). ## 💡 Key Benefits ✅ **No CLI Tools Required** - Everything works through Visual Studio ✅ **Console App Support** - Use any HTML/JS source, not just ASP.NET ✅ **True Cross-Platform** - Build Linux apps from Windows ✅ **Modern Debugging** - Hot Reload and ASP.NET-first debugging ✅ **Flexible Packaging** - Choose any Electron version ✅ **MSBuild Integration** - Leverages .NET's build system ## 🚦 Getting Started New to ElectronNET.Core? Start here: 1. **[ASP.NET Setup](GettingStarted/ASP.Net.md)** - Traditional web application approach 2. **[Console App Setup](GettingStarted/Console-App.md)** - Lightweight console application approach 3. **[Migration Guide](Core/Migration-Guide.md)** - Moving from previous versions ## 🤝 Contributing Found an issue or want to improve the documentation? Contributions are welcome! The wiki is auto-generated from the `/docs` folder in the [GitHub repository](https://github.com/ElectronNET/Electron.NET). ================================================ FILE: docs/RelInfo/Package-Description.md ================================================ # Package Description ElectronNET.Core consists of three specialized NuGet packages designed for different development scenarios and project architectures. ## 📦 Package Overview ### ElectronNET.Core (Main Package) **Primary package for Electron.NET applications** - **Build system integration** - MSBuild targets and tasks for Electron - **Project system extensions** - Visual Studio designer integration - **Runtime orchestration** - Process lifecycle management - **Automatic configuration** - Generates electron-builder.json and package.json - **Includes ElectronNET.Core.Api** as a dependency **When to use:** - Main application projects (startup projects) - Projects that need full Electron.NET functionality - Applications requiring build-time Electron configuration ### ElectronNET.Core.Api (API Package) **Pure API definitions without build integration** - **Electron API wrappers** - Complete Electron API surface - **Type definitions** - Full TypeScript-style IntelliSense - **No build dependencies** - Clean API-only package - **Multi-platform support** - Windows, macOS, Linux **When to use:** - Class library projects that interact with Electron APIs - Projects that only need API access without build integration - Multi-project solutions where only the startup project needs build integration ### ElectronNET.Core.AspNet (ASP.NET Integration) **ASP.NET-specific runtime components** - **ASP.NET middleware** - UseElectron() extension methods - **WebHost integration** - Seamless ASP.NET + Electron hosting - **Hot Reload support** - Enhanced debugging experience - **Web-specific optimizations** - ASP.NET tailored performance **When to use:** - ASP.NET Core projects building Electron applications - Applications requiring web server functionality - Projects using MVC, Razor Pages, or Blazor ## 🏗 Architecture Benefits ### Separation of Concerns - **Build logic separate from API** - Clean dependency management - **Optional ASP.NET integration** - Use only what you need - **Multi-project friendly** - Share APIs across projects without build conflicts ### Project Scenarios **Single Project (ASP.NET):** ```xml ``` **Single Project (Console):** ```xml ``` **Multi-Project Solution (ASP.NET):** ```xml ``` **Multi-Project Solution (Console):** ```xml ``` ## 🔗 Dependency Chain ``` ElectronNET.Core.AspNet → ElectronNET.Core.Api ElectronNET.Core → ElectronNET.Core.Api ``` - **ElectronNET.Core.AspNet** depends on ElectronNET.Core.Api - **ElectronNET.Core** depends on ElectronNET.Core.Api - **ElectronNET.Core.Api** has no dependencies ## 💡 Recommendations ✅ **Start with ElectronNET.Core** for new projects ✅ **Add ElectronNET.Core.AspNet** only for ASP.NET applications ✅ **Use ElectronNET.Core.Api** for class libraries and API-only scenarios ✅ **Multi-project solutions** benefit from the modular architecture ================================================ FILE: docs/Using/Configuration.md ================================================ # Project Configuration ## 🔧 Visual Studio App Designer Electron.NET provides close integration via the Visual Studio Project System and MSBuild. After adding the ElectronNET.Core package, you will see this in the project configuration page after double-click on the 'Properties' folder or right-click on the project and choosing 'Properties': ![App Designer1](../images/app_designer1.png) ![App Designer2](../images/app_designer2.png) ## Project File Settings The same settings can be configured manually by editing the MSBuild properties in your `.csproj` file. These are the current default values when you don't make any changes: ```xml 30.4.0 26.0 win-x64 true $(MSBuildProjectName.Replace(".", "-").ToLower()) electron-builder.json $(MSBuildProjectName) ``` ### Relation to package.json ElectronNET.Core does not work with an `electron-manifest.json` file anymore. Since electron builder still expects a `package.json` file to exist, ElectronNET.Core is creating this under the hood automatically during build. For reference, here's the package.json template file that is being used, so you can see how the MSBuild properties are being mapped to `package.json` data: ```json { "name": "$(ElectronPackageId)", "productName": "$(ElectronTitle)", "build": { "appId": "$(ElectronPackageId)", "linux": { "desktop": { "entry": { "Name": "$(Title)" } }, "executableName": "$(ElectronPackageId)" }, "deb": { "desktop": { "entry": { "Name": "$(Title)" } } } }, "description": "$(Description)", "version": "$(Version)", "main": "main.js", "author": { "name": "$(Company)" }, "license": "$(License)", "executable": "$(TargetName)", "singleInstance": "$(ElectronSingleInstance)", "homepage": "$(ProjectUrl)", "splashscreen": { "imageFile": "$(ElectronSplashScreen)" } } ``` ### Node.js Integration Electron.NET requires Node.js integration to be enabled for IPC to function. If you are not using the IPC functionality you can disable Node.js integration like so: ```csharp WebPreferences wp = new WebPreferences(); wp.NodeIntegration = false; BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions { WebPreferences = wp }; ``` ### Preload Script If you require the use of a [preload script](https://www.electronjs.org/docs/latest/tutorial/tutorial-preload), you can specify the file path of the script when creating a new window like so: ```csharp WebPreferences wp = new WebPreferences(); wp.Preload = "path/to/preload.js"; BrowserWindowOptions browserWindowOptions = new BrowserWindowOptions { WebPreferences = wp }; ``` > [!IMPORTANT] > When using a preload script _AND_ running a Blazor app, `IsRunningBlazor` must be set to `false` (or removed) and the following lines must be added to the preload script: > ```js > global.process = undefined; > global.module = undefined; > ``` ## 🚀 Next Steps - **[Startup Methods](Startup-Methods.md)** - Understanding launch scenarios - **[Debugging](../Using/Debugging.md)** - Learn about ASP.NET debugging features - **[Package Building](Package-Building.md)** - Create distributable packages ================================================ FILE: docs/Using/Custom_main.md ================================================ # Using custom_main.js This guide explains how to include and use a `custom_main.js` file in your Electron.NET application for advanced Electron/Node.js customization. ## Why use custom_main.js? - Register custom protocol handlers (e.g., `myapp://`) — protocols must be registered before the app is fully initialized - Integrate Node.js modules (e.g., telemetry, OS APIs) - Control startup logic (abort, environment checks) - Set up IPC messaging or preload scripts ## Step-by-Step Process ### 1. Create the custom_main.js file Place your custom logic in `electron/custom_main.js`: ```javascript module.exports.onStartup = function(host) { // Example: Register a global shortcut for opening dev tools const { app, globalShortcut, BrowserWindow } = require('electron'); app.on('ready', () => { const ret = globalShortcut.register('Control+Shift+I', () => { BrowserWindow.getAllWindows().forEach(win => win.webContents.openDevTools()); console.log('Ctrl+Shift+I is pressed: DevTools opened!'); }); }); app.on('will-quit', () => { globalShortcut.unregisterAll(); }); return true; }; ``` ### 2. Configure your .csproj to copy custom_main.js to output Add this to your `.csproj` file: ```xml PreserveNewest .electron\custom_main.js ``` ### 3. Build and run your app Use the standard build/run commands: ```powershell dotnet build dotnet run ``` Electron.NET will automatically load and execute your `custom_main.js` before initializing the .NET backend. ## Advanced Usage Use environment variables to control features: ```javascript const env = process.env.ASPNETCORE_ENVIRONMENT || 'Production'; if (env === 'Development') { /* enable dev features */ } ``` ## Notes - `custom_main.js` must use CommonJS syntax (`module.exports.onStartup = ...`). - Place the file in your source directory and copy it to `.electron` using `.csproj`. - Electron.NET will abort startup if `onStartup` returns `false`. ### Complete example is available here [ElectronNetSampleApp](https://github.com/niteshsinghal85/ElectronNetSampleApp) ================================================ FILE: docs/Using/Debugging.md ================================================ # Debugging ElectronNET.Core transforms the debugging experience by providing native Visual Studio integration with multiple debugging modes. No more complex setup or manual process attachment—debugging now works as expected for .NET developers. ## 🎯 Debugging Modes ElectronNET.Core supports three main debugging approaches, all configured through Visual Studio's launch profiles: ### 1. ASP.NET-First Debugging (Recommended) Debug your .NET code directly with full Hot Reload support: ```json { "profiles": { "ASP.Net (unpackaged)": { "commandName": "Project", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" }, "applicationUrl": "http://localhost:8001/" } } } ``` **Benefits:** - ✅ Full C# debugging with breakpoints - ✅ Hot Reload for ASP.NET code - ✅ Edit-and-continue functionality - ✅ Native Visual Studio debugging experience ### 2. Electron-First Debugging Debug the Electron process when you need to inspect native Electron APIs: ```json { "profiles": { "Electron (unpackaged)": { "commandName": "Executable", "executablePath": "node", "commandLineArgs": "node_modules/electron/cli.js main.js -unpackedelectron", "workingDirectory": "$(TargetDir).electron", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } } ``` **Benefits:** - ✅ Debug Electron main process - ✅ Inspect native Electron APIs - ✅ Node.js debugging capabilities ### 3. Cross-Platform WSL Debugging Debug Linux builds directly from Windows Visual Studio: ```json { "profiles": { "WSL": { "commandName": "WSL2", "launchUrl": "http://localhost:8001/", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development", "ASPNETCORE_URLS": "http://localhost:8001/" }, "distributionName": "" } } } ``` **Benefits:** - ✅ Debug Linux applications from Windows - ✅ Test Linux-specific behavior - ✅ Validate cross-platform compatibility ## 🔧 Setup Instructions ### 1. Configure Launch Settings Add the debugging profiles to `Properties/launchSettings.json`: ```json { "profiles": { "ASP.Net (unpackaged)": { "commandName": "Project", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" }, "applicationUrl": "http://localhost:8001/" }, "Electron (unpackaged)": { "commandName": "Executable", "executablePath": "node", "commandLineArgs": "node_modules/electron/cli.js main.js -unpackedelectron", "workingDirectory": "$(TargetDir).electron", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "WSL": { "commandName": "WSL2", "launchUrl": "http://localhost:8001/", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development", "ASPNETCORE_URLS": "http://localhost:8001/" }, "distributionName": "" } } } ``` ### 2. Switch Runtime Identifiers When switching between Windows and WSL debugging: 1. **Right-click your project** in Solution Explorer 2. Select **Properties** 3. Adjust the Runtime Identifier Without Visual Studio: 1. **Edit** the .csproj file 2. **Update the RuntimeIdentifier**: ```xml win-x64 linux-x64 ``` ### 3. Enable WSL Debugging For WSL debugging, ensure: - **WSL2 is installed** and configured - **Linux distribution** is set in the launch profile - **Project targets Linux RID** for WSL debugging ## 🚀 Debugging Workflow ### ASP.NET-First Debugging (Default) 1. **Select "ASP.Net (unpackaged)"** profile in Visual Studio 2. **Press F5** to start debugging 3. **Set breakpoints** in your C# code 4. **Use Hot Reload** to edit ASP.NET code during runtime 5. **Stop debugging** when finished ### Electron Process Debugging 1. **Select "Electron (unpackaged)"** profile 2. **Press F5** to start debugging 3. **Attach to Electron process** if needed 4. **Debug Node.js and Electron APIs** ### Cross-Platform Debugging 1. **Set RuntimeIdentifier** to `linux-x64` 2. **Select "WSL"** profile 3. **Press F5** to debug in WSL 4. **Test Linux-specific behavior** ## 🔍 Debugging Tips ### Hot Reload - **Works with ASP.NET-first debugging** - **Edit Razor views, controllers, and pages** - **See changes instantly** without restart - **Preserves application state** ### Breakpoint Debugging ```csharp // Set breakpoints here public async Task Index() { var data = await GetData(); // ← Breakpoint return View(data); } ``` ### Process Management - **ASP.NET-first mode** automatically manages Electron process lifecycle - **Proper cleanup** on debugging session end - **No manual process killing** required ## 🛠 Troubleshooting ### Common Issues **"Electron process not found"** - Ensure Node.js 22.x is installed - Check that packages are restored (`dotnet restore`) - Verify RuntimeIdentifier matches your target platform **"WSL debugging fails"** - Install and configure WSL2 - Ensure Linux distribution is properly set up - Check that project targets correct RID **"Hot Reload not working"** - Use ASP.NET-first debugging profile - Ensure ASPNETCORE_ENVIRONMENT=Development - Check for compilation errors ## 🎨 Visual Debugging *Placeholder for image showing Visual Studio debugging interface with Electron.NET* The debugging interface provides familiar Visual Studio tools: - **Locals and Watch windows** for variable inspection - **Call Stack** for method call tracing - **Immediate Window** for runtime evaluation - **Hot Reload** indicator for edit-and-continue ## 🚀 Next Steps - **[Startup Methods](Startup-Methods.md)** - Understanding different launch scenarios - **[Package Building](Package-Building.md)** - Debug packaged applications - **[Migration Guide](../Core/Migration-Guide.md)** - Moving from old debugging workflows ## 💡 Benefits ✅ **Native Visual Studio Experience** - No complex setup or manual attachment ✅ **Hot Reload Support** - Edit ASP.NET code during debugging ✅ **Cross-Platform Debugging** - Debug Linux apps from Windows ✅ **Multiple Debugging Modes** - Choose the right approach for your needs ✅ **Process Lifecycle Management** - Automatic cleanup and proper termination ================================================ FILE: docs/Using/Package-Building.md ================================================ # Package Building ElectronNET.Core integrates with Visual Studio's publishing system to create distributable Electron packages using electron-builder. The process leverages .NET's build system while automatically generating the necessary Electron configuration files. ## 🎯 Publishing Overview The publishing process differs slightly between ASP.NET and console applications: - **ASP.NET Apps** - Use folder publishing with SelfContained=true - **Console Apps** - Use folder publishing with SelfContained=false ## 🚀 Publishing Process ### Step 1: Create Publish Profiles Add publish profiles to `Properties/PublishProfiles/`: #### ASP.NET Application Profile (Windows) **win-x64.pubxml:** ```xml Release Any CPU true FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 win-x64 48eff821-2f4d-60cc-aa44-be0f1d6e5f35 true ``` #### ASP.NET Application Profile (Linux) **linux-x64.pubxml:** ```xml Release Any CPU true FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 linux-x64 48eff821-2f4d-60cc-aa44-be0f1d6e5f35 true ``` #### ASP.NET Application Profile (macOS Apple Silicon ARM64) **osx-arm64.pubxml:** ```xml Release Any CPU true FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 osx-arm64 48eff821-2f4d-60cc-aa44-be0f1d6e5f35 true ``` #### ASP.NET Application Profile (macOS Intel x64) **osx-x64.pubxml:** ```xml Release Any CPU true FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 osx-x64 48eff821-2f4d-60cc-aa44-be0f1d6e5f35 true ``` #### Console Application Profile (Windows) **win-x64.pubxml:** ```xml Release Any CPU publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem net10.0 win-x64 false false false ``` #### Console Application Profile (Linux) **linux-x64.pubxml:** ```xml Release Any CPU publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem net10.0 linux-x64 false false ``` #### Console Application Profile (macOS Apple Silicon ARM64) **osx-arm64.pubxml:** ```xml Release Any CPU publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem net10.0 osx-arm64 false false ``` #### Console Application Profile (macOS Intel x64) **osx-x64.pubxml:** ```xml Release Any CPU publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem net10.0 osx-x64 false false ``` ### Step 2: Configure Electron Builder ElectronNET.Core automatically adds a default `electron-builder.json` file under `Properties\electron-builder.json`. Please see here for details of the available configuration options: https://www.electron.build/. ### Step 3: Publish from Visual Studio 1. **Right-click your project** in Solution Explorer 2. **Select "Publish"** 4. **Select your publish profile** (Windows/Linux) 5. **Click "Publish"** The publish process will: - Build your .NET application - Copy all files as needed - Install npm dependencies - Run electron-builder > [!NOTE] > When running publish for a Linux configuration on Windows, Electron.NET will automatically use WSL for the platform-specific steps. **After publishing**, the final results will be in `publish\Release\netx.0\xxx-xxx\` ## MacOS > [!NOTE] > macOS builds can't be created on Windows machines because they require symlinks that aren't supported on Windows (per [this Electron issue](https://github.com/electron-userland/electron-packager/issues/71)). macOS builds can be produced on either Linux or macOS machines. ## 🚀 Next Steps - **[Startup Methods](Startup-Methods.md)** - Understanding different launch modes for packaged apps - **[Debugging](Debugging.md)** - Debug packaged applications - **[Migration Guide](../Core/Migration-Guide.md)** - Update existing projects for new publishing ## 💡 Benefits ✅ **Native VS Integration** - Use familiar publish workflows ✅ **Cross-Platform Building** - Build Linux packages from Windows ✅ **Automatic Configuration** - No manual electron-builder setup ✅ **Multiple Package Types** - NSIS, AppImage, DMG, etc. ✅ **CI/CD Ready** - Easy integration with build pipelines ================================================ FILE: docs/Using/Startup-Methods.md ================================================ # Startup Methods ElectronNET.Core supports multiple startup methods to handle different development and deployment scenarios. The framework automatically detects the appropriate mode based on command-line flags and environment. ## 🎯 Startup Scenarios The framework supports **8 different launch scenarios** covering every combination of: - **Packaged vs Unpackaged** deployment - **Console vs ASP.NET** application types - **Dotnet-first vs Electron-first** initialization ## 🚀 Command-Line Flags ### Unpackaged Debugging Modes #### **`-unpackedelectron`** - Electron-first debugging ```bash # Launch Electron first, which then starts .NET node node_modules/electron/cli.js main.js -unpackedelectron ``` #### **`-unpackeddotnet`** - .NET-first debugging ```bash # Launch .NET first, which then starts Electron dotnet run -unpackeddotnet ``` ### Packaged Deployment Modes #### **`-dotnetpacked`** - .NET-first packaged execution ```bash # Run packaged app with .NET starting first MyApp.exe -dotnetpacked ``` #### **No flags** - Electron-first packaged execution (default) ```bash # Run packaged app with Electron starting first MyApp.exe ``` ## 📋 Startup Method Details ### 1. Unpackaged + Electron-First (Development) - **Use Case**: Debug Electron main process and Node.js code - **Command**: `-unpackedelectron` flag - **Process Flow**: 1. Electron starts first 2. Electron launches .NET process 3. .NET connects back to Electron 4. Application runs with Electron in control ### 2. Unpackaged + .NET-First (Development) - **Use Case**: Debug ASP.NET/C# code with Hot Reload - **Command**: `-unpackeddotnet` flag - **Process Flow**: 1. .NET application starts first 2. .NET launches Electron process 3. Electron connects back to .NET 4. Application runs with .NET in control ### 3. Packaged + .NET-First (Production) - **Use Case**: Deployed application with .NET controlling lifecycle - **Command**: `-dotnetpacked` flag - **Process Flow**: 1. .NET executable starts first 2. .NET launches Electron from packaged files 3. Electron loads from app.asar or extracted files 4. .NET maintains process control ### 4. Packaged + Electron-First (Production) - **Use Case**: Traditional Electron app behavior - **Command**: No special flags - **Process Flow**: 1. Electron executable starts first 2. Electron launches .NET from packaged files 3. .NET runs from Electron's process context 4. Electron maintains UI control ## 🔧 Configuration Examples ### ASP.NET Application Startup ```csharp // Program.cs var builder = WebApplication.CreateBuilder(args); // Configure for different startup modes builder.WebHost.UseElectron(args, async () => { var browserWindow = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = false }); await browserWindow.WebContents.LoadURLAsync("http://localhost:8001"); browserWindow.OnReadyToShow += () => browserWindow.Show(); }); var app = builder.Build(); app.Run(); ``` ### Console Application Startup ```csharp // Program.cs public static async Task Main(string[] args) { var runtimeController = ElectronNetRuntime.RuntimeController; await runtimeController.Start(); await runtimeController.WaitReadyTask; await InitializeApplication(); await runtimeController.WaitStoppedTask; } ``` ## 🎨 Visual Process Flow ![Startup Modes](../images/startup_modes.png) The image above illustrates how each combination of deployment type, application type, and initialization order affects the process lifecycle. ## 🚀 Development Workflows ### Debugging Workflow **ASP.NET-First Debugging** (Recommended) ```json // launchSettings.json { "ASP.Net (unpackaged)": { "commandName": "Project", "commandLineArgs": "-unpackeddotnet" } } ``` **Electron-First Debugging** ```json // launchSettings.json { "Electron (unpackaged)": { "commandName": "Executable", "executablePath": "node", "commandLineArgs": "node_modules/electron/cli.js main.js -unpackedelectron" } } ``` ### Production Deployment **Dotnet-First Deployment** ```bash # Build and package dotnet publish -c Release -r win-x64 cd publish\Release\net8.0\win-x64 npm install npx electron-builder # Run with dotnet-first MyApp.exe -dotnetpacked ``` **Electron-First Deployment** (Default) ```bash # Run packaged application (no special flags needed) MyApp.exe ``` ## 🔍 Process Lifecycle Management ### Automatic Cleanup ElectronNET.Core automatically manages process lifecycle: - **Graceful shutdown** when main window is closed - **Proper cleanup** of child processes - **Error handling** for process failures - **Cross-platform compatibility** for process management ### Manual Control Access runtime controller for advanced scenarios: ```csharp var runtime = ElectronNetRuntime.RuntimeController; // Wait for Electron to be ready await runtime.WaitReadyTask; // Stop Electron runtime await runtime.Stop(); await runtime.WaitStoppedTask; ``` ## 🛠 Troubleshooting ### Common Startup Issues **"Electron process not found"** - Ensure Node.js 22.x is installed - Check that .NET build succeeded - Verify RuntimeIdentifier is set correctly **"Port conflicts"** - Use different ports for different startup modes - Check that no other instances are running - Verify firewall settings **"Process won't terminate"** - Use dotnet-first mode for better cleanup - Check for unhandled exceptions - Verify all windows are properly closed ## 💡 Best Practices ### Choose the Right Mode - **Development**: Use .NET-first for C# debugging, Electron-first for Node.js debugging - **Production**: Use .NET-first for better process control, Electron-first for traditional behavior - **Cross-platform**: Use .NET-first for consistent behavior across platforms ### Environment Configuration ```xml Production ``` ## 🚀 Next Steps - **[Debugging](Debugging.md)** - Debug different startup modes - **[Package Building](Package-Building.md)** - Package for different deployment scenarios - **[Migration Guide](../Core/Migration-Guide.md)** - Update existing apps for new startup methods ## 🎯 Summary The flexible startup system ensures ElectronNET.Core works optimally in every scenario while providing the control and debugging experience .NET developers expect. Choose the appropriate mode based on your development workflow and deployment requirements. ================================================ FILE: docs/_Footer.md ================================================ Want to contribute to this documentation? Please fork and create a PR! The Wiki is autogenerated from the /docs content in the repository. ================================================ FILE: docs/_Sidebar.md ================================================ # Wiki - [Home](Home.md) - [About this Project](About.md) # Electron.NET Core - [What's new?](Core/What's-New.md) - [Migration Guide](Core/Migration-Guide.md) - [Migration Checks](Core/Migration-Checks.md) - [Advanced Migration](Core/Advanced-Migration-Topics.md) # Getting Started - [System Requirements](GettingStarted/System-Requirements.md) - [With ASP.Net](GettingStarted/ASP.Net.md) - [With a Console App](GettingStarted/Console-App.md) # Using Electron.NET - [Configuration](Using/Configuration.md) - [Startup-Methods](Using/Startup-Methods.md) - [Debugging](Using/Debugging.md) - [Package Building](Using/Package-Building.md) - [Adding a `custom_main.js`](Using/Custom_main.md) # API Reference - [API Overview](API/Overview.md) - [Electron.App](API/App.md) - [Electron.Dialog](API/Dialog.md) - [Electron.Menu](API/Menu.md) - [Electron.WindowManager](API/WindowManager.md) - [Electron.Shell](API/Shell.md) - [Electron.Screen](API/Screen.md) - [Electron.Notification](API/Notification.md) - [Electron.Tray](API/Tray.md) - [Electron.Clipboard](API/Clipboard.md) - [Electron.Dock](API/Dock.md) - [Electron.HostHook](API/HostHook.md) - [Electron.IpcMain](API/IpcMain.md) - [Electron.GlobalShortcut](API/GlobalShortcut.md) - [Electron.AutoUpdater](API/AutoUpdater.md) - [Electron.NativeTheme](API/NativeTheme.md) - [Electron.PowerMonitor](API/PowerMonitor.md) # Release Information - [Package Description](RelInfo/Package-Description.md) - [Changelog](RelInfo/Changelog.md) ================================================ FILE: docs/md-styles.css ================================================ /*! * Bootstrap v3.4.1 (https://getbootstrap.com/) * Copyright 2011-2019 Twitter, Inc. * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE) */ /*! normalize.css v3.0.3 | MIT License | github.com/necolas/normalize.css */ html { font-family: sans-serif; -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100% } article, aside, details, figcaption, figure, footer, header, hgroup, main, menu, nav, section, summary { display: block } audio, canvas, progress, video { display: inline-block; vertical-align: baseline } audio:not([controls]) { display: none; height: 0 } [hidden], template { display: none } a:active, a:hover { outline: 0 } abbr[title] { border-bottom: none; text-decoration: underline; -webkit-text-decoration: underline dotted; -moz-text-decoration: underline dotted; text-decoration: underline dotted } b, optgroup, strong { font-weight: 700 } dfn { font-style: italic } h1 { margin: .67em 0 } mark { background: #ff0; color: #000 } sub, sup { font-size: 75%; line-height: 0; position: relative; vertical-align: baseline } sup { top: -.5em } sub { bottom: -.25em } img { border: 0; vertical-align: middle } svg:not(:root) { overflow: hidden } hr { -webkit-box-sizing: content-box; -moz-box-sizing: content-box; box-sizing: content-box; height: 0 } code, kbd, pre, samp { font-size: 1em } button, input, optgroup, select, textarea { color: inherit; font: inherit; margin: 0 } button { overflow: visible } button, select { text-transform: none } button, html input[type=button], input[type=reset], input[type=submit] { -webkit-appearance: button; cursor: pointer } button[disabled], html input[disabled] { cursor: default } button::-moz-focus-inner, input::-moz-focus-inner { border: 0; padding: 0 } input { line-height: normal } input[type=checkbox], input[type=radio] { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; padding: 0 } input[type=number]::-webkit-inner-spin-button, input[type=number]::-webkit-outer-spin-button { height: auto } input[type=search] { -webkit-appearance: textfield; -webkit-box-sizing: content-box; -moz-box-sizing: content-box; box-sizing: content-box } input[type=search]::-webkit-search-cancel-button, input[type=search]::-webkit-search-decoration { -webkit-appearance: none } textarea { overflow: auto } td, th { padding: 0 } /*! Source: https://github.com/h5bp/html5-boilerplate/blob/master/src/css/main.css */ @media print { *, :after, :before { color: #000 !important; text-shadow: none !important; background: 0 0 !important; -webkit-box-shadow: none !important; box-shadow: none !important } a, a:visited { text-decoration: underline } a[href]:after { content: " (" attr(href) ")" } abbr[title]:after { content: " (" attr(title) ")" } a[href^="#"]:after, a[href^="javascript:"]:after { content: "" } blockquote, pre { border: 1px solid #999; page-break-inside: avoid } thead { display: table-header-group } img, tr { page-break-inside: avoid } img { max-width: 100% !important } h2, h3, p { orphans: 3; widows: 3 } h2, h3 { page-break-after: avoid } .navbar { display: none } .btn > .caret, .dropup > .btn > .caret { border-top-color: #000 !important } .label { border: 1px solid #000 } .table { border-collapse: collapse !important } .table td, .table th { background-color: #fff !important } .table-bordered td, .table-bordered th { border: 1px solid #ddd !important } } @font-face { font-family: "Glyphicons Halflings"; src: url("../fonts/glyphicons-halflings-regular.eot"); src: url("../fonts/glyphicons-halflings-regular.eot?#iefix") format("embedded-opentype"),url("../fonts/glyphicons-halflings-regular.woff2") format("woff2"),url("../fonts/glyphicons-halflings-regular.woff") format("woff"),url("../fonts/glyphicons-halflings-regular.ttf") format("truetype"),url("../fonts/glyphicons-halflings-regular.svg#glyphicons_halflingsregular") format("svg") } .glyphicon { position: relative; top: 1px; display: inline-block; font-family: "Glyphicons Halflings"; font-style: normal; font-weight: 400; line-height: 1; -webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale } .glyphicon-asterisk:before { content: "\002a" } .glyphicon-plus:before { content: "\002b" } .glyphicon-eur:before, .glyphicon-euro:before { content: "\20ac" } .glyphicon-minus:before { content: "\2212" } .glyphicon-cloud:before { content: "\2601" } .glyphicon-envelope:before { content: "\2709" } .glyphicon-pencil:before { content: "\270f" } .glyphicon-glass:before { content: "\e001" } .glyphicon-music:before { content: "\e002" } .glyphicon-search:before { content: "\e003" } .glyphicon-heart:before { content: "\e005" } .glyphicon-star:before { content: "\e006" } .glyphicon-star-empty:before { content: "\e007" } .glyphicon-user:before { content: "\e008" } .glyphicon-film:before { content: "\e009" } .glyphicon-th-large:before { content: "\e010" } .glyphicon-th:before { content: "\e011" } .glyphicon-th-list:before { content: "\e012" } .glyphicon-ok:before { content: "\e013" } .glyphicon-remove:before { content: "\e014" } .glyphicon-zoom-in:before { content: "\e015" } .glyphicon-zoom-out:before { content: "\e016" } .glyphicon-off:before { content: "\e017" } .glyphicon-signal:before { content: "\e018" } .glyphicon-cog:before { content: "\e019" } .glyphicon-trash:before { content: "\e020" } .glyphicon-home:before { content: "\e021" } .glyphicon-file:before { content: "\e022" } .glyphicon-time:before { content: "\e023" } .glyphicon-road:before { content: "\e024" } .glyphicon-download-alt:before { content: "\e025" } .glyphicon-download:before { content: "\e026" } .glyphicon-upload:before { content: "\e027" } .glyphicon-inbox:before { content: "\e028" } .glyphicon-play-circle:before { content: "\e029" } .glyphicon-repeat:before { content: "\e030" } .glyphicon-refresh:before { content: "\e031" } .glyphicon-list-alt:before { content: "\e032" } .glyphicon-lock:before { content: "\e033" } .glyphicon-flag:before { content: "\e034" } .glyphicon-headphones:before { content: "\e035" } .glyphicon-volume-off:before { content: "\e036" } .glyphicon-volume-down:before { content: "\e037" } .glyphicon-volume-up:before { content: "\e038" } .glyphicon-qrcode:before { content: "\e039" } .glyphicon-barcode:before { content: "\e040" } .glyphicon-tag:before { content: "\e041" } .glyphicon-tags:before { content: "\e042" } .glyphicon-book:before { content: "\e043" } .glyphicon-bookmark:before { content: "\e044" } .glyphicon-print:before { content: "\e045" } .glyphicon-camera:before { content: "\e046" } .glyphicon-font:before { content: "\e047" } .glyphicon-bold:before { content: "\e048" } .glyphicon-italic:before { content: "\e049" } .glyphicon-text-height:before { content: "\e050" } .glyphicon-text-width:before { content: "\e051" } .glyphicon-align-left:before { content: "\e052" } .glyphicon-align-center:before { content: "\e053" } .glyphicon-align-right:before { content: "\e054" } .glyphicon-align-justify:before { content: "\e055" } .glyphicon-list:before { content: "\e056" } .glyphicon-indent-left:before { content: "\e057" } .glyphicon-indent-right:before { content: "\e058" } .glyphicon-facetime-video:before { content: "\e059" } .glyphicon-picture:before { content: "\e060" } .glyphicon-map-marker:before { content: "\e062" } .glyphicon-adjust:before { content: "\e063" } .glyphicon-tint:before { content: "\e064" } .glyphicon-edit:before { content: "\e065" } .glyphicon-share:before { content: "\e066" } .glyphicon-check:before { content: "\e067" } .glyphicon-move:before { content: "\e068" } .glyphicon-step-backward:before { content: "\e069" } .glyphicon-fast-backward:before { content: "\e070" } .glyphicon-backward:before { content: "\e071" } .glyphicon-play:before { content: "\e072" } .glyphicon-pause:before { content: "\e073" } .glyphicon-stop:before { content: "\e074" } .glyphicon-forward:before { content: "\e075" } .glyphicon-fast-forward:before { content: "\e076" } .glyphicon-step-forward:before { content: "\e077" } .glyphicon-eject:before { content: "\e078" } .glyphicon-chevron-left:before { content: "\e079" } .glyphicon-chevron-right:before { content: "\e080" } .glyphicon-plus-sign:before { content: "\e081" } .glyphicon-minus-sign:before { content: "\e082" } .glyphicon-remove-sign:before { content: "\e083" } .glyphicon-ok-sign:before { content: "\e084" } .glyphicon-question-sign:before { content: "\e085" } .glyphicon-info-sign:before { content: "\e086" } .glyphicon-screenshot:before { content: "\e087" } .glyphicon-remove-circle:before { content: "\e088" } .glyphicon-ok-circle:before { content: "\e089" } .glyphicon-ban-circle:before { content: "\e090" } .glyphicon-arrow-left:before { content: "\e091" } .glyphicon-arrow-right:before { content: "\e092" } .glyphicon-arrow-up:before { content: "\e093" } .glyphicon-arrow-down:before { content: "\e094" } .glyphicon-share-alt:before { content: "\e095" } .glyphicon-resize-full:before { content: "\e096" } .glyphicon-resize-small:before { content: "\e097" } .glyphicon-exclamation-sign:before { content: "\e101" } .glyphicon-gift:before { content: "\e102" } .glyphicon-leaf:before { content: "\e103" } .glyphicon-fire:before { content: "\e104" } .glyphicon-eye-open:before { content: "\e105" } .glyphicon-eye-close:before { content: "\e106" } .glyphicon-warning-sign:before { content: "\e107" } .glyphicon-plane:before { content: "\e108" } .glyphicon-calendar:before { content: "\e109" } .glyphicon-random:before { content: "\e110" } .glyphicon-comment:before { content: "\e111" } .glyphicon-magnet:before { content: "\e112" } .glyphicon-chevron-up:before { content: "\e113" } .glyphicon-chevron-down:before { content: "\e114" } .glyphicon-retweet:before { content: "\e115" } .glyphicon-shopping-cart:before { content: "\e116" } .glyphicon-folder-close:before { content: "\e117" } .glyphicon-folder-open:before { content: "\e118" } .glyphicon-resize-vertical:before { content: "\e119" } .glyphicon-resize-horizontal:before { content: "\e120" } .glyphicon-hdd:before { content: "\e121" } .glyphicon-bullhorn:before { content: "\e122" } .glyphicon-bell:before { content: "\e123" } .glyphicon-certificate:before { content: "\e124" } .glyphicon-thumbs-up:before { content: "\e125" } .glyphicon-thumbs-down:before { content: "\e126" } .glyphicon-hand-right:before { content: "\e127" } .glyphicon-hand-left:before { content: "\e128" } .glyphicon-hand-up:before { content: "\e129" } .glyphicon-hand-down:before { content: "\e130" } .glyphicon-circle-arrow-right:before { content: "\e131" } .glyphicon-circle-arrow-left:before { content: "\e132" } .glyphicon-circle-arrow-up:before { content: "\e133" } .glyphicon-circle-arrow-down:before { content: "\e134" } .glyphicon-globe:before { content: "\e135" } .glyphicon-wrench:before { content: "\e136" } .glyphicon-tasks:before { content: "\e137" } .glyphicon-filter:before { content: "\e138" } .glyphicon-briefcase:before { content: "\e139" } .glyphicon-fullscreen:before { content: "\e140" } .glyphicon-dashboard:before { content: "\e141" } .glyphicon-paperclip:before { content: "\e142" } .glyphicon-heart-empty:before { content: "\e143" } .glyphicon-link:before { content: "\e144" } .glyphicon-phone:before { content: "\e145" } .glyphicon-pushpin:before { content: "\e146" } .glyphicon-usd:before { content: "\e148" } .glyphicon-gbp:before { content: "\e149" } .glyphicon-sort:before { content: "\e150" } .glyphicon-sort-by-alphabet:before { content: "\e151" } .glyphicon-sort-by-alphabet-alt:before { content: "\e152" } .glyphicon-sort-by-order:before { content: "\e153" } .glyphicon-sort-by-order-alt:before { content: "\e154" } .glyphicon-sort-by-attributes:before { content: "\e155" } .glyphicon-sort-by-attributes-alt:before { content: "\e156" } .glyphicon-unchecked:before { content: "\e157" } .glyphicon-expand:before { content: "\e158" } .glyphicon-collapse-down:before { content: "\e159" } .glyphicon-collapse-up:before { content: "\e160" } .glyphicon-log-in:before { content: "\e161" } .glyphicon-flash:before { content: "\e162" } .glyphicon-log-out:before { content: "\e163" } .glyphicon-new-window:before { content: "\e164" } .glyphicon-record:before { content: "\e165" } .glyphicon-save:before { content: "\e166" } .glyphicon-open:before { content: "\e167" } .glyphicon-saved:before { content: "\e168" } .glyphicon-import:before { content: "\e169" } .glyphicon-export:before { content: "\e170" } .glyphicon-send:before { content: "\e171" } .glyphicon-floppy-disk:before { content: "\e172" } .glyphicon-floppy-saved:before { content: "\e173" } .glyphicon-floppy-remove:before { content: "\e174" } .glyphicon-floppy-save:before { content: "\e175" } .glyphicon-floppy-open:before { content: "\e176" } .glyphicon-credit-card:before { content: "\e177" } .glyphicon-transfer:before { content: "\e178" } .glyphicon-cutlery:before { content: "\e179" } .glyphicon-header:before { content: "\e180" } .glyphicon-compressed:before { content: "\e181" } .glyphicon-earphone:before { content: "\e182" } .glyphicon-phone-alt:before { content: "\e183" } .glyphicon-tower:before { content: "\e184" } .glyphicon-stats:before { content: "\e185" } .glyphicon-sd-video:before { content: "\e186" } .glyphicon-hd-video:before { content: "\e187" } .glyphicon-subtitles:before { content: "\e188" } .glyphicon-sound-stereo:before { content: "\e189" } .glyphicon-sound-dolby:before { content: "\e190" } .glyphicon-sound-5-1:before { content: "\e191" } .glyphicon-sound-6-1:before { content: "\e192" } .glyphicon-sound-7-1:before { content: "\e193" } .glyphicon-copyright-mark:before { content: "\e194" } .glyphicon-registration-mark:before { content: "\e195" } .glyphicon-cloud-download:before { content: "\e197" } .glyphicon-cloud-upload:before { content: "\e198" } .glyphicon-tree-conifer:before { content: "\e199" } .glyphicon-tree-deciduous:before { content: "\e200" } .glyphicon-cd:before { content: "\e201" } .glyphicon-save-file:before { content: "\e202" } .glyphicon-open-file:before { content: "\e203" } .glyphicon-level-up:before { content: "\e204" } .glyphicon-copy:before { content: "\e205" } .glyphicon-paste:before { content: "\e206" } .glyphicon-alert:before { content: "\e209" } .glyphicon-equalizer:before { content: "\e210" } .glyphicon-king:before { content: "\e211" } .glyphicon-queen:before { content: "\e212" } .glyphicon-pawn:before { content: "\e213" } .glyphicon-bishop:before { content: "\e214" } .glyphicon-knight:before { content: "\e215" } .glyphicon-baby-formula:before { content: "\e216" } .glyphicon-tent:before { content: "\26fa" } .glyphicon-blackboard:before { content: "\e218" } .glyphicon-bed:before { content: "\e219" } .glyphicon-apple:before { content: "\f8ff" } .glyphicon-erase:before { content: "\e221" } .glyphicon-hourglass:before { content: "\231b" } .glyphicon-lamp:before { content: "\e223" } .glyphicon-duplicate:before { content: "\e224" } .glyphicon-piggy-bank:before { content: "\e225" } .glyphicon-scissors:before { content: "\e226" } .glyphicon-bitcoin:before, .glyphicon-btc:before, .glyphicon-xbt:before { content: "\e227" } .glyphicon-jpy:before, .glyphicon-yen:before { content: "\00a5" } .glyphicon-rub:before, .glyphicon-ruble:before { content: "\20bd" } .glyphicon-scale:before { content: "\e230" } .glyphicon-ice-lolly:before { content: "\e231" } .glyphicon-ice-lolly-tasted:before { content: "\e232" } .glyphicon-education:before { content: "\e233" } .glyphicon-option-horizontal:before { content: "\e234" } .glyphicon-option-vertical:before { content: "\e235" } .glyphicon-menu-hamburger:before { content: "\e236" } .glyphicon-modal-window:before { content: "\e237" } .glyphicon-oil:before { content: "\e238" } .glyphicon-grain:before { content: "\e239" } .glyphicon-sunglasses:before { content: "\e240" } .glyphicon-text-size:before { content: "\e241" } .glyphicon-text-color:before { content: "\e242" } .glyphicon-text-background:before { content: "\e243" } .glyphicon-object-align-top:before { content: "\e244" } .glyphicon-object-align-bottom:before { content: "\e245" } .glyphicon-object-align-horizontal:before { content: "\e246" } .glyphicon-object-align-left:before { content: "\e247" } .glyphicon-object-align-vertical:before { content: "\e248" } .glyphicon-object-align-right:before { content: "\e249" } .glyphicon-triangle-right:before { content: "\e250" } .glyphicon-triangle-left:before { content: "\e251" } .glyphicon-triangle-bottom:before { content: "\e252" } .glyphicon-triangle-top:before { content: "\e253" } .glyphicon-console:before { content: "\e254" } .glyphicon-superscript:before { content: "\e255" } .glyphicon-subscript:before { content: "\e256" } .glyphicon-menu-left:before { content: "\e257" } .glyphicon-menu-right:before { content: "\e258" } .glyphicon-menu-down:before { content: "\e259" } .glyphicon-menu-up:before { content: "\e260" } *, :after, :before { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box } html { font-size: 10px; -webkit-tap-highlight-color: transparent } button, input, select, textarea { font-family: inherit; font-size: inherit; line-height: inherit } a { background-color: transparent; color: #337ab7; text-decoration: none } a:focus, a:hover { color: #23527c; text-decoration: underline } a:focus { outline: -webkit-focus-ring-color auto 5px; outline-offset: -2px } figure { margin: 0 } .carousel-inner > .item > a > img, .carousel-inner > .item > img, .img-responsive, .thumbnail a > img, .thumbnail > img { display: block; max-width: 100%; height: auto } .img-rounded { border-radius: 6px } .img-thumbnail { padding: 4px; line-height: 1.42857143; background-color: #fff; border: 1px solid #ddd; border-radius: 4px; -webkit-transition: .2s ease-in-out; -o-transition: .2s ease-in-out; transition: .2s ease-in-out; display: inline-block; max-width: 100%; height: auto } .img-circle { border-radius: 50% } hr { margin-top: 20px; margin-bottom: 20px; border: 0; border-top: 1px solid #eee } .sr-only { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0,0,0,0); border: 0 } .sr-only-focusable:active, .sr-only-focusable:focus { position: static; width: auto; height: auto; margin: 0; overflow: visible; clip: auto } [role=button] { cursor: pointer } .h1, .h2, .h3, .h4, .h5, .h6, h1, h2, h3, h4, h5, h6 { font-family: inherit; font-weight: 500; line-height: 1.1; color: inherit } .h1 .small, .h1 small, .h2 .small, .h2 small, .h3 .small, .h3 small, .h4 .small, .h4 small, .h5 .small, .h5 small, .h6 .small, .h6 small, h1 .small, h1 small, h2 .small, h2 small, h3 .small, h3 small, h4 .small, h4 small, h5 .small, h5 small, h6 .small, h6 small { font-weight: 400; line-height: 1; color: #777 } .h1, .h2, .h3, h1, h2, h3 { margin-top: 20px; margin-bottom: 10px } .h1 .small, .h1 small, .h2 .small, .h2 small, .h3 .small, .h3 small, h1 .small, h1 small, h2 .small, h2 small, h3 .small, h3 small { font-size: 65% } .h4, .h5, .h6, h4, h5, h6 { margin-top: 10px; margin-bottom: 10px } .h4 .small, .h4 small, .h5 .small, .h5 small, .h6 .small, .h6 small, h4 .small, h4 small, h5 .small, h5 small, h6 .small, h6 small { font-size: 75% } .h1, h1 { font-size: 36px } .h2, h2 { font-size: 30px } .h3, h3 { font-size: 24px } .h4, h4 { font-size: 18px } .h5, h5 { font-size: 14px } .h6, h6 { font-size: 12px } p { margin: 0 0 10px } .lead { margin-bottom: 20px; font-size: 16px; font-weight: 300; line-height: 1.4 } @media (min-width:768px) { .lead { font-size: 21px } .dl-horizontal dt { float: left; width: 160px; clear: left; text-align: right; overflow: hidden; text-overflow: ellipsis; white-space: nowrap } .dl-horizontal dd { margin-left: 180px } } .small, small { font-size: 85% } .mark, mark { padding: .2em; background-color: #fcf8e3 } .text-left { text-align: left } .text-right { text-align: right } .text-center { text-align: center } .text-justify { text-align: justify } .text-nowrap { white-space: nowrap } .text-lowercase { text-transform: lowercase } .text-uppercase { text-transform: uppercase } .text-capitalize { text-transform: capitalize } .text-muted { color: #777 } .text-primary { color: #337ab7 } a.text-primary:focus, a.text-primary:hover { color: #286090 } .text-success { color: #3c763d } a.text-success:focus, a.text-success:hover { color: #2b542c } .text-info { color: #31708f } a.text-info:focus, a.text-info:hover { color: #245269 } .text-warning { color: #8a6d3b } a.text-warning:focus, a.text-warning:hover { color: #66512c } .text-danger { color: #a94442 } a.text-danger:focus, a.text-danger:hover { color: #843534 } .bg-primary { color: #fff; background-color: #337ab7 } a.bg-primary:focus, a.bg-primary:hover { background-color: #286090 } .bg-success { background-color: #dff0d8 } a.bg-success:focus, a.bg-success:hover { background-color: #c1e2b3 } .bg-info { background-color: #d9edf7 } a.bg-info:focus, a.bg-info:hover { background-color: #afd9ee } .bg-warning { background-color: #fcf8e3 } a.bg-warning:focus, a.bg-warning:hover { background-color: #f7ecb5 } .bg-danger { background-color: #f2dede } a.bg-danger:focus, a.bg-danger:hover { background-color: #e4b9b9 } .page-header { padding-bottom: 9px; margin: 40px 0 20px; border-bottom: 1px solid #eee } ol, ul { margin-top: 0; margin-bottom: 10px } ol ol, ol ul, ul ol, ul ul { margin-bottom: 0 } .list-unstyled { padding-left: 0; list-style: none } .list-inline { padding-left: 0; list-style: none; margin-left: -5px } .list-inline > li { display: inline-block; padding-right: 5px; padding-left: 5px } dl { margin-top: 0; margin-bottom: 20px } dd, dt { line-height: 1.42857143 } dt { font-weight: 700 } dd { margin-left: 0 } abbr[data-original-title], abbr[title] { cursor: help } .initialism { font-size: 90%; text-transform: uppercase } blockquote { padding: 10px 20px; margin: 0 0 20px; font-size: 17.5px; border-left: 5px solid #eee } blockquote ol:last-child, blockquote p:last-child, blockquote ul:last-child { margin-bottom: 0 } blockquote .small, blockquote footer, blockquote small { display: block; font-size: 80%; line-height: 1.42857143; color: #777 } blockquote .small:before, blockquote footer:before, blockquote small:before { content: "\2014 \00A0" } .blockquote-reverse, blockquote.pull-right { padding-right: 15px; padding-left: 0; text-align: right; border-right: 5px solid #eee; border-left: 0 } .blockquote-reverse .small:before, .blockquote-reverse footer:before, .blockquote-reverse small:before, blockquote.pull-right .small:before, blockquote.pull-right footer:before, blockquote.pull-right small:before { content: "" } .blockquote-reverse .small:after, .blockquote-reverse footer:after, .blockquote-reverse small:after, blockquote.pull-right .small:after, blockquote.pull-right footer:after, blockquote.pull-right small:after { content: "\00A0 \2014" } address { margin-bottom: 20px; font-style: normal; line-height: 1.42857143 } code, kbd, pre, samp { font-family: Menlo,Monaco,Consolas,"Courier New",monospace } code { padding: 2px 4px; font-size: 90%; color: #c7254e; background-color: #f9f2f4; border-radius: 4px } kbd { padding: 2px 4px; font-size: 90%; color: #fff; background-color: #333; border-radius: 3px; -webkit-box-shadow: inset 0 -1px 0 rgba(0,0,0,.25); box-shadow: inset 0 -1px 0 rgba(0,0,0,.25) } kbd kbd { padding: 0; font-size: 100%; font-weight: 700; -webkit-box-shadow: none; box-shadow: none } pre { overflow: auto; display: block; padding: 9.5px; margin: 0 0 10px; font-size: 13px; line-height: 1.42857143; color: #333; word-break: break-all; word-wrap: break-word; background-color: #f5f5f5; border: 1px solid #ccc; border-radius: 4px } pre code { padding: 0; font-size: inherit; color: inherit; white-space: pre-wrap; background-color: transparent; border-radius: 0 } .pre-scrollable { max-height: 340px; overflow-y: scroll } .container { padding-right: 15px; padding-left: 15px; margin-right: auto; margin-left: auto } @media (min-width:768px) { .container { width: 750px } } @media (min-width:992px) { .container { width: 970px } } @media (min-width:1200px) { .container { width: 1170px } } .container-fluid { padding-right: 15px; padding-left: 15px; margin-right: auto; margin-left: auto } .row { margin-right: -15px; margin-left: -15px } .row-no-gutters { margin-right: 0; margin-left: 0 } .row-no-gutters [class*=col-] { padding-right: 0; padding-left: 0 } .col-lg-1, .col-lg-10, .col-lg-11, .col-lg-12, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9, .col-md-1, .col-md-10, .col-md-11, .col-md-12, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9, .col-sm-1, .col-sm-10, .col-sm-11, .col-sm-12, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9, .col-xs-1, .col-xs-10, .col-xs-11, .col-xs-12, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9 { position: relative; min-height: 1px; padding-right: 15px; padding-left: 15px } .col-xs-1, .col-xs-10, .col-xs-11, .col-xs-12, .col-xs-2, .col-xs-3, .col-xs-4, .col-xs-5, .col-xs-6, .col-xs-7, .col-xs-8, .col-xs-9 { float: left } .col-xs-12 { width: 100% } .col-xs-11 { width: 91.66666667% } .col-xs-10 { width: 83.33333333% } .col-xs-9 { width: 75% } .col-xs-8 { width: 66.66666667% } .col-xs-7 { width: 58.33333333% } .col-xs-6 { width: 50% } .col-xs-5 { width: 41.66666667% } .col-xs-4 { width: 33.33333333% } .col-xs-3 { width: 25% } .col-xs-2 { width: 16.66666667% } .col-xs-1 { width: 8.33333333% } .col-xs-pull-12 { right: 100% } .col-xs-pull-11 { right: 91.66666667% } .col-xs-pull-10 { right: 83.33333333% } .col-xs-pull-9 { right: 75% } .col-xs-pull-8 { right: 66.66666667% } .col-xs-pull-7 { right: 58.33333333% } .col-xs-pull-6 { right: 50% } .col-xs-pull-5 { right: 41.66666667% } .col-xs-pull-4 { right: 33.33333333% } .col-xs-pull-3 { right: 25% } .col-xs-pull-2 { right: 16.66666667% } .col-xs-pull-1 { right: 8.33333333% } .col-xs-pull-0 { right: auto } .col-xs-push-12 { left: 100% } .col-xs-push-11 { left: 91.66666667% } .col-xs-push-10 { left: 83.33333333% } .col-xs-push-9 { left: 75% } .col-xs-push-8 { left: 66.66666667% } .col-xs-push-7 { left: 58.33333333% } .col-xs-push-6 { left: 50% } .col-xs-push-5 { left: 41.66666667% } .col-xs-push-4 { left: 33.33333333% } .col-xs-push-3 { left: 25% } .col-xs-push-2 { left: 16.66666667% } .col-xs-push-1 { left: 8.33333333% } .col-xs-push-0 { left: auto } .col-xs-offset-12 { margin-left: 100% } .col-xs-offset-11 { margin-left: 91.66666667% } .col-xs-offset-10 { margin-left: 83.33333333% } .col-xs-offset-9 { margin-left: 75% } .col-xs-offset-8 { margin-left: 66.66666667% } .col-xs-offset-7 { margin-left: 58.33333333% } .col-xs-offset-6 { margin-left: 50% } .col-xs-offset-5 { margin-left: 41.66666667% } .col-xs-offset-4 { margin-left: 33.33333333% } .col-xs-offset-3 { margin-left: 25% } .col-xs-offset-2 { margin-left: 16.66666667% } .col-xs-offset-1 { margin-left: 8.33333333% } .col-xs-offset-0 { margin-left: 0 } @media (min-width:768px) { .col-sm-1, .col-sm-10, .col-sm-11, .col-sm-12, .col-sm-2, .col-sm-3, .col-sm-4, .col-sm-5, .col-sm-6, .col-sm-7, .col-sm-8, .col-sm-9 { float: left } .col-sm-12 { width: 100% } .col-sm-11 { width: 91.66666667% } .col-sm-10 { width: 83.33333333% } .col-sm-9 { width: 75% } .col-sm-8 { width: 66.66666667% } .col-sm-7 { width: 58.33333333% } .col-sm-6 { width: 50% } .col-sm-5 { width: 41.66666667% } .col-sm-4 { width: 33.33333333% } .col-sm-3 { width: 25% } .col-sm-2 { width: 16.66666667% } .col-sm-1 { width: 8.33333333% } .col-sm-pull-12 { right: 100% } .col-sm-pull-11 { right: 91.66666667% } .col-sm-pull-10 { right: 83.33333333% } .col-sm-pull-9 { right: 75% } .col-sm-pull-8 { right: 66.66666667% } .col-sm-pull-7 { right: 58.33333333% } .col-sm-pull-6 { right: 50% } .col-sm-pull-5 { right: 41.66666667% } .col-sm-pull-4 { right: 33.33333333% } .col-sm-pull-3 { right: 25% } .col-sm-pull-2 { right: 16.66666667% } .col-sm-pull-1 { right: 8.33333333% } .col-sm-pull-0 { right: auto } .col-sm-push-12 { left: 100% } .col-sm-push-11 { left: 91.66666667% } .col-sm-push-10 { left: 83.33333333% } .col-sm-push-9 { left: 75% } .col-sm-push-8 { left: 66.66666667% } .col-sm-push-7 { left: 58.33333333% } .col-sm-push-6 { left: 50% } .col-sm-push-5 { left: 41.66666667% } .col-sm-push-4 { left: 33.33333333% } .col-sm-push-3 { left: 25% } .col-sm-push-2 { left: 16.66666667% } .col-sm-push-1 { left: 8.33333333% } .col-sm-push-0 { left: auto } .col-sm-offset-12 { margin-left: 100% } .col-sm-offset-11 { margin-left: 91.66666667% } .col-sm-offset-10 { margin-left: 83.33333333% } .col-sm-offset-9 { margin-left: 75% } .col-sm-offset-8 { margin-left: 66.66666667% } .col-sm-offset-7 { margin-left: 58.33333333% } .col-sm-offset-6 { margin-left: 50% } .col-sm-offset-5 { margin-left: 41.66666667% } .col-sm-offset-4 { margin-left: 33.33333333% } .col-sm-offset-3 { margin-left: 25% } .col-sm-offset-2 { margin-left: 16.66666667% } .col-sm-offset-1 { margin-left: 8.33333333% } .col-sm-offset-0 { margin-left: 0 } } @media (min-width:992px) { .col-md-1, .col-md-10, .col-md-11, .col-md-12, .col-md-2, .col-md-3, .col-md-4, .col-md-5, .col-md-6, .col-md-7, .col-md-8, .col-md-9 { float: left } .col-md-12 { width: 100% } .col-md-11 { width: 91.66666667% } .col-md-10 { width: 83.33333333% } .col-md-9 { width: 75% } .col-md-8 { width: 66.66666667% } .col-md-7 { width: 58.33333333% } .col-md-6 { width: 50% } .col-md-5 { width: 41.66666667% } .col-md-4 { width: 33.33333333% } .col-md-3 { width: 25% } .col-md-2 { width: 16.66666667% } .col-md-1 { width: 8.33333333% } .col-md-pull-12 { right: 100% } .col-md-pull-11 { right: 91.66666667% } .col-md-pull-10 { right: 83.33333333% } .col-md-pull-9 { right: 75% } .col-md-pull-8 { right: 66.66666667% } .col-md-pull-7 { right: 58.33333333% } .col-md-pull-6 { right: 50% } .col-md-pull-5 { right: 41.66666667% } .col-md-pull-4 { right: 33.33333333% } .col-md-pull-3 { right: 25% } .col-md-pull-2 { right: 16.66666667% } .col-md-pull-1 { right: 8.33333333% } .col-md-pull-0 { right: auto } .col-md-push-12 { left: 100% } .col-md-push-11 { left: 91.66666667% } .col-md-push-10 { left: 83.33333333% } .col-md-push-9 { left: 75% } .col-md-push-8 { left: 66.66666667% } .col-md-push-7 { left: 58.33333333% } .col-md-push-6 { left: 50% } .col-md-push-5 { left: 41.66666667% } .col-md-push-4 { left: 33.33333333% } .col-md-push-3 { left: 25% } .col-md-push-2 { left: 16.66666667% } .col-md-push-1 { left: 8.33333333% } .col-md-push-0 { left: auto } .col-md-offset-12 { margin-left: 100% } .col-md-offset-11 { margin-left: 91.66666667% } .col-md-offset-10 { margin-left: 83.33333333% } .col-md-offset-9 { margin-left: 75% } .col-md-offset-8 { margin-left: 66.66666667% } .col-md-offset-7 { margin-left: 58.33333333% } .col-md-offset-6 { margin-left: 50% } .col-md-offset-5 { margin-left: 41.66666667% } .col-md-offset-4 { margin-left: 33.33333333% } .col-md-offset-3 { margin-left: 25% } .col-md-offset-2 { margin-left: 16.66666667% } .col-md-offset-1 { margin-left: 8.33333333% } .col-md-offset-0 { margin-left: 0 } } @media (min-width:1200px) { .col-lg-1, .col-lg-10, .col-lg-11, .col-lg-12, .col-lg-2, .col-lg-3, .col-lg-4, .col-lg-5, .col-lg-6, .col-lg-7, .col-lg-8, .col-lg-9 { float: left } .col-lg-12 { width: 100% } .col-lg-11 { width: 91.66666667% } .col-lg-10 { width: 83.33333333% } .col-lg-9 { width: 75% } .col-lg-8 { width: 66.66666667% } .col-lg-7 { width: 58.33333333% } .col-lg-6 { width: 50% } .col-lg-5 { width: 41.66666667% } .col-lg-4 { width: 33.33333333% } .col-lg-3 { width: 25% } .col-lg-2 { width: 16.66666667% } .col-lg-1 { width: 8.33333333% } .col-lg-pull-12 { right: 100% } .col-lg-pull-11 { right: 91.66666667% } .col-lg-pull-10 { right: 83.33333333% } .col-lg-pull-9 { right: 75% } .col-lg-pull-8 { right: 66.66666667% } .col-lg-pull-7 { right: 58.33333333% } .col-lg-pull-6 { right: 50% } .col-lg-pull-5 { right: 41.66666667% } .col-lg-pull-4 { right: 33.33333333% } .col-lg-pull-3 { right: 25% } .col-lg-pull-2 { right: 16.66666667% } .col-lg-pull-1 { right: 8.33333333% } .col-lg-pull-0 { right: auto } .col-lg-push-12 { left: 100% } .col-lg-push-11 { left: 91.66666667% } .col-lg-push-10 { left: 83.33333333% } .col-lg-push-9 { left: 75% } .col-lg-push-8 { left: 66.66666667% } .col-lg-push-7 { left: 58.33333333% } .col-lg-push-6 { left: 50% } .col-lg-push-5 { left: 41.66666667% } .col-lg-push-4 { left: 33.33333333% } .col-lg-push-3 { left: 25% } .col-lg-push-2 { left: 16.66666667% } .col-lg-push-1 { left: 8.33333333% } .col-lg-push-0 { left: auto } .col-lg-offset-12 { margin-left: 100% } .col-lg-offset-11 { margin-left: 91.66666667% } .col-lg-offset-10 { margin-left: 83.33333333% } .col-lg-offset-9 { margin-left: 75% } .col-lg-offset-8 { margin-left: 66.66666667% } .col-lg-offset-7 { margin-left: 58.33333333% } .col-lg-offset-6 { margin-left: 50% } .col-lg-offset-5 { margin-left: 41.66666667% } .col-lg-offset-4 { margin-left: 33.33333333% } .col-lg-offset-3 { margin-left: 25% } .col-lg-offset-2 { margin-left: 16.66666667% } .col-lg-offset-1 { margin-left: 8.33333333% } .col-lg-offset-0 { margin-left: 0 } } table { border-collapse: collapse; border-spacing: 0; background-color: transparent } table col[class*=col-] { position: static; display: table-column; float: none } table td[class*=col-], table th[class*=col-] { position: static; display: table-cell; float: none } caption { padding-top: 8px; padding-bottom: 8px; color: #777; text-align: left } th { text-align: left } .table { width: 100%; max-width: 100%; margin-bottom: 20px } .table > tbody > tr > td, .table > tbody > tr > th, .table > tfoot > tr > td, .table > tfoot > tr > th, .table > thead > tr > td, .table > thead > tr > th { padding: 8px; line-height: 1.42857143; vertical-align: top; border-top: 1px solid #ddd } .table > thead > tr > th { vertical-align: bottom; border-bottom: 2px solid #ddd } .table > caption + thead > tr:first-child > td, .table > caption + thead > tr:first-child > th, .table > colgroup + thead > tr:first-child > td, .table > colgroup + thead > tr:first-child > th, .table > thead:first-child > tr:first-child > td, .table > thead:first-child > tr:first-child > th { border-top: 0 } .table > tbody + tbody { border-top: 2px solid #ddd } .table .table { background-color: #fff } .table-condensed > tbody > tr > td, .table-condensed > tbody > tr > th, .table-condensed > tfoot > tr > td, .table-condensed > tfoot > tr > th, .table-condensed > thead > tr > td, .table-condensed > thead > tr > th { padding: 5px } .table-bordered, .table-bordered > tbody > tr > td, .table-bordered > tbody > tr > th, .table-bordered > tfoot > tr > td, .table-bordered > tfoot > tr > th, .table-bordered > thead > tr > td, .table-bordered > thead > tr > th { border: 1px solid #ddd } .table-bordered > thead > tr > td, .table-bordered > thead > tr > th { border-bottom-width: 2px } .table-striped > tbody > tr:nth-of-type(odd) { background-color: #f9f9f9 } .table-hover > tbody > tr:hover, .table > tbody > tr.active > td, .table > tbody > tr.active > th, .table > tbody > tr > td.active, .table > tbody > tr > th.active, .table > tfoot > tr.active > td, .table > tfoot > tr.active > th, .table > tfoot > tr > td.active, .table > tfoot > tr > th.active, .table > thead > tr.active > td, .table > thead > tr.active > th, .table > thead > tr > td.active, .table > thead > tr > th.active { background-color: #f5f5f5 } .table-hover > tbody > tr.active:hover > td, .table-hover > tbody > tr.active:hover > th, .table-hover > tbody > tr:hover > .active, .table-hover > tbody > tr > td.active:hover, .table-hover > tbody > tr > th.active:hover { background-color: #e8e8e8 } .table > tbody > tr.success > td, .table > tbody > tr.success > th, .table > tbody > tr > td.success, .table > tbody > tr > th.success, .table > tfoot > tr.success > td, .table > tfoot > tr.success > th, .table > tfoot > tr > td.success, .table > tfoot > tr > th.success, .table > thead > tr.success > td, .table > thead > tr.success > th, .table > thead > tr > td.success, .table > thead > tr > th.success { background-color: #dff0d8 } .table-hover > tbody > tr.success:hover > td, .table-hover > tbody > tr.success:hover > th, .table-hover > tbody > tr:hover > .success, .table-hover > tbody > tr > td.success:hover, .table-hover > tbody > tr > th.success:hover { background-color: #d0e9c6 } .table > tbody > tr.info > td, .table > tbody > tr.info > th, .table > tbody > tr > td.info, .table > tbody > tr > th.info, .table > tfoot > tr.info > td, .table > tfoot > tr.info > th, .table > tfoot > tr > td.info, .table > tfoot > tr > th.info, .table > thead > tr.info > td, .table > thead > tr.info > th, .table > thead > tr > td.info, .table > thead > tr > th.info { background-color: #d9edf7 } .table-hover > tbody > tr.info:hover > td, .table-hover > tbody > tr.info:hover > th, .table-hover > tbody > tr:hover > .info, .table-hover > tbody > tr > td.info:hover, .table-hover > tbody > tr > th.info:hover { background-color: #c4e3f3 } .table > tbody > tr.warning > td, .table > tbody > tr.warning > th, .table > tbody > tr > td.warning, .table > tbody > tr > th.warning, .table > tfoot > tr.warning > td, .table > tfoot > tr.warning > th, .table > tfoot > tr > td.warning, .table > tfoot > tr > th.warning, .table > thead > tr.warning > td, .table > thead > tr.warning > th, .table > thead > tr > td.warning, .table > thead > tr > th.warning { background-color: #fcf8e3 } .table-hover > tbody > tr.warning:hover > td, .table-hover > tbody > tr.warning:hover > th, .table-hover > tbody > tr:hover > .warning, .table-hover > tbody > tr > td.warning:hover, .table-hover > tbody > tr > th.warning:hover { background-color: #faf2cc } .table > tbody > tr.danger > td, .table > tbody > tr.danger > th, .table > tbody > tr > td.danger, .table > tbody > tr > th.danger, .table > tfoot > tr.danger > td, .table > tfoot > tr.danger > th, .table > tfoot > tr > td.danger, .table > tfoot > tr > th.danger, .table > thead > tr.danger > td, .table > thead > tr.danger > th, .table > thead > tr > td.danger, .table > thead > tr > th.danger { background-color: #f2dede } .table-hover > tbody > tr.danger:hover > td, .table-hover > tbody > tr.danger:hover > th, .table-hover > tbody > tr:hover > .danger, .table-hover > tbody > tr > td.danger:hover, .table-hover > tbody > tr > th.danger:hover { background-color: #ebcccc } .table-responsive { min-height: .01%; overflow-x: auto } @media screen and (max-width:767px) { .table-responsive { width: 100%; margin-bottom: 15px; overflow-y: hidden; -ms-overflow-style: -ms-autohiding-scrollbar; border: 1px solid #ddd } .table-responsive > .table { margin-bottom: 0 } .table-responsive > .table > tbody > tr > td, .table-responsive > .table > tbody > tr > th, .table-responsive > .table > tfoot > tr > td, .table-responsive > .table > tfoot > tr > th, .table-responsive > .table > thead > tr > td, .table-responsive > .table > thead > tr > th { white-space: nowrap } .table-responsive > .table-bordered { border: 0 } .table-responsive > .table-bordered > tbody > tr > td:first-child, .table-responsive > .table-bordered > tbody > tr > th:first-child, .table-responsive > .table-bordered > tfoot > tr > td:first-child, .table-responsive > .table-bordered > tfoot > tr > th:first-child, .table-responsive > .table-bordered > thead > tr > td:first-child, .table-responsive > .table-bordered > thead > tr > th:first-child { border-left: 0 } .table-responsive > .table-bordered > tbody > tr > td:last-child, .table-responsive > .table-bordered > tbody > tr > th:last-child, .table-responsive > .table-bordered > tfoot > tr > td:last-child, .table-responsive > .table-bordered > tfoot > tr > th:last-child, .table-responsive > .table-bordered > thead > tr > td:last-child, .table-responsive > .table-bordered > thead > tr > th:last-child { border-right: 0 } .table-responsive > .table-bordered > tbody > tr:last-child > td, .table-responsive > .table-bordered > tbody > tr:last-child > th, .table-responsive > .table-bordered > tfoot > tr:last-child > td, .table-responsive > .table-bordered > tfoot > tr:last-child > th { border-bottom: 0 } } fieldset { min-width: 0; padding: 0; margin: 0; border: 0 } legend { display: block; width: 100%; padding: 0; margin-bottom: 20px; font-size: 21px; line-height: inherit; color: #333; border: 0; border-bottom: 1px solid #e5e5e5 } label { display: inline-block; max-width: 100%; margin-bottom: 5px; font-weight: 700 } input[type=search] { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; -webkit-appearance: none; -moz-appearance: none; appearance: none } input[type=checkbox], input[type=radio] { margin: 4px 0 0; line-height: normal } fieldset[disabled] input[type=checkbox], fieldset[disabled] input[type=radio], input[type=checkbox].disabled, input[type=checkbox][disabled], input[type=radio].disabled, input[type=radio][disabled] { cursor: not-allowed } input[type=file] { display: block } input[type=range] { display: block; width: 100% } select[multiple], select[size] { height: auto } input[type=checkbox]:focus, input[type=file]:focus, input[type=radio]:focus { outline: -webkit-focus-ring-color auto 5px; outline-offset: -2px } output { display: block; padding-top: 7px; font-size: 14px; line-height: 1.42857143; color: #555 } .form-control { display: block; width: 100%; height: 34px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; color: #555; background-color: #fff; background-image: none; border: 1px solid #ccc; border-radius: 4px; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075); box-shadow: inset 0 1px 1px rgba(0,0,0,.075); -webkit-transition: border-color .15s ease-in-out,-webkit-box-shadow .15s ease-in-out; -o-transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out; transition: border-color .15s ease-in-out,box-shadow .15s ease-in-out,-webkit-box-shadow .15s ease-in-out } .form-control:focus { border-color: #66afe9; outline: 0; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6); box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 8px rgba(102,175,233,.6) } .form-control::-moz-placeholder { color: #999; opacity: 1 } .form-control:-ms-input-placeholder { color: #999 } .form-control::-webkit-input-placeholder { color: #999 } .form-control::-ms-expand { background-color: transparent; border: 0 } .form-control[disabled], .form-control[readonly], fieldset[disabled] .form-control { background-color: #eee; opacity: 1 } .form-control[disabled], fieldset[disabled] .form-control { cursor: not-allowed } textarea.form-control { height: auto } @media screen and (-webkit-min-device-pixel-ratio:0) { input[type=date].form-control, input[type=datetime-local].form-control, input[type=month].form-control, input[type=time].form-control { line-height: 34px } .input-group-sm input[type=date], .input-group-sm input[type=datetime-local], .input-group-sm input[type=month], .input-group-sm input[type=time], input[type=date].input-sm, input[type=datetime-local].input-sm, input[type=month].input-sm, input[type=time].input-sm { line-height: 30px } .input-group-lg input[type=date], .input-group-lg input[type=datetime-local], .input-group-lg input[type=month], .input-group-lg input[type=time], input[type=date].input-lg, input[type=datetime-local].input-lg, input[type=month].input-lg, input[type=time].input-lg { line-height: 46px } } .form-group { margin-bottom: 15px } .checkbox, .radio { position: relative; display: block; margin-top: 10px; margin-bottom: 10px } .checkbox.disabled label, .radio.disabled label, fieldset[disabled] .checkbox label, fieldset[disabled] .radio label { cursor: not-allowed } .checkbox label, .radio label { min-height: 20px; padding-left: 20px; margin-bottom: 0; font-weight: 400; cursor: pointer } .checkbox input[type=checkbox], .checkbox-inline input[type=checkbox], .radio input[type=radio], .radio-inline input[type=radio] { position: absolute; margin-left: -20px } .checkbox + .checkbox, .radio + .radio { margin-top: -5px } .checkbox-inline, .radio-inline { position: relative; display: inline-block; padding-left: 20px; margin-bottom: 0; font-weight: 400; vertical-align: middle; cursor: pointer } .checkbox-inline.disabled, .radio-inline.disabled, fieldset[disabled] .checkbox-inline, fieldset[disabled] .radio-inline { cursor: not-allowed } .checkbox-inline + .checkbox-inline, .radio-inline + .radio-inline { margin-top: 0; margin-left: 10px } .form-control-static { min-height: 34px; padding-top: 7px; padding-bottom: 7px; margin-bottom: 0 } .form-control-static.input-lg, .form-control-static.input-sm { padding-right: 0; padding-left: 0 } .input-sm { height: 30px; padding: 5px 10px; font-size: 12px; line-height: 1.5; border-radius: 3px } select.input-sm { height: 30px; line-height: 30px } select[multiple].input-sm, textarea.input-sm { height: auto } .form-group-sm .form-control { height: 30px; padding: 5px 10px; font-size: 12px; line-height: 1.5; border-radius: 3px } .form-group-sm select.form-control { height: 30px; line-height: 30px } .form-group-sm select[multiple].form-control, .form-group-sm textarea.form-control { height: auto } .form-group-sm .form-control-static { height: 30px; min-height: 32px; padding: 6px 10px; font-size: 12px; line-height: 1.5 } .input-lg { height: 46px; padding: 10px 16px; font-size: 18px; line-height: 1.3333333; border-radius: 6px } select.input-lg { height: 46px; line-height: 46px } select[multiple].input-lg, textarea.input-lg { height: auto } .form-group-lg .form-control { height: 46px; padding: 10px 16px; font-size: 18px; line-height: 1.3333333; border-radius: 6px } .form-group-lg select.form-control { height: 46px; line-height: 46px } .form-group-lg select[multiple].form-control, .form-group-lg textarea.form-control { height: auto } .form-group-lg .form-control-static { height: 46px; min-height: 38px; padding: 11px 16px; font-size: 18px; line-height: 1.3333333 } .has-feedback { position: relative } .has-feedback .form-control { padding-right: 42.5px } .form-control-feedback { position: absolute; top: 0; right: 0; z-index: 2; display: block; width: 34px; height: 34px; line-height: 34px; text-align: center; pointer-events: none } .form-group-lg .form-control + .form-control-feedback, .input-group-lg + .form-control-feedback, .input-lg + .form-control-feedback { width: 46px; height: 46px; line-height: 46px } .form-group-sm .form-control + .form-control-feedback, .input-group-sm + .form-control-feedback, .input-sm + .form-control-feedback { width: 30px; height: 30px; line-height: 30px } .has-success .checkbox, .has-success .checkbox-inline, .has-success .control-label, .has-success .help-block, .has-success .radio, .has-success .radio-inline, .has-success.checkbox label, .has-success.checkbox-inline label, .has-success.radio label, .has-success.radio-inline label { color: #3c763d } .has-success .form-control { border-color: #3c763d; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075); box-shadow: inset 0 1px 1px rgba(0,0,0,.075) } .has-success .form-control:focus { border-color: #2b542c; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168; box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #67b168 } .has-success .input-group-addon { color: #3c763d; background-color: #dff0d8; border-color: #3c763d } .has-success .form-control-feedback { color: #3c763d } .has-warning .checkbox, .has-warning .checkbox-inline, .has-warning .control-label, .has-warning .help-block, .has-warning .radio, .has-warning .radio-inline, .has-warning.checkbox label, .has-warning.checkbox-inline label, .has-warning.radio label, .has-warning.radio-inline label { color: #8a6d3b } .has-warning .form-control { border-color: #8a6d3b; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075); box-shadow: inset 0 1px 1px rgba(0,0,0,.075) } .has-warning .form-control:focus { border-color: #66512c; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b; box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #c0a16b } .has-warning .input-group-addon { color: #8a6d3b; background-color: #fcf8e3; border-color: #8a6d3b } .has-warning .form-control-feedback { color: #8a6d3b } .has-error .checkbox, .has-error .checkbox-inline, .has-error .control-label, .has-error .help-block, .has-error .radio, .has-error .radio-inline, .has-error.checkbox label, .has-error.checkbox-inline label, .has-error.radio label, .has-error.radio-inline label { color: #a94442 } .has-error .form-control { border-color: #a94442; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075); box-shadow: inset 0 1px 1px rgba(0,0,0,.075) } .has-error .form-control:focus { border-color: #843534; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483; box-shadow: inset 0 1px 1px rgba(0,0,0,.075),0 0 6px #ce8483 } .has-error .input-group-addon { color: #a94442; background-color: #f2dede; border-color: #a94442 } .has-error .form-control-feedback { color: #a94442 } .has-feedback label ~ .form-control-feedback { top: 25px } .has-feedback label.sr-only ~ .form-control-feedback { top: 0 } .help-block { display: block; margin-top: 5px; margin-bottom: 10px; color: #737373 } .form-horizontal .checkbox, .form-horizontal .checkbox-inline, .form-horizontal .radio, .form-horizontal .radio-inline { padding-top: 7px; margin-top: 0; margin-bottom: 0 } .form-horizontal .checkbox, .form-horizontal .radio { min-height: 27px } .form-horizontal .form-group { margin-right: -15px; margin-left: -15px } .form-horizontal .has-feedback .form-control-feedback { right: 15px } @media (min-width:768px) { .form-inline .form-group { display: inline-block; margin-bottom: 0; vertical-align: middle } .form-inline .form-control { display: inline-block; width: auto; vertical-align: middle } .form-inline .form-control-static { display: inline-block } .form-inline .input-group { display: inline-table; vertical-align: middle } .form-inline .input-group .form-control, .form-inline .input-group .input-group-addon, .form-inline .input-group .input-group-btn { width: auto } .form-inline .input-group > .form-control { width: 100% } .form-inline .control-label { margin-bottom: 0; vertical-align: middle } .form-inline .checkbox, .form-inline .radio { display: inline-block; margin-top: 0; margin-bottom: 0; vertical-align: middle } .form-inline .checkbox label, .form-inline .radio label { padding-left: 0 } .form-inline .checkbox input[type=checkbox], .form-inline .radio input[type=radio] { position: relative; margin-left: 0 } .form-inline .has-feedback .form-control-feedback { top: 0 } .form-horizontal .control-label { padding-top: 7px; margin-bottom: 0; text-align: right } .form-horizontal .form-group-lg .control-label { padding-top: 11px; font-size: 18px } .form-horizontal .form-group-sm .control-label { padding-top: 6px; font-size: 12px } } .btn { display: inline-block; margin-bottom: 0; font-weight: 400; text-align: center; white-space: nowrap; vertical-align: middle; -ms-touch-action: manipulation; touch-action: manipulation; cursor: pointer; background-image: none; border: 1px solid transparent; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; border-radius: 4px; -webkit-user-select: none; -moz-user-select: none; -ms-user-select: none; user-select: none } .btn.active.focus, .btn.active:focus, .btn.focus, .btn:active.focus, .btn:active:focus, .btn:focus { outline: -webkit-focus-ring-color auto 5px; outline-offset: -2px } .btn.focus, .btn:focus, .btn:hover { color: #333; text-decoration: none } .btn.active, .btn:active { background-image: none; outline: 0; -webkit-box-shadow: inset 0 3px 5px rgba(0,0,0,.125); box-shadow: inset 0 3px 5px rgba(0,0,0,.125) } .btn.disabled, .btn[disabled], fieldset[disabled] .btn { cursor: not-allowed; opacity: .65; -webkit-box-shadow: none; box-shadow: none } a.btn.disabled, fieldset[disabled] a.btn { pointer-events: none } .btn-default { color: #333; background-color: #fff; border-color: #ccc } .btn-default.focus, .btn-default:focus { color: #333; background-color: #e6e6e6; border-color: #8c8c8c } .btn-default:hover { color: #333; background-color: #e6e6e6; border-color: #adadad } .btn-default.active, .btn-default:active, .open > .dropdown-toggle.btn-default { color: #333; background-color: #e6e6e6; background-image: none; border-color: #adadad } .btn-default.active.focus, .btn-default.active:focus, .btn-default.active:hover, .btn-default:active.focus, .btn-default:active:focus, .btn-default:active:hover, .open > .dropdown-toggle.btn-default.focus, .open > .dropdown-toggle.btn-default:focus, .open > .dropdown-toggle.btn-default:hover { color: #333; background-color: #d4d4d4; border-color: #8c8c8c } .btn-default.disabled.focus, .btn-default.disabled:focus, .btn-default.disabled:hover, .btn-default[disabled].focus, .btn-default[disabled]:focus, .btn-default[disabled]:hover, fieldset[disabled] .btn-default.focus, fieldset[disabled] .btn-default:focus, fieldset[disabled] .btn-default:hover { background-color: #fff; border-color: #ccc } .btn-default .badge { color: #fff; background-color: #333 } .btn-primary { color: #fff; background-color: #337ab7; border-color: #2e6da4 } .btn-primary.focus, .btn-primary:focus { color: #fff; background-color: #286090; border-color: #122b40 } .btn-primary:hover { color: #fff; background-color: #286090; border-color: #204d74 } .btn-primary.active, .btn-primary:active, .open > .dropdown-toggle.btn-primary { color: #fff; background-color: #286090; background-image: none; border-color: #204d74 } .btn-primary.active.focus, .btn-primary.active:focus, .btn-primary.active:hover, .btn-primary:active.focus, .btn-primary:active:focus, .btn-primary:active:hover, .open > .dropdown-toggle.btn-primary.focus, .open > .dropdown-toggle.btn-primary:focus, .open > .dropdown-toggle.btn-primary:hover { color: #fff; background-color: #204d74; border-color: #122b40 } .btn-primary.disabled.focus, .btn-primary.disabled:focus, .btn-primary.disabled:hover, .btn-primary[disabled].focus, .btn-primary[disabled]:focus, .btn-primary[disabled]:hover, fieldset[disabled] .btn-primary.focus, fieldset[disabled] .btn-primary:focus, fieldset[disabled] .btn-primary:hover { background-color: #337ab7; border-color: #2e6da4 } .btn-primary .badge { color: #337ab7; background-color: #fff } .btn-success { color: #fff; background-color: #5cb85c; border-color: #4cae4c } .btn-success.focus, .btn-success:focus { color: #fff; background-color: #449d44; border-color: #255625 } .btn-success:hover { color: #fff; background-color: #449d44; border-color: #398439 } .btn-success.active, .btn-success:active, .open > .dropdown-toggle.btn-success { color: #fff; background-color: #449d44; background-image: none; border-color: #398439 } .btn-success.active.focus, .btn-success.active:focus, .btn-success.active:hover, .btn-success:active.focus, .btn-success:active:focus, .btn-success:active:hover, .open > .dropdown-toggle.btn-success.focus, .open > .dropdown-toggle.btn-success:focus, .open > .dropdown-toggle.btn-success:hover { color: #fff; background-color: #398439; border-color: #255625 } .btn-success.disabled.focus, .btn-success.disabled:focus, .btn-success.disabled:hover, .btn-success[disabled].focus, .btn-success[disabled]:focus, .btn-success[disabled]:hover, fieldset[disabled] .btn-success.focus, fieldset[disabled] .btn-success:focus, fieldset[disabled] .btn-success:hover { background-color: #5cb85c; border-color: #4cae4c } .btn-success .badge { color: #5cb85c; background-color: #fff } .btn-info { color: #fff; background-color: #5bc0de; border-color: #46b8da } .btn-info.focus, .btn-info:focus { color: #fff; background-color: #31b0d5; border-color: #1b6d85 } .btn-info:hover { color: #fff; background-color: #31b0d5; border-color: #269abc } .btn-info.active, .btn-info:active, .open > .dropdown-toggle.btn-info { color: #fff; background-color: #31b0d5; background-image: none; border-color: #269abc } .btn-info.active.focus, .btn-info.active:focus, .btn-info.active:hover, .btn-info:active.focus, .btn-info:active:focus, .btn-info:active:hover, .open > .dropdown-toggle.btn-info.focus, .open > .dropdown-toggle.btn-info:focus, .open > .dropdown-toggle.btn-info:hover { color: #fff; background-color: #269abc; border-color: #1b6d85 } .btn-info.disabled.focus, .btn-info.disabled:focus, .btn-info.disabled:hover, .btn-info[disabled].focus, .btn-info[disabled]:focus, .btn-info[disabled]:hover, fieldset[disabled] .btn-info.focus, fieldset[disabled] .btn-info:focus, fieldset[disabled] .btn-info:hover { background-color: #5bc0de; border-color: #46b8da } .btn-info .badge { color: #5bc0de; background-color: #fff } .btn-warning { color: #fff; background-color: #f0ad4e; border-color: #eea236 } .btn-warning.focus, .btn-warning:focus { color: #fff; background-color: #ec971f; border-color: #985f0d } .btn-warning:hover { color: #fff; background-color: #ec971f; border-color: #d58512 } .btn-warning.active, .btn-warning:active, .open > .dropdown-toggle.btn-warning { color: #fff; background-color: #ec971f; background-image: none; border-color: #d58512 } .btn-warning.active.focus, .btn-warning.active:focus, .btn-warning.active:hover, .btn-warning:active.focus, .btn-warning:active:focus, .btn-warning:active:hover, .open > .dropdown-toggle.btn-warning.focus, .open > .dropdown-toggle.btn-warning:focus, .open > .dropdown-toggle.btn-warning:hover { color: #fff; background-color: #d58512; border-color: #985f0d } .btn-warning.disabled.focus, .btn-warning.disabled:focus, .btn-warning.disabled:hover, .btn-warning[disabled].focus, .btn-warning[disabled]:focus, .btn-warning[disabled]:hover, fieldset[disabled] .btn-warning.focus, fieldset[disabled] .btn-warning:focus, fieldset[disabled] .btn-warning:hover { background-color: #f0ad4e; border-color: #eea236 } .btn-warning .badge { color: #f0ad4e; background-color: #fff } .btn-danger { color: #fff; background-color: #d9534f; border-color: #d43f3a } .btn-danger.focus, .btn-danger:focus { color: #fff; background-color: #c9302c; border-color: #761c19 } .btn-danger:hover { color: #fff; background-color: #c9302c; border-color: #ac2925 } .btn-danger.active, .btn-danger:active, .open > .dropdown-toggle.btn-danger { color: #fff; background-color: #c9302c; background-image: none; border-color: #ac2925 } .btn-danger.active.focus, .btn-danger.active:focus, .btn-danger.active:hover, .btn-danger:active.focus, .btn-danger:active:focus, .btn-danger:active:hover, .open > .dropdown-toggle.btn-danger.focus, .open > .dropdown-toggle.btn-danger:focus, .open > .dropdown-toggle.btn-danger:hover { color: #fff; background-color: #ac2925; border-color: #761c19 } .btn-danger.disabled.focus, .btn-danger.disabled:focus, .btn-danger.disabled:hover, .btn-danger[disabled].focus, .btn-danger[disabled]:focus, .btn-danger[disabled]:hover, fieldset[disabled] .btn-danger.focus, fieldset[disabled] .btn-danger:focus, fieldset[disabled] .btn-danger:hover { background-color: #d9534f; border-color: #d43f3a } .btn-danger .badge { color: #d9534f; background-color: #fff } .btn-link { font-weight: 400; color: #337ab7; border-radius: 0 } .btn-link, .btn-link.active, .btn-link:active, .btn-link[disabled], fieldset[disabled] .btn-link { background-color: transparent; -webkit-box-shadow: none; box-shadow: none } .btn-link, .btn-link:active, .btn-link:focus, .btn-link:hover { border-color: transparent } .btn-link:focus, .btn-link:hover { color: #23527c; text-decoration: underline; background-color: transparent } .btn-link[disabled]:focus, .btn-link[disabled]:hover, fieldset[disabled] .btn-link:focus, fieldset[disabled] .btn-link:hover { color: #777; text-decoration: none } .btn-group-lg > .btn, .btn-lg { padding: 10px 16px; font-size: 18px; line-height: 1.3333333; border-radius: 6px } .btn-group-sm > .btn, .btn-sm { padding: 5px 10px; font-size: 12px; line-height: 1.5; border-radius: 3px } .btn-group-xs > .btn, .btn-xs { padding: 1px 5px; font-size: 12px; line-height: 1.5; border-radius: 3px } .btn-block { display: block; width: 100% } .btn-block + .btn-block { margin-top: 5px } input[type=button].btn-block, input[type=reset].btn-block, input[type=submit].btn-block { width: 100% } .fade { opacity: 0; -webkit-transition: opacity .15s linear; -o-transition: opacity .15s linear; transition: opacity .15s linear } .fade.in { opacity: 1 } .collapse { display: none } .collapse.in { display: block } tr.collapse.in { display: table-row } tbody.collapse.in { display: table-row-group } .collapsing { position: relative; height: 0; overflow: hidden; -webkit-transition-property: height,visibility; -o-transition-property: height,visibility; transition-property: height,visibility; -webkit-transition-duration: .35s; -o-transition-duration: .35s; transition-duration: .35s; -webkit-transition-timing-function: ease; -o-transition-timing-function: ease; transition-timing-function: ease } .caret { display: inline-block; width: 0; height: 0; margin-left: 2px; vertical-align: middle; border-top: 4px dashed; border-right: 4px solid transparent; border-left: 4px solid transparent } .dropdown, .dropup { position: relative } .dropdown-toggle:focus { outline: 0 } .dropdown-menu { position: absolute; top: 100%; left: 0; z-index: 1000; display: none; float: left; min-width: 160px; padding: 5px 0; margin: 2px 0 0; font-size: 14px; text-align: left; list-style: none; background-color: #fff; background-clip: padding-box; border: 1px solid rgba(0,0,0,.15); border-radius: 4px; -webkit-box-shadow: 0 6px 12px rgba(0,0,0,.175); box-shadow: 0 6px 12px rgba(0,0,0,.175) } .dropdown-menu.pull-right { right: 0; left: auto } .dropdown-menu .divider { height: 1px; margin: 9px 0; overflow: hidden; background-color: #e5e5e5 } .dropdown-menu > li > a { display: block; padding: 3px 20px; clear: both; font-weight: 400; line-height: 1.42857143; color: #333; white-space: nowrap } .dropdown-menu > li > a:focus, .dropdown-menu > li > a:hover { color: #262626; text-decoration: none; background-color: #f5f5f5 } .dropdown-menu > .active > a, .dropdown-menu > .active > a:focus, .dropdown-menu > .active > a:hover { color: #fff; text-decoration: none; background-color: #337ab7; outline: 0 } .dropdown-menu > .disabled > a, .dropdown-menu > .disabled > a:focus, .dropdown-menu > .disabled > a:hover { color: #777 } .dropdown-menu > .disabled > a:focus, .dropdown-menu > .disabled > a:hover { text-decoration: none; cursor: not-allowed; background-color: transparent; background-image: none } .open > .dropdown-menu { display: block } .open > a { outline: 0 } .dropdown-menu-right { right: 0; left: auto } .dropdown-menu-left { right: auto; left: 0 } .dropdown-header { display: block; padding: 3px 20px; font-size: 12px; line-height: 1.42857143; color: #777; white-space: nowrap } .dropdown-backdrop { position: fixed; top: 0; right: 0; bottom: 0; left: 0; z-index: 990 } .pull-right > .dropdown-menu { right: 0; left: auto } .dropup .caret, .navbar-fixed-bottom .dropdown .caret { content: ""; border-top: 0; border-bottom: 4px dashed } .dropup .dropdown-menu, .navbar-fixed-bottom .dropdown .dropdown-menu { top: auto; bottom: 100%; margin-bottom: 2px } .btn-group, .btn-group-vertical { position: relative; display: inline-block; vertical-align: middle } .btn-group-vertical > .btn, .btn-group > .btn { position: relative; float: left } .btn-group-vertical > .btn.active, .btn-group-vertical > .btn:active, .btn-group-vertical > .btn:focus, .btn-group-vertical > .btn:hover, .btn-group > .btn.active, .btn-group > .btn:active, .btn-group > .btn:focus, .btn-group > .btn:hover { z-index: 2 } .btn-group .btn + .btn, .btn-group .btn + .btn-group, .btn-group .btn-group + .btn, .btn-group .btn-group + .btn-group { margin-left: -1px } .btn-toolbar { margin-left: -5px } .btn-toolbar .btn, .btn-toolbar .btn-group, .btn-toolbar .input-group { float: left } .btn-toolbar > .btn, .btn-toolbar > .btn-group, .btn-toolbar > .input-group { margin-left: 5px } .btn-group > .btn:not(:first-child):not(:last-child):not(.dropdown-toggle) { border-radius: 0 } .btn-group > .btn:first-child { margin-left: 0 } .btn-group > .btn:first-child:not(:last-child):not(.dropdown-toggle) { border-top-right-radius: 0; border-bottom-right-radius: 0 } .btn-group > .btn:last-child:not(:first-child), .btn-group > .dropdown-toggle:not(:first-child) { border-top-left-radius: 0; border-bottom-left-radius: 0 } .btn-group > .btn-group { float: left } .btn-group > .btn-group:not(:first-child):not(:last-child) > .btn { border-radius: 0 } .btn-group > .btn-group:first-child:not(:last-child) > .btn:last-child, .btn-group > .btn-group:first-child:not(:last-child) > .dropdown-toggle { border-top-right-radius: 0; border-bottom-right-radius: 0 } .btn-group > .btn-group:last-child:not(:first-child) > .btn:first-child { border-top-left-radius: 0; border-bottom-left-radius: 0 } .btn-group .dropdown-toggle:active, .btn-group.open .dropdown-toggle { outline: 0 } .btn-group > .btn + .dropdown-toggle { padding-right: 8px; padding-left: 8px } .btn-group > .btn-lg + .dropdown-toggle { padding-right: 12px; padding-left: 12px } .btn-group.open .dropdown-toggle { -webkit-box-shadow: inset 0 3px 5px rgba(0,0,0,.125); box-shadow: inset 0 3px 5px rgba(0,0,0,.125) } .btn-group.open .dropdown-toggle.btn-link { -webkit-box-shadow: none; box-shadow: none } .btn .caret { margin-left: 0 } .btn-lg .caret { border-width: 5px 5px 0 } .dropup .btn-lg .caret { border-width: 0 5px 5px } .btn-group-vertical > .btn, .btn-group-vertical > .btn-group, .btn-group-vertical > .btn-group > .btn { display: block; float: none; width: 100%; max-width: 100% } .btn-group-vertical > .btn-group > .btn { float: none } .btn-group-vertical > .btn + .btn, .btn-group-vertical > .btn + .btn-group, .btn-group-vertical > .btn-group + .btn, .btn-group-vertical > .btn-group + .btn-group { margin-top: -1px; margin-left: 0 } .btn-group-vertical > .btn:not(:first-child):not(:last-child) { border-radius: 0 } .btn-group-vertical > .btn:first-child:not(:last-child) { border-radius: 4px 4px 0 0 } .btn-group-vertical > .btn:last-child:not(:first-child) { border-radius: 0 0 4px 4px } .btn-group-vertical > .btn-group:not(:first-child):not(:last-child) > .btn { border-radius: 0 } .btn-group-vertical > .btn-group:first-child:not(:last-child) > .btn:last-child, .btn-group-vertical > .btn-group:first-child:not(:last-child) > .dropdown-toggle { border-bottom-right-radius: 0; border-bottom-left-radius: 0 } .btn-group-vertical > .btn-group:last-child:not(:first-child) > .btn:first-child { border-top-left-radius: 0; border-top-right-radius: 0 } .btn-group-justified { display: table; width: 100%; table-layout: fixed; border-collapse: separate } .btn-group-justified > .btn, .btn-group-justified > .btn-group { display: table-cell; float: none; width: 1% } .btn-group-justified > .btn-group .btn { width: 100% } .btn-group-justified > .btn-group .dropdown-menu { left: auto } [data-toggle=buttons] > .btn input[type=checkbox], [data-toggle=buttons] > .btn input[type=radio], [data-toggle=buttons] > .btn-group > .btn input[type=checkbox], [data-toggle=buttons] > .btn-group > .btn input[type=radio] { position: absolute; clip: rect(0,0,0,0); pointer-events: none } .input-group { position: relative; display: table; border-collapse: separate } .input-group[class*=col-] { float: none; padding-right: 0; padding-left: 0 } .input-group .form-control { position: relative; z-index: 2; float: left; width: 100%; margin-bottom: 0 } .input-group .form-control:focus { z-index: 3 } .input-group-lg > .form-control, .input-group-lg > .input-group-addon, .input-group-lg > .input-group-btn > .btn { height: 46px; padding: 10px 16px; font-size: 18px; line-height: 1.3333333; border-radius: 6px } select.input-group-lg > .form-control, select.input-group-lg > .input-group-addon, select.input-group-lg > .input-group-btn > .btn { height: 46px; line-height: 46px } select[multiple].input-group-lg > .form-control, select[multiple].input-group-lg > .input-group-addon, select[multiple].input-group-lg > .input-group-btn > .btn, textarea.input-group-lg > .form-control, textarea.input-group-lg > .input-group-addon, textarea.input-group-lg > .input-group-btn > .btn { height: auto } .input-group-sm > .form-control, .input-group-sm > .input-group-addon, .input-group-sm > .input-group-btn > .btn { height: 30px; padding: 5px 10px; font-size: 12px; line-height: 1.5; border-radius: 3px } select.input-group-sm > .form-control, select.input-group-sm > .input-group-addon, select.input-group-sm > .input-group-btn > .btn { height: 30px; line-height: 30px } select[multiple].input-group-sm > .form-control, select[multiple].input-group-sm > .input-group-addon, select[multiple].input-group-sm > .input-group-btn > .btn, textarea.input-group-sm > .form-control, textarea.input-group-sm > .input-group-addon, textarea.input-group-sm > .input-group-btn > .btn { height: auto } .input-group .form-control, .input-group-addon, .input-group-btn { display: table-cell } .input-group .form-control:not(:first-child):not(:last-child), .input-group-addon:not(:first-child):not(:last-child), .input-group-btn:not(:first-child):not(:last-child) { border-radius: 0 } .input-group-addon, .input-group-btn { width: 1%; white-space: nowrap; vertical-align: middle } .input-group-addon { padding: 6px 12px; font-size: 14px; font-weight: 400; line-height: 1; color: #555; text-align: center; background-color: #eee; border: 1px solid #ccc; border-radius: 4px } .input-group-addon.input-sm { padding: 5px 10px; font-size: 12px; border-radius: 3px } .input-group-addon.input-lg { padding: 10px 16px; font-size: 18px; border-radius: 6px } .input-group-addon input[type=checkbox], .input-group-addon input[type=radio] { margin-top: 0 } .input-group .form-control:first-child, .input-group-addon:first-child, .input-group-btn:first-child > .btn, .input-group-btn:first-child > .btn-group > .btn, .input-group-btn:first-child > .dropdown-toggle, .input-group-btn:last-child > .btn-group:not(:last-child) > .btn, .input-group-btn:last-child > .btn:not(:last-child):not(.dropdown-toggle) { border-top-right-radius: 0; border-bottom-right-radius: 0 } .input-group-addon:first-child { border-right: 0 } .input-group .form-control:last-child, .input-group-addon:last-child, .input-group-btn:first-child > .btn-group:not(:first-child) > .btn, .input-group-btn:first-child > .btn:not(:first-child), .input-group-btn:last-child > .btn, .input-group-btn:last-child > .btn-group > .btn, .input-group-btn:last-child > .dropdown-toggle { border-top-left-radius: 0; border-bottom-left-radius: 0 } .input-group-addon:last-child { border-left: 0 } .input-group-btn { position: relative; font-size: 0; white-space: nowrap } .input-group-btn > .btn { position: relative } .input-group-btn > .btn + .btn { margin-left: -1px } .input-group-btn > .btn:active, .input-group-btn > .btn:focus, .input-group-btn > .btn:hover { z-index: 2 } .input-group-btn:first-child > .btn, .input-group-btn:first-child > .btn-group { margin-right: -1px } .input-group-btn:last-child > .btn, .input-group-btn:last-child > .btn-group { z-index: 2; margin-left: -1px } .nav { padding-left: 0; margin-bottom: 0; list-style: none } .nav > li { position: relative; display: block } .nav > li > a { position: relative; display: block; padding: 10px 15px } .nav > li > a:focus, .nav > li > a:hover { text-decoration: none; background-color: #eee } .nav > li.disabled > a { color: #777 } .nav > li.disabled > a:focus, .nav > li.disabled > a:hover { color: #777; text-decoration: none; cursor: not-allowed; background-color: transparent } .nav .open > a, .nav .open > a:focus, .nav .open > a:hover { background-color: #eee; border-color: #337ab7 } .nav .nav-divider { height: 1px; margin: 9px 0; overflow: hidden; background-color: #e5e5e5 } .nav > li > a > img { max-width: none } .nav-tabs { border-bottom: 1px solid #ddd } .nav-tabs > li { float: left; margin-bottom: -1px } .nav-tabs > li > a { margin-right: 2px; line-height: 1.42857143; border: 1px solid transparent; border-radius: 4px 4px 0 0 } .nav-tabs > li > a:hover { border-color: #eee #eee #ddd } .nav-tabs > li.active > a, .nav-tabs > li.active > a:focus, .nav-tabs > li.active > a:hover { color: #555; cursor: default; background-color: #fff; border: 1px solid #ddd; border-bottom-color: transparent } .nav-tabs.nav-justified { width: 100%; border-bottom: 0 } .nav-tabs.nav-justified > li { float: none } .nav-tabs.nav-justified > li > a { margin-bottom: 5px; text-align: center; margin-right: 0; border-radius: 4px } .nav-tabs.nav-justified > .dropdown .dropdown-menu { top: auto; left: auto } .nav-tabs.nav-justified > .active > a, .nav-tabs.nav-justified > .active > a:focus, .nav-tabs.nav-justified > .active > a:hover { border: 1px solid #ddd } .nav-pills > li { float: left } .nav-pills > li > a { border-radius: 4px } .nav-pills > li + li { margin-left: 2px } .nav-pills > li.active > a, .nav-pills > li.active > a:focus, .nav-pills > li.active > a:hover { color: #fff; background-color: #337ab7 } .nav-stacked > li { float: none } .nav-stacked > li + li { margin-top: 2px; margin-left: 0 } .nav-justified { width: 100% } .nav-justified > li { float: none } .nav-justified > li > a { margin-bottom: 5px; text-align: center } .nav-justified > .dropdown .dropdown-menu { top: auto; left: auto } @media (min-width:768px) { .navbar-right .dropdown-menu { right: 0; left: auto } .navbar-right .dropdown-menu-left { right: auto; left: 0 } .nav-tabs.nav-justified > li { display: table-cell; width: 1% } .nav-tabs.nav-justified > li > a { margin-bottom: 0; border-bottom: 1px solid #ddd; border-radius: 4px 4px 0 0 } .nav-tabs.nav-justified > .active > a, .nav-tabs.nav-justified > .active > a:focus, .nav-tabs.nav-justified > .active > a:hover { border-bottom-color: #fff } .nav-justified > li { display: table-cell; width: 1% } .nav-justified > li > a { margin-bottom: 0 } } .nav-tabs-justified { border-bottom: 0 } .nav-tabs-justified > li > a { margin-right: 0; border-radius: 4px } .nav-tabs-justified > .active > a, .nav-tabs-justified > .active > a:focus, .nav-tabs-justified > .active > a:hover { border: 1px solid #ddd } @media (min-width:768px) { .nav-tabs-justified > li > a { border-bottom: 1px solid #ddd; border-radius: 4px 4px 0 0 } .nav-tabs-justified > .active > a, .nav-tabs-justified > .active > a:focus, .nav-tabs-justified > .active > a:hover { border-bottom-color: #fff } } .tab-content > .tab-pane { display: none } .tab-content > .active { display: block } .nav-tabs .dropdown-menu { margin-top: -1px; border-top-left-radius: 0; border-top-right-radius: 0 } .navbar { position: relative; min-height: 50px; margin-bottom: 20px; border: 1px solid transparent } .navbar-collapse { padding-right: 15px; padding-left: 15px; overflow-x: visible; border-top: 1px solid transparent; -webkit-box-shadow: inset 0 1px 0 rgba(255,255,255,.1); box-shadow: inset 0 1px 0 rgba(255,255,255,.1); -webkit-overflow-scrolling: touch } .navbar-collapse.in { overflow-y: auto } .navbar-fixed-bottom, .navbar-fixed-top { position: fixed; right: 0; left: 0; z-index: 1030 } .navbar-fixed-bottom .navbar-collapse, .navbar-fixed-top .navbar-collapse { max-height: 340px } @media (max-device-width:480px) and (orientation:landscape) { .navbar-fixed-bottom .navbar-collapse, .navbar-fixed-top .navbar-collapse { max-height: 200px } } @media (min-width:768px) { .navbar { border-radius: 4px } .navbar-header { float: left } .navbar-collapse { width: auto; border-top: 0; -webkit-box-shadow: none; box-shadow: none } .navbar-collapse.collapse { display: block !important; height: auto !important; padding-bottom: 0; overflow: visible !important } .navbar-collapse.in { overflow-y: visible } .navbar-fixed-bottom .navbar-collapse, .navbar-fixed-top .navbar-collapse, .navbar-static-top .navbar-collapse { padding-right: 0; padding-left: 0 } .navbar-fixed-bottom, .navbar-fixed-top { border-radius: 0 } } .navbar-fixed-top { top: 0; border-width: 0 0 1px } .navbar-fixed-bottom { bottom: 0; margin-bottom: 0; border-width: 1px 0 0 } .container-fluid > .navbar-collapse, .container-fluid > .navbar-header, .container > .navbar-collapse, .container > .navbar-header { margin-right: -15px; margin-left: -15px } .navbar-static-top { z-index: 1000; border-width: 0 0 1px } .navbar-brand { float: left; height: 50px; padding: 15px; font-size: 18px; line-height: 20px } .navbar-brand:focus, .navbar-brand:hover { text-decoration: none } .navbar-brand > img { display: block } @media (min-width:768px) { .container-fluid > .navbar-collapse, .container-fluid > .navbar-header, .container > .navbar-collapse, .container > .navbar-header { margin-right: 0; margin-left: 0 } .navbar-static-top { border-radius: 0 } .navbar > .container .navbar-brand, .navbar > .container-fluid .navbar-brand { margin-left: -15px } .navbar-toggle { display: none } } .navbar-toggle { position: relative; float: right; padding: 9px 10px; margin-right: 15px; margin-top: 8px; margin-bottom: 8px; background-color: transparent; background-image: none; border: 1px solid transparent; border-radius: 4px } .navbar-toggle:focus { outline: 0 } .navbar-toggle .icon-bar { display: block; width: 22px; height: 2px; border-radius: 1px } .navbar-toggle .icon-bar + .icon-bar { margin-top: 4px } .navbar-nav { margin: 7.5px -15px } .navbar-nav > li > a { padding-top: 10px; padding-bottom: 10px; line-height: 20px } @media (max-width:767px) { .navbar-nav .open .dropdown-menu { position: static; float: none; width: auto; margin-top: 0; background-color: transparent; border: 0; -webkit-box-shadow: none; box-shadow: none } .navbar-nav .open .dropdown-menu .dropdown-header, .navbar-nav .open .dropdown-menu > li > a { padding: 5px 15px 5px 25px } .navbar-nav .open .dropdown-menu > li > a { line-height: 20px } .navbar-nav .open .dropdown-menu > li > a:focus, .navbar-nav .open .dropdown-menu > li > a:hover { background-image: none } } @media (min-width:768px) { .navbar-nav { float: left; margin: 0 } .navbar-nav > li { float: left } .navbar-nav > li > a { padding-top: 15px; padding-bottom: 15px } .navbar-form .form-group { display: inline-block; margin-bottom: 0; vertical-align: middle } .navbar-form .form-control { display: inline-block; width: auto; vertical-align: middle } .navbar-form .form-control-static { display: inline-block } .navbar-form .input-group { display: inline-table; vertical-align: middle } .navbar-form .input-group .form-control, .navbar-form .input-group .input-group-addon, .navbar-form .input-group .input-group-btn { width: auto } .navbar-form .input-group > .form-control { width: 100% } .navbar-form .control-label { margin-bottom: 0; vertical-align: middle } .navbar-form .checkbox, .navbar-form .radio { display: inline-block; margin-top: 0; margin-bottom: 0; vertical-align: middle } .navbar-form .checkbox label, .navbar-form .radio label { padding-left: 0 } .navbar-form .checkbox input[type=checkbox], .navbar-form .radio input[type=radio] { position: relative; margin-left: 0 } .navbar-form .has-feedback .form-control-feedback { top: 0 } } .navbar-form { padding: 10px 15px; border-top: 1px solid transparent; border-bottom: 1px solid transparent; -webkit-box-shadow: inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1); box-shadow: inset 0 1px 0 rgba(255,255,255,.1),0 1px 0 rgba(255,255,255,.1); margin: 8px -15px } @media (max-width:767px) { .navbar-form .form-group { margin-bottom: 5px } .navbar-form .form-group:last-child { margin-bottom: 0 } .navbar-default .navbar-nav .open .dropdown-menu > li > a { color: #777 } .navbar-default .navbar-nav .open .dropdown-menu > li > a:focus, .navbar-default .navbar-nav .open .dropdown-menu > li > a:hover { color: #333; background-color: transparent } .navbar-default .navbar-nav .open .dropdown-menu > .active > a, .navbar-default .navbar-nav .open .dropdown-menu > .active > a:focus, .navbar-default .navbar-nav .open .dropdown-menu > .active > a:hover { color: #555; background-color: #e7e7e7 } .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a, .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:focus, .navbar-default .navbar-nav .open .dropdown-menu > .disabled > a:hover { color: #ccc; background-color: transparent } } @media (min-width:768px) { .navbar-form { width: auto; padding-top: 0; padding-bottom: 0; margin-right: 0; margin-left: 0; border: 0; -webkit-box-shadow: none; box-shadow: none } .navbar-text { float: left; margin-right: 15px; margin-left: 15px } } .navbar-nav > li > .dropdown-menu { margin-top: 0; border-top-left-radius: 0; border-top-right-radius: 0 } .navbar-fixed-bottom .navbar-nav > li > .dropdown-menu { margin-bottom: 0; border-radius: 4px 4px 0 0 } .navbar-btn { margin-top: 8px; margin-bottom: 8px } .navbar-btn.btn-sm { margin-top: 10px; margin-bottom: 10px } .navbar-btn.btn-xs { margin-top: 14px; margin-bottom: 14px } .navbar-text { margin-top: 15px; margin-bottom: 15px } @media (min-width:768px) { .navbar-left { float: left !important } .navbar-right { float: right !important; margin-right: -15px } .navbar-right ~ .navbar-right { margin-right: 0 } } .navbar-default { background-color: #f8f8f8; border-color: #e7e7e7 } .navbar-default .navbar-brand { color: #777 } .navbar-default .navbar-brand:focus, .navbar-default .navbar-brand:hover { color: #5e5e5e; background-color: transparent } .navbar-default .navbar-nav > li > a, .navbar-default .navbar-text { color: #777 } .navbar-default .navbar-nav > li > a:focus, .navbar-default .navbar-nav > li > a:hover { color: #333; background-color: transparent } .navbar-default .navbar-nav > .active > a, .navbar-default .navbar-nav > .active > a:focus, .navbar-default .navbar-nav > .active > a:hover { color: #555; background-color: #e7e7e7 } .navbar-default .navbar-nav > .disabled > a, .navbar-default .navbar-nav > .disabled > a:focus, .navbar-default .navbar-nav > .disabled > a:hover { color: #ccc; background-color: transparent } .navbar-default .navbar-nav > .open > a, .navbar-default .navbar-nav > .open > a:focus, .navbar-default .navbar-nav > .open > a:hover { color: #555; background-color: #e7e7e7 } .navbar-default .navbar-toggle { border-color: #ddd } .navbar-default .navbar-toggle:focus, .navbar-default .navbar-toggle:hover { background-color: #ddd } .navbar-default .navbar-toggle .icon-bar { background-color: #888 } .navbar-default .navbar-collapse, .navbar-default .navbar-form { border-color: #e7e7e7 } .navbar-default .navbar-link { color: #777 } .navbar-default .navbar-link:hover { color: #333 } .navbar-default .btn-link { color: #777 } .navbar-default .btn-link:focus, .navbar-default .btn-link:hover { color: #333 } .navbar-default .btn-link[disabled]:focus, .navbar-default .btn-link[disabled]:hover, fieldset[disabled] .navbar-default .btn-link:focus, fieldset[disabled] .navbar-default .btn-link:hover { color: #ccc } .navbar-inverse { background-color: #222; border-color: #080808 } .navbar-inverse .navbar-brand { color: #9d9d9d } .navbar-inverse .navbar-brand:focus, .navbar-inverse .navbar-brand:hover { color: #fff; background-color: transparent } .navbar-inverse .navbar-nav > li > a, .navbar-inverse .navbar-text { color: #9d9d9d } .navbar-inverse .navbar-nav > li > a:focus, .navbar-inverse .navbar-nav > li > a:hover { color: #fff; background-color: transparent } .navbar-inverse .navbar-nav > .active > a, .navbar-inverse .navbar-nav > .active > a:focus, .navbar-inverse .navbar-nav > .active > a:hover { color: #fff; background-color: #080808 } .navbar-inverse .navbar-nav > .disabled > a, .navbar-inverse .navbar-nav > .disabled > a:focus, .navbar-inverse .navbar-nav > .disabled > a:hover { color: #444; background-color: transparent } .navbar-inverse .navbar-nav > .open > a, .navbar-inverse .navbar-nav > .open > a:focus, .navbar-inverse .navbar-nav > .open > a:hover { color: #fff; background-color: #080808 } @media (max-width:767px) { .navbar-inverse .navbar-nav .open .dropdown-menu > .dropdown-header { border-color: #080808 } .navbar-inverse .navbar-nav .open .dropdown-menu .divider { background-color: #080808 } .navbar-inverse .navbar-nav .open .dropdown-menu > li > a { color: #9d9d9d } .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:focus, .navbar-inverse .navbar-nav .open .dropdown-menu > li > a:hover { color: #fff; background-color: transparent } .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a, .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:focus, .navbar-inverse .navbar-nav .open .dropdown-menu > .active > a:hover { color: #fff; background-color: #080808 } .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a, .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:focus, .navbar-inverse .navbar-nav .open .dropdown-menu > .disabled > a:hover { color: #444; background-color: transparent } } .navbar-inverse .navbar-toggle { border-color: #333 } .navbar-inverse .navbar-toggle:focus, .navbar-inverse .navbar-toggle:hover { background-color: #333 } .navbar-inverse .navbar-toggle .icon-bar { background-color: #fff } .navbar-inverse .navbar-collapse, .navbar-inverse .navbar-form { border-color: #101010 } .navbar-inverse .navbar-link { color: #9d9d9d } .navbar-inverse .navbar-link:hover { color: #fff } .navbar-inverse .btn-link { color: #9d9d9d } .navbar-inverse .btn-link:focus, .navbar-inverse .btn-link:hover { color: #fff } .navbar-inverse .btn-link[disabled]:focus, .navbar-inverse .btn-link[disabled]:hover, fieldset[disabled] .navbar-inverse .btn-link:focus, fieldset[disabled] .navbar-inverse .btn-link:hover { color: #444 } .breadcrumb { padding: 8px 15px; margin-bottom: 20px; list-style: none; background-color: #f5f5f5; border-radius: 4px } .breadcrumb > li { display: inline-block } .breadcrumb > li + li:before { padding: 0 5px; color: #ccc; content: "/\00a0" } .breadcrumb > .active { color: #777 } .pagination { display: inline-block; padding-left: 0; margin: 20px 0; border-radius: 4px } .pagination > li { display: inline } .pagination > li > a, .pagination > li > span { position: relative; float: left; padding: 6px 12px; margin-left: -1px; line-height: 1.42857143; color: #337ab7; text-decoration: none; background-color: #fff; border: 1px solid #ddd } .pagination > li > a:focus, .pagination > li > a:hover, .pagination > li > span:focus, .pagination > li > span:hover { z-index: 2; color: #23527c; background-color: #eee; border-color: #ddd } .pagination > li:first-child > a, .pagination > li:first-child > span { margin-left: 0; border-top-left-radius: 4px; border-bottom-left-radius: 4px } .pagination > li:last-child > a, .pagination > li:last-child > span { border-top-right-radius: 4px; border-bottom-right-radius: 4px } .pagination > .active > a, .pagination > .active > a:focus, .pagination > .active > a:hover, .pagination > .active > span, .pagination > .active > span:focus, .pagination > .active > span:hover { z-index: 3; color: #fff; cursor: default; background-color: #337ab7; border-color: #337ab7 } .pagination > .disabled > a, .pagination > .disabled > a:focus, .pagination > .disabled > a:hover, .pagination > .disabled > span, .pagination > .disabled > span:focus, .pagination > .disabled > span:hover { color: #777; cursor: not-allowed; background-color: #fff; border-color: #ddd } .pagination-lg > li > a, .pagination-lg > li > span { padding: 10px 16px; font-size: 18px; line-height: 1.3333333 } .pagination-lg > li:first-child > a, .pagination-lg > li:first-child > span { border-top-left-radius: 6px; border-bottom-left-radius: 6px } .pagination-lg > li:last-child > a, .pagination-lg > li:last-child > span { border-top-right-radius: 6px; border-bottom-right-radius: 6px } .pagination-sm > li > a, .pagination-sm > li > span { padding: 5px 10px; font-size: 12px; line-height: 1.5 } .pagination-sm > li:first-child > a, .pagination-sm > li:first-child > span { border-top-left-radius: 3px; border-bottom-left-radius: 3px } .pagination-sm > li:last-child > a, .pagination-sm > li:last-child > span { border-top-right-radius: 3px; border-bottom-right-radius: 3px } .pager { padding-left: 0; margin: 20px 0; text-align: center; list-style: none } .pager li { display: inline } .pager li > a, .pager li > span { display: inline-block; padding: 5px 14px; background-color: #fff; border: 1px solid #ddd; border-radius: 15px } .pager li > a:focus, .pager li > a:hover { text-decoration: none; background-color: #eee } .pager .next > a, .pager .next > span { float: right } .pager .previous > a, .pager .previous > span { float: left } .pager .disabled > a, .pager .disabled > a:focus, .pager .disabled > a:hover, .pager .disabled > span { color: #777; cursor: not-allowed; background-color: #fff } .label { display: inline; padding: .2em .6em .3em; font-size: 75%; font-weight: 700; line-height: 1; color: #fff; text-align: center; white-space: nowrap; vertical-align: baseline; border-radius: .25em } a.label:focus, a.label:hover { color: #fff; text-decoration: none; cursor: pointer } .label:empty { display: none } .btn .label { position: relative; top: -1px } .label-default { background-color: #777 } .label-default[href]:focus, .label-default[href]:hover { background-color: #5e5e5e } .label-primary { background-color: #337ab7 } .label-primary[href]:focus, .label-primary[href]:hover { background-color: #286090 } .label-success { background-color: #5cb85c } .label-success[href]:focus, .label-success[href]:hover { background-color: #449d44 } .label-info { background-color: #5bc0de } .label-info[href]:focus, .label-info[href]:hover { background-color: #31b0d5 } .label-warning { background-color: #f0ad4e } .label-warning[href]:focus, .label-warning[href]:hover { background-color: #ec971f } .label-danger { background-color: #d9534f } .label-danger[href]:focus, .label-danger[href]:hover { background-color: #c9302c } .badge { display: inline-block; min-width: 10px; padding: 3px 7px; font-size: 12px; font-weight: 700; line-height: 1; color: #fff; text-align: center; white-space: nowrap; vertical-align: middle; background-color: #777; border-radius: 10px } .badge:empty { display: none } .btn .badge { position: relative; top: -1px } .btn-group-xs > .btn .badge, .btn-xs .badge { top: 0; padding: 1px 5px } a.badge:focus, a.badge:hover { color: #fff; text-decoration: none; cursor: pointer } .list-group-item.active > .badge, .nav-pills > .active > a > .badge { color: #337ab7; background-color: #fff } .list-group-item > .badge { float: right } .list-group-item > .badge + .badge { margin-right: 5px } .nav-pills > li > a > .badge { margin-left: 3px } .jumbotron { padding-top: 30px; padding-bottom: 30px; margin-bottom: 30px; color: inherit; background-color: #eee } .jumbotron .h1, .jumbotron h1 { color: inherit } .jumbotron p { margin-bottom: 15px; font-size: 21px; font-weight: 200 } .jumbotron > hr { border-top-color: #d5d5d5 } .container .jumbotron, .container-fluid .jumbotron { padding-right: 15px; padding-left: 15px; border-radius: 6px } .jumbotron .container { max-width: 100% } @media screen and (min-width:768px) { .jumbotron { padding-top: 48px; padding-bottom: 48px } .container .jumbotron, .container-fluid .jumbotron { padding-right: 60px; padding-left: 60px } .jumbotron .h1, .jumbotron h1 { font-size: 63px } } .thumbnail { display: block; padding: 4px; margin-bottom: 20px; line-height: 1.42857143; background-color: #fff; border: 1px solid #ddd; border-radius: 4px; -webkit-transition: border .2s ease-in-out; -o-transition: border .2s ease-in-out; transition: border .2s ease-in-out } .thumbnail a > img, .thumbnail > img { margin-right: auto; margin-left: auto } a.thumbnail.active, a.thumbnail:focus, a.thumbnail:hover { border-color: #337ab7 } .thumbnail .caption { padding: 9px; color: #333 } .alert { padding: 15px; margin-bottom: 20px; border: 1px solid transparent; border-radius: 4px } .alert h4 { margin-top: 0; color: inherit } .alert .alert-link { font-weight: 700 } .alert > p, .alert > ul { margin-bottom: 0 } .alert > p + p { margin-top: 5px } .alert-dismissable, .alert-dismissible { padding-right: 35px } .alert-dismissable .close, .alert-dismissible .close { position: relative; top: -2px; right: -21px; color: inherit } .alert-success { color: #3c763d; background-color: #dff0d8; border-color: #d6e9c6 } .alert-success hr { border-top-color: #c9e2b3 } .alert-success .alert-link { color: #2b542c } .alert-info { color: #31708f; background-color: #d9edf7; border-color: #bce8f1 } .alert-info hr { border-top-color: #a6e1ec } .alert-info .alert-link { color: #245269 } .alert-warning { color: #8a6d3b; background-color: #fcf8e3; border-color: #faebcc } .alert-warning hr { border-top-color: #f7e1b5 } .alert-warning .alert-link { color: #66512c } .alert-danger { color: #a94442; background-color: #f2dede; border-color: #ebccd1 } .alert-danger hr { border-top-color: #e4b9c0 } .alert-danger .alert-link { color: #843534 } @-webkit-keyframes progress-bar-stripes { from { background-position: 40px 0 } to { background-position: 0 0 } } @-o-keyframes progress-bar-stripes { from { background-position: 40px 0 } to { background-position: 0 0 } } @keyframes progress-bar-stripes { from { background-position: 40px 0 } to { background-position: 0 0 } } .progress { height: 20px; margin-bottom: 20px; overflow: hidden; background-color: #f5f5f5; border-radius: 4px; -webkit-box-shadow: inset 0 1px 2px rgba(0,0,0,.1); box-shadow: inset 0 1px 2px rgba(0,0,0,.1) } .progress-bar { float: left; width: 0%; height: 100%; font-size: 12px; line-height: 20px; color: #fff; text-align: center; background-color: #337ab7; -webkit-box-shadow: inset 0 -1px 0 rgba(0,0,0,.15); box-shadow: inset 0 -1px 0 rgba(0,0,0,.15); -webkit-transition: width .6s; -o-transition: width .6s; transition: width .6s } .progress-bar-striped, .progress-striped .progress-bar { background-image: -webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: -o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); -webkit-background-size: 40px 40px; background-size: 40px 40px } .progress-bar.active, .progress.active .progress-bar { -webkit-animation: 2s linear infinite progress-bar-stripes; -o-animation: 2s linear infinite progress-bar-stripes; animation: 2s linear infinite progress-bar-stripes } .progress-bar-success { background-color: #5cb85c } .progress-striped .progress-bar-success { background-image: -webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: -o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent) } .progress-bar-info { background-color: #5bc0de } .progress-striped .progress-bar-info { background-image: -webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: -o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent) } .progress-bar-warning { background-color: #f0ad4e } .progress-striped .progress-bar-warning { background-image: -webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: -o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent) } .progress-bar-danger { background-color: #d9534f } .progress-striped .progress-bar-danger { background-image: -webkit-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: -o-linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent); background-image: linear-gradient(45deg,rgba(255,255,255,.15) 25%,transparent 25%,transparent 50%,rgba(255,255,255,.15) 50%,rgba(255,255,255,.15) 75%,transparent 75%,transparent) } .media { margin-top: 15px } .media:first-child { margin-top: 0 } .media, .media-body { overflow: hidden; zoom: 1 } .media-body { width: 10000px } .media-object { display: block } .media-object.img-thumbnail { max-width: none } .media-right, .media > .pull-right { padding-left: 10px } .media-left, .media > .pull-left { padding-right: 10px } .media-body, .media-left, .media-right { display: table-cell; vertical-align: top } .media-middle { vertical-align: middle } .media-bottom { vertical-align: bottom } .media-heading { margin-top: 0; margin-bottom: 5px } .media-list { padding-left: 0; list-style: none } .list-group { padding-left: 0; margin-bottom: 20px } .list-group-item { position: relative; display: block; padding: 10px 15px; margin-bottom: -1px; background-color: #fff; border: 1px solid #ddd } .list-group-item:first-child { border-top-left-radius: 4px; border-top-right-radius: 4px } .list-group-item:last-child { margin-bottom: 0; border-bottom-right-radius: 4px; border-bottom-left-radius: 4px } .list-group-item.disabled, .list-group-item.disabled:focus, .list-group-item.disabled:hover { color: #777; cursor: not-allowed; background-color: #eee } .list-group-item.disabled .list-group-item-heading, .list-group-item.disabled:focus .list-group-item-heading, .list-group-item.disabled:hover .list-group-item-heading { color: inherit } .list-group-item.disabled .list-group-item-text, .list-group-item.disabled:focus .list-group-item-text, .list-group-item.disabled:hover .list-group-item-text { color: #777 } .list-group-item.active, .list-group-item.active:focus, .list-group-item.active:hover { z-index: 2; color: #fff; background-color: #337ab7; border-color: #337ab7 } .list-group-item.active .list-group-item-heading, .list-group-item.active .list-group-item-heading > .small, .list-group-item.active .list-group-item-heading > small, .list-group-item.active:focus .list-group-item-heading, .list-group-item.active:focus .list-group-item-heading > .small, .list-group-item.active:focus .list-group-item-heading > small, .list-group-item.active:hover .list-group-item-heading, .list-group-item.active:hover .list-group-item-heading > .small, .list-group-item.active:hover .list-group-item-heading > small { color: inherit } .list-group-item.active .list-group-item-text, .list-group-item.active:focus .list-group-item-text, .list-group-item.active:hover .list-group-item-text { color: #c7ddef } a.list-group-item, button.list-group-item { color: #555 } a.list-group-item .list-group-item-heading, button.list-group-item .list-group-item-heading { color: #333 } a.list-group-item:focus, a.list-group-item:hover, button.list-group-item:focus, button.list-group-item:hover { color: #555; text-decoration: none; background-color: #f5f5f5 } button.list-group-item { width: 100%; text-align: left } .list-group-item-success { color: #3c763d; background-color: #dff0d8 } a.list-group-item-success, button.list-group-item-success { color: #3c763d } a.list-group-item-success .list-group-item-heading, button.list-group-item-success .list-group-item-heading { color: inherit } a.list-group-item-success:focus, a.list-group-item-success:hover, button.list-group-item-success:focus, button.list-group-item-success:hover { color: #3c763d; background-color: #d0e9c6 } a.list-group-item-success.active, a.list-group-item-success.active:focus, a.list-group-item-success.active:hover, button.list-group-item-success.active, button.list-group-item-success.active:focus, button.list-group-item-success.active:hover { color: #fff; background-color: #3c763d; border-color: #3c763d } .list-group-item-info { color: #31708f; background-color: #d9edf7 } a.list-group-item-info, button.list-group-item-info { color: #31708f } a.list-group-item-info .list-group-item-heading, button.list-group-item-info .list-group-item-heading { color: inherit } a.list-group-item-info:focus, a.list-group-item-info:hover, button.list-group-item-info:focus, button.list-group-item-info:hover { color: #31708f; background-color: #c4e3f3 } a.list-group-item-info.active, a.list-group-item-info.active:focus, a.list-group-item-info.active:hover, button.list-group-item-info.active, button.list-group-item-info.active:focus, button.list-group-item-info.active:hover { color: #fff; background-color: #31708f; border-color: #31708f } .list-group-item-warning { color: #8a6d3b; background-color: #fcf8e3 } a.list-group-item-warning, button.list-group-item-warning { color: #8a6d3b } a.list-group-item-warning .list-group-item-heading, button.list-group-item-warning .list-group-item-heading { color: inherit } a.list-group-item-warning:focus, a.list-group-item-warning:hover, button.list-group-item-warning:focus, button.list-group-item-warning:hover { color: #8a6d3b; background-color: #faf2cc } a.list-group-item-warning.active, a.list-group-item-warning.active:focus, a.list-group-item-warning.active:hover, button.list-group-item-warning.active, button.list-group-item-warning.active:focus, button.list-group-item-warning.active:hover { color: #fff; background-color: #8a6d3b; border-color: #8a6d3b } .list-group-item-danger { color: #a94442; background-color: #f2dede } a.list-group-item-danger, button.list-group-item-danger { color: #a94442 } a.list-group-item-danger .list-group-item-heading, button.list-group-item-danger .list-group-item-heading { color: inherit } a.list-group-item-danger:focus, a.list-group-item-danger:hover, button.list-group-item-danger:focus, button.list-group-item-danger:hover { color: #a94442; background-color: #ebcccc } a.list-group-item-danger.active, a.list-group-item-danger.active:focus, a.list-group-item-danger.active:hover, button.list-group-item-danger.active, button.list-group-item-danger.active:focus, button.list-group-item-danger.active:hover { color: #fff; background-color: #a94442; border-color: #a94442 } .list-group-item-heading { margin-top: 0; margin-bottom: 5px } .list-group-item-text { margin-bottom: 0; line-height: 1.3 } .panel { margin-bottom: 20px; background-color: #fff; border: 1px solid transparent; border-radius: 4px; -webkit-box-shadow: 0 1px 1px rgba(0,0,0,.05); box-shadow: 0 1px 1px rgba(0,0,0,.05) } .panel-body { padding: 15px } .panel-heading { padding: 10px 15px; border-bottom: 1px solid transparent; border-top-left-radius: 3px; border-top-right-radius: 3px } .panel-heading > .dropdown .dropdown-toggle { color: inherit } .panel-title { margin-top: 0; margin-bottom: 0; font-size: 16px; color: inherit } .panel-title > .small, .panel-title > .small > a, .panel-title > a, .panel-title > small, .panel-title > small > a { color: inherit } .panel-footer { padding: 10px 15px; background-color: #f5f5f5; border-top: 1px solid #ddd; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px } .panel > .list-group, .panel > .panel-collapse > .list-group { margin-bottom: 0 } .panel > .list-group .list-group-item, .panel > .panel-collapse > .list-group .list-group-item { border-width: 1px 0; border-radius: 0 } .panel > .list-group:first-child .list-group-item:first-child, .panel > .panel-collapse > .list-group:first-child .list-group-item:first-child { border-top: 0; border-top-left-radius: 3px; border-top-right-radius: 3px } .panel > .list-group:last-child .list-group-item:last-child, .panel > .panel-collapse > .list-group:last-child .list-group-item:last-child { border-bottom: 0; border-bottom-right-radius: 3px; border-bottom-left-radius: 3px } .panel > .panel-heading + .panel-collapse > .list-group .list-group-item:first-child { border-top-left-radius: 0; border-top-right-radius: 0 } .list-group + .panel-footer, .panel-heading + .list-group .list-group-item:first-child { border-top-width: 0 } .panel > .panel-collapse > .table, .panel > .table, .panel > .table-responsive > .table { margin-bottom: 0 } .panel > .panel-collapse > .table caption, .panel > .table caption, .panel > .table-responsive > .table caption { padding-right: 15px; padding-left: 15px } .panel > .table-responsive:first-child > .table:first-child, .panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child, .panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child, .panel > .table:first-child, .panel > .table:first-child > tbody:first-child > tr:first-child, .panel > .table:first-child > thead:first-child > tr:first-child { border-top-left-radius: 3px; border-top-right-radius: 3px } .panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child td:first-child, .panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child th:first-child, .panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child td:first-child, .panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child th:first-child, .panel > .table:first-child > tbody:first-child > tr:first-child td:first-child, .panel > .table:first-child > tbody:first-child > tr:first-child th:first-child, .panel > .table:first-child > thead:first-child > tr:first-child td:first-child, .panel > .table:first-child > thead:first-child > tr:first-child th:first-child { border-top-left-radius: 3px } .panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child td:last-child, .panel > .table-responsive:first-child > .table:first-child > tbody:first-child > tr:first-child th:last-child, .panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child td:last-child, .panel > .table-responsive:first-child > .table:first-child > thead:first-child > tr:first-child th:last-child, .panel > .table:first-child > tbody:first-child > tr:first-child td:last-child, .panel > .table:first-child > tbody:first-child > tr:first-child th:last-child, .panel > .table:first-child > thead:first-child > tr:first-child td:last-child, .panel > .table:first-child > thead:first-child > tr:first-child th:last-child { border-top-right-radius: 3px } .panel > .table-responsive:last-child > .table:last-child, .panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child, .panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child, .panel > .table:last-child, .panel > .table:last-child > tbody:last-child > tr:last-child, .panel > .table:last-child > tfoot:last-child > tr:last-child { border-bottom-right-radius: 3px; border-bottom-left-radius: 3px } .panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child td:first-child, .panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child th:first-child, .panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child td:first-child, .panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child th:first-child, .panel > .table:last-child > tbody:last-child > tr:last-child td:first-child, .panel > .table:last-child > tbody:last-child > tr:last-child th:first-child, .panel > .table:last-child > tfoot:last-child > tr:last-child td:first-child, .panel > .table:last-child > tfoot:last-child > tr:last-child th:first-child { border-bottom-left-radius: 3px } .panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child td:last-child, .panel > .table-responsive:last-child > .table:last-child > tbody:last-child > tr:last-child th:last-child, .panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child td:last-child, .panel > .table-responsive:last-child > .table:last-child > tfoot:last-child > tr:last-child th:last-child, .panel > .table:last-child > tbody:last-child > tr:last-child td:last-child, .panel > .table:last-child > tbody:last-child > tr:last-child th:last-child, .panel > .table:last-child > tfoot:last-child > tr:last-child td:last-child, .panel > .table:last-child > tfoot:last-child > tr:last-child th:last-child { border-bottom-right-radius: 3px } .panel > .panel-body + .table, .panel > .panel-body + .table-responsive, .panel > .table + .panel-body, .panel > .table-responsive + .panel-body { border-top: 1px solid #ddd } .panel > .table > tbody:first-child > tr:first-child td, .panel > .table > tbody:first-child > tr:first-child th { border-top: 0 } .panel > .table-bordered, .panel > .table-responsive > .table-bordered { border: 0 } .panel > .table-bordered > tbody > tr > td:first-child, .panel > .table-bordered > tbody > tr > th:first-child, .panel > .table-bordered > tfoot > tr > td:first-child, .panel > .table-bordered > tfoot > tr > th:first-child, .panel > .table-bordered > thead > tr > td:first-child, .panel > .table-bordered > thead > tr > th:first-child, .panel > .table-responsive > .table-bordered > tbody > tr > td:first-child, .panel > .table-responsive > .table-bordered > tbody > tr > th:first-child, .panel > .table-responsive > .table-bordered > tfoot > tr > td:first-child, .panel > .table-responsive > .table-bordered > tfoot > tr > th:first-child, .panel > .table-responsive > .table-bordered > thead > tr > td:first-child, .panel > .table-responsive > .table-bordered > thead > tr > th:first-child { border-left: 0 } .panel > .table-bordered > tbody > tr > td:last-child, .panel > .table-bordered > tbody > tr > th:last-child, .panel > .table-bordered > tfoot > tr > td:last-child, .panel > .table-bordered > tfoot > tr > th:last-child, .panel > .table-bordered > thead > tr > td:last-child, .panel > .table-bordered > thead > tr > th:last-child, .panel > .table-responsive > .table-bordered > tbody > tr > td:last-child, .panel > .table-responsive > .table-bordered > tbody > tr > th:last-child, .panel > .table-responsive > .table-bordered > tfoot > tr > td:last-child, .panel > .table-responsive > .table-bordered > tfoot > tr > th:last-child, .panel > .table-responsive > .table-bordered > thead > tr > td:last-child, .panel > .table-responsive > .table-bordered > thead > tr > th:last-child { border-right: 0 } .panel > .table-bordered > tbody > tr:first-child > td, .panel > .table-bordered > tbody > tr:first-child > th, .panel > .table-bordered > tbody > tr:last-child > td, .panel > .table-bordered > tbody > tr:last-child > th, .panel > .table-bordered > tfoot > tr:last-child > td, .panel > .table-bordered > tfoot > tr:last-child > th, .panel > .table-bordered > thead > tr:first-child > td, .panel > .table-bordered > thead > tr:first-child > th, .panel > .table-responsive > .table-bordered > tbody > tr:first-child > td, .panel > .table-responsive > .table-bordered > tbody > tr:first-child > th, .panel > .table-responsive > .table-bordered > tbody > tr:last-child > td, .panel > .table-responsive > .table-bordered > tbody > tr:last-child > th, .panel > .table-responsive > .table-bordered > tfoot > tr:last-child > td, .panel > .table-responsive > .table-bordered > tfoot > tr:last-child > th, .panel > .table-responsive > .table-bordered > thead > tr:first-child > td, .panel > .table-responsive > .table-bordered > thead > tr:first-child > th { border-bottom: 0 } .panel > .table-responsive { margin-bottom: 0; border: 0 } .panel-group { margin-bottom: 20px } .panel-group .panel { margin-bottom: 0; border-radius: 4px } .panel-group .panel + .panel { margin-top: 5px } .panel-group .panel-heading { border-bottom: 0 } .panel-group .panel-heading + .panel-collapse > .list-group, .panel-group .panel-heading + .panel-collapse > .panel-body { border-top: 1px solid #ddd } .panel-group .panel-footer { border-top: 0 } .panel-group .panel-footer + .panel-collapse .panel-body { border-bottom: 1px solid #ddd } .panel-default { border-color: #ddd } .panel-default > .panel-heading { color: #333; background-color: #f5f5f5; border-color: #ddd } .panel-default > .panel-heading + .panel-collapse > .panel-body { border-top-color: #ddd } .panel-default > .panel-heading .badge { color: #f5f5f5; background-color: #333 } .panel-default > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #ddd } .panel-primary { border-color: #337ab7 } .panel-primary > .panel-heading { color: #fff; background-color: #337ab7; border-color: #337ab7 } .panel-primary > .panel-heading + .panel-collapse > .panel-body { border-top-color: #337ab7 } .panel-primary > .panel-heading .badge { color: #337ab7; background-color: #fff } .panel-primary > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #337ab7 } .panel-success { border-color: #d6e9c6 } .panel-success > .panel-heading { color: #3c763d; background-color: #dff0d8; border-color: #d6e9c6 } .panel-success > .panel-heading + .panel-collapse > .panel-body { border-top-color: #d6e9c6 } .panel-success > .panel-heading .badge { color: #dff0d8; background-color: #3c763d } .panel-success > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #d6e9c6 } .panel-info { border-color: #bce8f1 } .panel-info > .panel-heading { color: #31708f; background-color: #d9edf7; border-color: #bce8f1 } .panel-info > .panel-heading + .panel-collapse > .panel-body { border-top-color: #bce8f1 } .panel-info > .panel-heading .badge { color: #d9edf7; background-color: #31708f } .panel-info > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #bce8f1 } .panel-warning { border-color: #faebcc } .panel-warning > .panel-heading { color: #8a6d3b; background-color: #fcf8e3; border-color: #faebcc } .panel-warning > .panel-heading + .panel-collapse > .panel-body { border-top-color: #faebcc } .panel-warning > .panel-heading .badge { color: #fcf8e3; background-color: #8a6d3b } .panel-warning > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #faebcc } .panel-danger { border-color: #ebccd1 } .panel-danger > .panel-heading { color: #a94442; background-color: #f2dede; border-color: #ebccd1 } .panel-danger > .panel-heading + .panel-collapse > .panel-body { border-top-color: #ebccd1 } .panel-danger > .panel-heading .badge { color: #f2dede; background-color: #a94442 } .panel-danger > .panel-footer + .panel-collapse > .panel-body { border-bottom-color: #ebccd1 } .embed-responsive { position: relative; display: block; height: 0; padding: 0; overflow: hidden } .embed-responsive .embed-responsive-item, .embed-responsive embed, .embed-responsive iframe, .embed-responsive object, .embed-responsive video { position: absolute; top: 0; bottom: 0; left: 0; width: 100%; height: 100%; border: 0 } .embed-responsive-16by9 { padding-bottom: 56.25% } .embed-responsive-4by3 { padding-bottom: 75% } .well { min-height: 20px; padding: 19px; margin-bottom: 20px; background-color: #f5f5f5; border: 1px solid #e3e3e3; border-radius: 4px; -webkit-box-shadow: inset 0 1px 1px rgba(0,0,0,.05); box-shadow: inset 0 1px 1px rgba(0,0,0,.05) } .well blockquote { border-color: rgba(0,0,0,.15) } .well-lg { padding: 24px; border-radius: 6px } .well-sm { padding: 9px; border-radius: 3px } .close { float: right; font-size: 21px; font-weight: 700; line-height: 1; color: #000; text-shadow: 0 1px 0 #fff; opacity: .2 } .close:focus, .close:hover { color: #000; text-decoration: none; cursor: pointer; opacity: .5 } button.close { padding: 0; cursor: pointer; background: 0 0; border: 0; -webkit-appearance: none; -moz-appearance: none; appearance: none } .modal-open { overflow: hidden } .modal { position: fixed; top: 0; right: 0; bottom: 0; left: 0; z-index: 1050; display: none; overflow: hidden; -webkit-overflow-scrolling: touch; outline: 0 } .modal.fade .modal-dialog { -webkit-transform: translate(0,-25%); -ms-transform: translate(0,-25%); -o-transform: translate(0,-25%); transform: translate(0,-25%); -webkit-transition: -webkit-transform .3s ease-out; -o-transition: -o-transform .3s ease-out; transition: transform .3s ease-out; transition: transform .3s ease-out,-webkit-transform .3s ease-out,-o-transform .3s ease-out } .modal.in .modal-dialog { -webkit-transform: translate(0,0); -ms-transform: translate(0,0); -o-transform: translate(0,0); transform: translate(0,0) } .modal-open .modal { overflow-x: hidden; overflow-y: auto } .modal-dialog { position: relative; width: auto; margin: 10px } .modal-content { position: relative; background-color: #fff; background-clip: padding-box; border: 1px solid rgba(0,0,0,.2); border-radius: 6px; -webkit-box-shadow: 0 3px 9px rgba(0,0,0,.5); box-shadow: 0 3px 9px rgba(0,0,0,.5); outline: 0 } .modal-backdrop { position: fixed; top: 0; right: 0; bottom: 0; left: 0; z-index: 1040; background-color: #000 } .modal-backdrop.fade { opacity: 0 } .modal-backdrop.in { opacity: .5 } .modal-header { padding: 15px; border-bottom: 1px solid #e5e5e5 } .modal-header .close { margin-top: -2px } .modal-title { margin: 0; line-height: 1.42857143 } .modal-body { position: relative; padding: 15px } .modal-footer { padding: 15px; text-align: right; border-top: 1px solid #e5e5e5 } .modal-footer .btn + .btn { margin-bottom: 0; margin-left: 5px } .modal-footer .btn-group .btn + .btn { margin-left: -1px } .modal-footer .btn-block + .btn-block { margin-left: 0 } .modal-scrollbar-measure { position: absolute; top: -9999px; width: 50px; height: 50px; overflow: scroll } @media (min-width:768px) { .modal-dialog { width: 600px; margin: 30px auto } .modal-content { -webkit-box-shadow: 0 5px 15px rgba(0,0,0,.5); box-shadow: 0 5px 15px rgba(0,0,0,.5) } .modal-sm { width: 300px } } @media (min-width:992px) { .modal-lg { width: 900px } } .tooltip { position: absolute; z-index: 1070; display: block; font-family: "Helvetica Neue",Helvetica,Arial,sans-serif; font-style: normal; font-weight: 400; line-height: 1.42857143; line-break: auto; text-align: left; text-align: start; text-decoration: none; text-shadow: none; text-transform: none; letter-spacing: normal; word-break: normal; word-spacing: normal; word-wrap: normal; white-space: normal; font-size: 12px; opacity: 0 } .tooltip.in { opacity: .9 } .tooltip.top { padding: 5px 0; margin-top: -3px } .tooltip.right { padding: 0 5px; margin-left: 3px } .tooltip.bottom { padding: 5px 0; margin-top: 3px } .tooltip.left { padding: 0 5px; margin-left: -3px } .tooltip.top .tooltip-arrow { bottom: 0; left: 50%; margin-left: -5px; border-width: 5px 5px 0; border-top-color: #000 } .tooltip.top-left .tooltip-arrow { right: 5px; bottom: 0; margin-bottom: -5px; border-width: 5px 5px 0; border-top-color: #000 } .tooltip.top-right .tooltip-arrow { bottom: 0; left: 5px; margin-bottom: -5px; border-width: 5px 5px 0; border-top-color: #000 } .tooltip.right .tooltip-arrow { top: 50%; left: 0; margin-top: -5px; border-width: 5px 5px 5px 0; border-right-color: #000 } .tooltip.left .tooltip-arrow { top: 50%; right: 0; margin-top: -5px; border-width: 5px 0 5px 5px; border-left-color: #000 } .tooltip.bottom .tooltip-arrow { top: 0; left: 50%; margin-left: -5px; border-width: 0 5px 5px; border-bottom-color: #000 } .tooltip.bottom-left .tooltip-arrow { top: 0; right: 5px; margin-top: -5px; border-width: 0 5px 5px; border-bottom-color: #000 } .tooltip.bottom-right .tooltip-arrow { top: 0; left: 5px; margin-top: -5px; border-width: 0 5px 5px; border-bottom-color: #000 } .tooltip-inner { max-width: 200px; padding: 3px 8px; color: #fff; text-align: center; background-color: #000; border-radius: 4px } .tooltip-arrow { position: absolute; width: 0; height: 0; border-color: transparent; border-style: solid } .popover { position: absolute; top: 0; left: 0; z-index: 1060; display: none; max-width: 276px; padding: 1px; font-family: "Helvetica Neue",Helvetica,Arial,sans-serif; font-style: normal; font-weight: 400; line-height: 1.42857143; line-break: auto; text-align: left; text-align: start; text-decoration: none; text-shadow: none; text-transform: none; letter-spacing: normal; word-break: normal; word-spacing: normal; word-wrap: normal; white-space: normal; font-size: 14px; background-color: #fff; background-clip: padding-box; border: 1px solid rgba(0,0,0,.2); border-radius: 6px; -webkit-box-shadow: 0 5px 10px rgba(0,0,0,.2); box-shadow: 0 5px 10px rgba(0,0,0,.2) } .popover.top { margin-top: -10px } .popover.right { margin-left: 10px } .popover.bottom { margin-top: 10px } .popover.left { margin-left: -10px } .popover > .arrow { border-width: 11px } .popover > .arrow, .popover > .arrow:after { position: absolute; display: block; width: 0; height: 0; border-color: transparent; border-style: solid } .popover > .arrow:after { content: ""; border-width: 10px } .popover.top > .arrow { bottom: -11px; left: 50%; margin-left: -11px; border-top-color: rgba(0,0,0,.25); border-bottom-width: 0 } .popover.top > .arrow:after { bottom: 1px; margin-left: -10px; content: " "; border-top-color: #fff; border-bottom-width: 0 } .popover.right > .arrow { top: 50%; left: -11px; margin-top: -11px; border-right-color: rgba(0,0,0,.25); border-left-width: 0 } .popover.right > .arrow:after { bottom: -10px; left: 1px; content: " "; border-right-color: #fff; border-left-width: 0 } .popover.bottom > .arrow { top: -11px; left: 50%; margin-left: -11px; border-top-width: 0; border-bottom-color: rgba(0,0,0,.25) } .popover.bottom > .arrow:after { top: 1px; margin-left: -10px; content: " "; border-top-width: 0; border-bottom-color: #fff } .popover.left > .arrow { top: 50%; right: -11px; margin-top: -11px; border-right-width: 0; border-left-color: rgba(0,0,0,.25) } .popover.left > .arrow:after { right: 1px; bottom: -10px; content: " "; border-right-width: 0; border-left-color: #fff } .popover-title { padding: 8px 14px; margin: 0; font-size: 14px; background-color: #f7f7f7; border-bottom: 1px solid #ebebeb; border-radius: 5px 5px 0 0 } .popover-content { padding: 9px 14px } .carousel { position: relative } .carousel-inner { position: relative; width: 100%; overflow: hidden } .carousel-inner > .item { position: relative; display: none; -webkit-transition: left .6s ease-in-out; -o-transition: left .6s ease-in-out; transition: left .6s ease-in-out } .carousel-inner > .item > a > img, .carousel-inner > .item > img { line-height: 1 } @media all and (transform-3d),(-webkit-transform-3d) { .carousel-inner > .item { -webkit-transition: -webkit-transform .6s ease-in-out; -o-transition: -o-transform .6s ease-in-out; transition: transform .6s ease-in-out; transition: transform .6s ease-in-out,-webkit-transform .6s ease-in-out,-o-transform .6s ease-in-out; -webkit-backface-visibility: hidden; backface-visibility: hidden; -webkit-perspective: 1000px; perspective: 1000px } .carousel-inner > .item.active.right, .carousel-inner > .item.next { -webkit-transform: translate3d(100%,0,0); transform: translate3d(100%,0,0); left: 0 } .carousel-inner > .item.active.left, .carousel-inner > .item.prev { -webkit-transform: translate3d(-100%,0,0); transform: translate3d(-100%,0,0); left: 0 } .carousel-inner > .item.active, .carousel-inner > .item.next.left, .carousel-inner > .item.prev.right { -webkit-transform: translate3d(0,0,0); transform: translate3d(0,0,0); left: 0 } } .carousel-inner > .active, .carousel-inner > .next, .carousel-inner > .prev { display: block } .carousel-inner > .active { left: 0 } .carousel-inner > .next, .carousel-inner > .prev { position: absolute; top: 0; width: 100% } .carousel-inner > .next { left: 100% } .carousel-inner > .prev { left: -100% } .carousel-inner > .next.left, .carousel-inner > .prev.right { left: 0 } .carousel-inner > .active.left { left: -100% } .carousel-inner > .active.right { left: 100% } .carousel-control { position: absolute; top: 0; bottom: 0; left: 0; width: 15%; font-size: 20px; color: #fff; text-align: center; text-shadow: 0 1px 2px rgba(0,0,0,.6); background-color: rgba(0,0,0,0); opacity: .5 } .carousel-control.left { background-image: -webkit-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%); background-image: -o-linear-gradient(left,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%); background-image: -webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.5)),to(rgba(0,0,0,.0001))); background-image: linear-gradient(to right,rgba(0,0,0,.5) 0,rgba(0,0,0,.0001) 100%); background-repeat: repeat-x } .carousel-control.right { right: 0; left: auto; background-image: -webkit-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%); background-image: -o-linear-gradient(left,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%); background-image: -webkit-gradient(linear,left top,right top,from(rgba(0,0,0,.0001)),to(rgba(0,0,0,.5))); background-image: linear-gradient(to right,rgba(0,0,0,.0001) 0,rgba(0,0,0,.5) 100%); background-repeat: repeat-x } .carousel-control:focus, .carousel-control:hover { color: #fff; text-decoration: none; outline: 0; opacity: .9 } .carousel-control .glyphicon-chevron-left, .carousel-control .glyphicon-chevron-right, .carousel-control .icon-next, .carousel-control .icon-prev { position: absolute; top: 50%; z-index: 5; display: inline-block; margin-top: -10px } .carousel-control .glyphicon-chevron-left, .carousel-control .icon-prev { left: 50%; margin-left: -10px } .carousel-control .glyphicon-chevron-right, .carousel-control .icon-next { right: 50%; margin-right: -10px } .carousel-control .icon-next, .carousel-control .icon-prev { width: 20px; height: 20px; font-family: serif; line-height: 1 } .carousel-control .icon-prev:before { content: "\2039" } .carousel-control .icon-next:before { content: "\203a" } .carousel-indicators { position: absolute; bottom: 10px; left: 50%; z-index: 15; width: 60%; padding-left: 0; margin-left: -30%; text-align: center; list-style: none } .carousel-indicators li { display: inline-block; width: 10px; height: 10px; margin: 1px; text-indent: -999px; cursor: pointer; background-color: rgba(0,0,0,0); border: 1px solid #fff; border-radius: 10px } .carousel-indicators .active { width: 12px; height: 12px; margin: 0; background-color: #fff } .carousel-caption { position: absolute; right: 15%; bottom: 20px; left: 15%; z-index: 10; padding-top: 20px; padding-bottom: 20px; color: #fff; text-align: center; text-shadow: 0 1px 2px rgba(0,0,0,.6) } .carousel-caption .btn { text-shadow: none } @media screen and (min-width:768px) { .carousel-control .glyphicon-chevron-left, .carousel-control .glyphicon-chevron-right, .carousel-control .icon-next, .carousel-control .icon-prev { width: 30px; height: 30px; margin-top: -10px; font-size: 30px } .carousel-control .glyphicon-chevron-left, .carousel-control .icon-prev { margin-left: -10px } .carousel-control .glyphicon-chevron-right, .carousel-control .icon-next { margin-right: -10px } .carousel-caption { right: 20%; left: 20%; padding-bottom: 30px } .carousel-indicators { bottom: 20px } } .btn-group-vertical > .btn-group:after, .btn-group-vertical > .btn-group:before, .btn-toolbar:after, .btn-toolbar:before, .clearfix:after, .clearfix:before, .container-fluid:after, .container-fluid:before, .container:after, .container:before, .dl-horizontal dd:after, .dl-horizontal dd:before, .form-horizontal .form-group:after, .form-horizontal .form-group:before, .modal-footer:after, .modal-footer:before, .modal-header:after, .modal-header:before, .nav:after, .nav:before, .navbar-collapse:after, .navbar-collapse:before, .navbar-header:after, .navbar-header:before, .navbar:after, .navbar:before, .pager:after, .pager:before, .panel-body:after, .panel-body:before, .row:after, .row:before { display: table; content: " " } .btn-group-vertical > .btn-group:after, .btn-toolbar:after, .clearfix:after, .container-fluid:after, .container:after, .dl-horizontal dd:after, .form-horizontal .form-group:after, .modal-footer:after, .modal-header:after, .nav:after, .navbar-collapse:after, .navbar-header:after, .navbar:after, .pager:after, .panel-body:after, .row:after { clear: both } .center-block { display: block; margin-right: auto; margin-left: auto } .pull-right { float: right !important } .pull-left { float: left !important } .hide { display: none !important } .show { display: block !important } .invisible { visibility: hidden } .text-hide { font: 0/0 a; color: transparent; text-shadow: none; background-color: transparent; border: 0 } .hidden { display: none !important } .affix { position: fixed } @-ms-viewport { width: device-width } .visible-lg, .visible-lg-block, .visible-lg-inline, .visible-lg-inline-block, .visible-md, .visible-md-block, .visible-md-inline, .visible-md-inline-block, .visible-sm, .visible-sm-block, .visible-sm-inline, .visible-sm-inline-block, .visible-xs, .visible-xs-block, .visible-xs-inline, .visible-xs-inline-block { display: none !important } @media (max-width:767px) { .visible-xs { display: block !important } table.visible-xs { display: table !important } tr.visible-xs { display: table-row !important } td.visible-xs, th.visible-xs { display: table-cell !important } .visible-xs-block { display: block !important } .visible-xs-inline { display: inline !important } .visible-xs-inline-block { display: inline-block !important } } @media (min-width:768px) and (max-width:991px) { .visible-sm { display: block !important } table.visible-sm { display: table !important } tr.visible-sm { display: table-row !important } td.visible-sm, th.visible-sm { display: table-cell !important } .visible-sm-block { display: block !important } .visible-sm-inline { display: inline !important } .visible-sm-inline-block { display: inline-block !important } } @media (min-width:992px) and (max-width:1199px) { .visible-md { display: block !important } table.visible-md { display: table !important } tr.visible-md { display: table-row !important } td.visible-md, th.visible-md { display: table-cell !important } .visible-md-block { display: block !important } .visible-md-inline { display: inline !important } .visible-md-inline-block { display: inline-block !important } } @media (min-width:1200px) { .visible-lg { display: block !important } table.visible-lg { display: table !important } tr.visible-lg { display: table-row !important } td.visible-lg, th.visible-lg { display: table-cell !important } .visible-lg-block { display: block !important } .visible-lg-inline { display: inline !important } .visible-lg-inline-block { display: inline-block !important } .hidden-lg { display: none !important } } @media (max-width:767px) { .hidden-xs { display: none !important } } @media (min-width:768px) and (max-width:991px) { .hidden-sm { display: none !important } } @media (min-width:992px) and (max-width:1199px) { .hidden-md { display: none !important } } .visible-print { display: none !important } @media print { .visible-print { display: block !important } table.visible-print { display: table !important } tr.visible-print { display: table-row !important } td.visible-print, th.visible-print { display: table-cell !important } } .visible-print-block { display: none !important } @media print { .visible-print-block { display: block !important } } .visible-print-inline { display: none !important } @media print { .visible-print-inline { display: inline !important } } .visible-print-inline-block { display: none !important } @media print { .visible-print-inline-block { display: inline-block !important } .hidden-print { display: none !important } } .hljs { display: block; background: #fff; padding: .5em; color: #333; overflow-x: auto } .hljs-comment, .hljs-meta { color: #969896 } .hljs-emphasis, .hljs-quote, .hljs-string, .hljs-strong, .hljs-template-variable, .hljs-variable { color: #df5000 } .hljs-keyword, .hljs-selector-tag, .hljs-type { color: #a71d5d } .hljs-attribute, .hljs-bullet, .hljs-literal, .hljs-symbol { color: #0086b3 } .hljs-name, .hljs-section { color: #63a35c } .hljs-tag { color: #333 } .hljs-attr, .hljs-selector-attr, .hljs-selector-class, .hljs-selector-id, .hljs-selector-pseudo, .hljs-title { color: #795da3 } .hljs-addition { color: #55a532; background-color: #eaffea } .hljs-deletion { color: #bd2c00; background-color: #ffecec } .hljs-link { text-decoration: underline } /* COLOR VARIABLES*/ :root { --header-bg-color: #212121; --header-ft-color: #fefefe; --highlight-light: rgb(9, 105, 218); --highlight-dark: rgb(9, 105, 218); --accent-dim: #e0e0e0; --accent-super-dim: #f3f3f3; --font-color: rgb(31, 35, 40); --toc-font-color: #222222; --tab-hover-color: #444444; --card-box-shadow: 0 1px 2px 0 rgba(61, 65, 68, 0.06), 0 1px 3px 1px rgba(61, 65, 68, 0.16); --search-box-shadow: 0 1px 2px 0 rgba(41, 45, 48, 0.36), 0 1px 3px 1px rgba(41, 45, 48, 0.46); --transition: 350ms; } body { background: white; color: var(--font-color); font-family: "Roboto", sans-serif; line-height: 1.5; font-size: 15px !important; /* -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;*/ word-wrap: break-word; } body div, body p, body ul { color: var(--font-color); font-family: "Roboto", sans-serif !important; line-height: 1.5 !important; font-size: 15px !important; /* -ms-text-size-adjust: 100%; -webkit-text-size-adjust: 100%;*/ word-wrap: break-word; } body, p, blockquote, ul, ol, dl, table, pre, code, tr { color: var(--font-color); } /* HIGHLIGHT COLOR */ p { margin: 0 0 12px; /*text-align: justify;*/ } button, a { color: var(--highlight-dark); cursor: pointer; } button:hover, button:focus, a:hover, a:focus { color: var(--highlight-light); text-decoration: none; } .toc .nav > li.active > a { color: var(--highlight-dark); } .toc .nav > li.active > a:hover, .toc .nav > li.active > a:focus { color: var(--highlight-light); } /*.pagination > .active > a { background-color: var(--header-bg-color); border-color: var(--header-bg-color); } .pagination > .active > a, .pagination > .active > a:focus, .pagination > .active > a:hover, .pagination > .active > span, .pagination > .active > span:focus, .pagination > .active > span:hover { background-color: var(--highlight-light); border-color: var(--highlight-light); } */ /* HEADINGS */ h1 { font-weight: 300; font-size: 34px; color: #000000b0; } h2 { font-weight: 500; font-size: 22px; line-height: 1.8; } h3 { font-weight: 400; font-size: 18px; line-height: 1.8; } h4 { font-weight: 500; } h5 { font-size: 14px; font-weight: 500; padding: 10px 0px; } .h6, h6 { font-size: 13px; } article h1 { margin-top: 45px; margin-bottom: 20px; } article > h1:first-child { margin-top: 10px; } article h2, article h3, article h4 { margin-top: 25px; margin-bottom: 10px; } article h2 { margin-top: 35px; } article h3 { margin-top: 30px; } article h4 { padding-bottom: 6px; border-bottom: 1px solid #ddd; font-weight: 500; font-size: 17px; } th { font-weight: 500; } h1 + h2, h2 + h3, h3 + h4 { margin-top: 0; } article ul { margin-bottom: 12px; } article li { margin-bottom: 4px; } #fields, #properties, #methods, #events { font-weight: 500; margin-top: 2em; } /* SIDEBAR */ .toc .nav > li > a { color: var(--toc-font-color); } .sidefilter { background-color: #fff; border-left: none; border-right: none; } .sidefilter { background-color: #fff; border-left: none; border-right: none; } .toc-filter { padding: 5px; margin: 0; box-shadow: var(--card-box-shadow); transition: var(--transition); opacity: 0.5; } .toc-filter:hover, .toc-filter:focus, .toc-filter:focus-within { opacity: 1; } .toc-filter > input { border: none; background-color: inherit; transition: inherit; } .toc-filter > .filter-icon { display: none; } .sidetoc > .toc { background-color: #fff; overflow-x: unset; } .sidetoc { background-color: #fff; border: none; } .toc { margin: 0; padding: 0; font-size: 14px; } .toc .nav > li { position: relative; display: block; margin-bottom: 8px; text-transform: capitalize; } .toc ul { margin-top: 8px; margin-left: 10px; font-size: 14px; } .toc:first-child > ul { margin-top: 0; } .toc:first-child > ul:first-child > li { margin-top: 0; } .sidetoc { overflow-x: auto; overflow-wrap: normal; width: 260px; } .toc .level1 > li { font-weight: 400; margin-top: 8px; position: relative; font-size: 14px; } .toc .level2 { font-weight: normal; font-size: 14px; } .toc UL.level2 { margin: 8px 0 0 15px; font-size: 14px; } .expand-stub { left: -10px; font-family: "WebComponentsIcons"; } .toc .nav > li.active > .expand-stub::before, .toc .nav > li.in > .expand-stub::before, .toc .nav > li.in.active > .expand-stub::before, .toc .nav > li.filtered > .expand-stub::before { content: "\e015"; } .toc .nav > li > .expand-stub::before, .toc .nav > li.active > .expand-stub::before { content: "\e014"; } /* ALERTS */ .alert { padding: 0px 0px 5px 0px; margin-top: 20px; color: inherit; background-color: inherit; border: none; box-shadow: var(--card-box-shadow); } .alert > p { margin-bottom: 0; padding: 5px 10px; } .alert > ul { margin-bottom: 0; padding: 5px 40px; } .alert > h5 { padding: 10px 15px; margin-top: 0; text-transform: uppercase; font-weight: 500; border-radius: 4px 4px 0 0; } .alert-info > h5 { color: #1976d2; border-bottom: 4px solid #1976d2; background-color: #e3f2fd; } .alert-warning > h5 { color: #f57f17; border-bottom: 4px solid #f57f17; background-color: #fff3e0; } .alert-danger > h5 { color: #d32f2f; border-bottom: 4px solid #d32f2f; background-color: #ffebee; } /* CODE HIGHLIGHT */ pre { padding: 9.5px; margin: 20px 0; font-size: 15px; word-break: break-all; word-wrap: break-word; background-color: #f8f8f7; border-radius: 4px; border: none; box-shadow: var(--card-box-shadow); } /* STYLE FOR IMAGES */ .article .small-image { margin-top: 15px; box-shadow: var(--card-box-shadow); max-width: 350px; } .article .medium-image { margin-top: 15px; box-shadow: var(--card-box-shadow); max-width: 550px; } .article .large-image { margin-top: 15px; box-shadow: var(--card-box-shadow); max-width: 700px; } *, :after, :before { box-sizing: border-box; } header { background-color: var(--header-bg-color); } .article { margin-top: 200px; margin-bottom: 115px; } .sidefilter { top: 200px; margin: 0; padding: 0; width: 260px; } .toc-filter { border-radius: 5px; background: unset; color: unset; padding: 0; position: relative; margin: 0; } #toc_filter_input { width: 100%; height: 26px; padding: 6px 12px; font-size: 14px; line-height: 1.42857143; border: 1px solid #ccc; } .sidetoc { top: 240px; } .navbar-brand { height: unset; } .hidden-sm.col-md-2 { padding-left: 0; } .sideaffix { top: 150px; font-size: 13px; max-width: calc(12% - 5px); margin-left: 5px; } .affix { text-transform: capitalize; } .affix ul > li > a { text-transform: capitalize; } .affix ul > li > a { padding-top: 3px; padding-right: 12px; padding-bottom: 3px; padding-left: 14px; text-overflow: ellipsis; white-space: nowrap; overflow: hidden; } .affix h5 { font-weight: 500; } .affix ul ul > li > a:before { top: unset; } .article.grid-right { margin-left: 280px; } @media only screen and (max-width: 768px) { .article.grid-right { margin-left: 0; } } .sdkversion { color: var(--highlight-dark); font-weight: 500; } #search .form-control { width: 100%; height: 26px; /* padding: 6px 12px; */ font-size: 14px; line-height: 1.42857143; border: 1px solid #ccc; } .container #breadcrumb { float: left; } .breadcrumb li { font-size: 14px; text-transform: capitalize; } .opspan { text-transform: uppercase; padding: 3px 10px; color: white; font-weight: bold; border-radius: 5px; } .opspan.opspan-post { background: #49cc90; } .opspan.opspan-put { background: #fca130; } .opspan.opspan-delete { background: #f93e3e; } .opspan.opspan-get { background: #61affe; } .opspan.opspan-patch { background: #50e3c2; } .opspan.opspan-head { background: #9012fe; } .opspan.opspan-options { background: #0d5aa7; } .grad-bottom { background: linear-gradient(rgb(0 0 0 / 0%), rgb(0 0 0 / 8%)); height: 5px; } .footer { border-top: 1px solid #ededed; background-color: #111; padding: 15px 0; color: #757575; } .footer a.lnk { color: #9e9e9e; } .refdoc pre { margin: 0; } .refdoc h4 { margin-top: 40px; } .refdoc h4 { margin-top: 50px; padding-bottom: 3px; } .refdoc h5 { padding-bottom: 3px; margin-top: 16px; } .hljs-keyword { color: rgb(86,156,214); } .hljs-string, .hljs-meta-string { color: rgb(214, 157, 133); } .card.fw-horizontal { text-align: left; padding: 1.4rem; flex-direction: row; border-radius: 0.75rem; box-shadow: 3px 3px 13px 0px rgb(255 255 255 / 42%); /* height: 100%; */ align-items: flex-start; gap: 1rem; margin: 1rem 1rem; max-height: 12rem; } @media (min-width: 768px) { .card.fw-horizontal:first-child { width: calc(66.66666667% + 2rem); } } @media (min-width: 990px) { .card.fw-horizontal:first-child { margin: 1rem; width: 25%; } } .card { padding: 1rem 2rem; margin-bottom: 1rem; } .card { position: relative; display: -webkit-box; display: -ms-flexbox; display: flex; flex-direction: column; min-width: 0; word-wrap: break-word; /* background-color: var(--fw-card-bg); */ /* background-clip: border-box; */ border: 1px solid var(--fw-card-border-color); border-radius: 0.5rem; background: linear-gradient(12deg, #e3e3e3, white); align-items: center; margin: 1rem; box-shadow: 3px 3px 10px 0px rgb(99 113 119 / 17%); } .card .category-icon { height: 4.5rem; margin: 0 0.2em 0.6rem 0; } .card.fw-horizontal .fw-category-icon { width: 4.5rem; margin: 0.2rem 0 0 0; } .card-body { color: var(--fw-card-fg); } .card.fw-horizontal .card-title { margin-bottom: 0.3rem; padding-bottom: 0; } .cardRow { display: flex; flex-direction: row; flex-wrap: wrap; justify-content: center; align-content: inherit; align-items: stretch; /* gap: 2rem; */ margin-bottom: 70px; } .card.fw-horizontal .card-body { width: 75%; overflow: hidden; max-height: 100%; } .card-text { color: var(--font-color); font-size: 15px; overflow: hidden; } H4.card-title { margin-top: 0; line-height: 1.3; border: none; } H2.card-title { margin-top: 0; line-height: 1.2; margin-bottom: 0.4rem; } .landingBackground { background-image: url(../images/books_background.jpg); position: absolute; top: -50px; left: 0; right: 0; height: 350px; background-position: center center; -webkit-background-size: cover; background-size: cover; z-index: -1; } .landingBackground.searchResults { height: 220px; } .landing-search { margin-top: 180px; margin-bottom: 20px; } @media only screen and (max-width: 990px) { .landingBackground { top: 0px; height: 410px; } .landingBackground.searchResults { height: 180px; } .landing-search { margin-top: 140px; } } @media only screen and (max-width: 950px) { .landing-search { margin-top: 120px; margin-bottom: 0; } .landingBackground { top: -30px; height: 420px; } } @media only screen and (max-width: 900px) { .landing-search { margin-top: 80px; margin-bottom: 0; } .landingBackground { height: 440px; } } @media only screen and (max-width: 768px) { .landing-search { margin-top: 20px; margin-bottom: 40px; } .landingBackground.searchResults { height: 250px; } .landingBackground { height: 250px; } } .search-form { margin: auto; width: 32rem; display: flex !important; flex-direction: column; align-items: center; } #search.search-form .form-control { width: unset; font-size: 24px; height: 42px; width: 36rem; } .search-heading h2 { color: white; font-size: 29px; white-space: nowrap; font-weight: 300; margin-bottom: 0.1rem; } .landingPage H1 { text-align: center; } .landingPage #search-results { margin-top: 60px; } .card.fw-horizontal .card-text { -webkit-line-clamp: 2; line-clamp: 2; display: -webkit-inline-box; -webkit-box-orient: vertical; } .landingPage ARTICLE H1:first-child { display: none; } body { padding: 20px !important; } body > div:first-child > hr + p { display: none; } body > div:first-child hr { display: none; } body > div:first-child { margin-top: 20px; } ================================================ FILE: global.json ================================================ { "sdk": { "version": "10.0.100", "rollForward": "feature", "allowPrerelease": false } } ================================================ FILE: nuke/.editorconfig ================================================ [*.cs] dotnet_style_qualification_for_field = false:warning dotnet_style_qualification_for_property = false:warning dotnet_style_qualification_for_method = false:warning dotnet_style_qualification_for_event = false:warning dotnet_style_require_accessibility_modifiers = never:warning csharp_style_expression_bodied_methods = true:silent csharp_style_expression_bodied_properties = true:warning csharp_style_expression_bodied_indexers = true:warning csharp_style_expression_bodied_accessors = true:warning ================================================ FILE: nuke/Build.cs ================================================ using Microsoft.Build.Exceptions; using Nuke.Common; using Nuke.Common.CI.GitHubActions; using Nuke.Common.IO; using Nuke.Common.ProjectModel; using Nuke.Common.Tooling; using Nuke.Common.Tools.DotNet; using Nuke.Common.Tools.GitHub; using Nuke.Common.Tools.NuGet; using Nuke.Common.Utilities.Collections; using Octokit; using Octokit.Internal; using Serilog; using System; using System.Collections.Generic; using System.IO; using System.Linq; using static Nuke.Common.IO.PathConstruction; using static Nuke.Common.Tools.DotNet.DotNetTasks; // ReSharper disable ArrangeThisQualifier class Build : NukeBuild { /// Support plugins are available for: /// - JetBrains ReSharper https://nuke.build/resharper /// - JetBrains Rider https://nuke.build/rider /// - Microsoft VisualStudio https://nuke.build/visualstudio /// - Microsoft VSCode https://nuke.build/vscode public static int Main() => Execute(x => x.RunUnitTests); [Nuke.Common.Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")] readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release; [Nuke.Common.Parameter("ReleaseNotesFilePath - To determine the lates changelog version")] readonly AbsolutePath ReleaseNotesFilePath = RootDirectory / "Changelog.md"; [Nuke.Common.Parameter("common.props file path - to determine the configured version")] readonly AbsolutePath CommonPropsFilePath = RootDirectory / "src" / "common.props"; [Solution] readonly Solution Solution; AbsolutePath SourceDirectory => RootDirectory / "src"; AbsolutePath ResultDirectory => RootDirectory / "artifacts"; GitHubActions GitHubActions => GitHubActions.Instance; IReadOnlyList ChangeLog { get; set; } ReleaseNotes LatestReleaseNotes { get; set; } SemVersion SemVersion { get; set; } string Version { get; set; } string VersionPostFix { get; set; } protected override void OnBuildInitialized() { var parser = new ReleaseNotesParser(); Log.Debug("Reading ChangeLog {FilePath}...", ReleaseNotesFilePath); ChangeLog = parser.Parse(File.ReadAllText(ReleaseNotesFilePath)); ChangeLog.NotNull("ChangeLog / ReleaseNotes could not be read!"); LatestReleaseNotes = ChangeLog.First(); LatestReleaseNotes.NotNull("LatestVersion could not be read!"); var propsParser = new CommonPropsParser(); var propsVersion = propsParser.Parse(CommonPropsFilePath); propsVersion.NotNull("Version from common.props could not be read!"); Assert.True(propsVersion == LatestReleaseNotes.Version, $"The version in common.props ({propsVersion}) does not " + $"equal the latest version in the changelog ({LatestReleaseNotes.Version})"); Log.Debug("Using version: {LatestVersion}", propsVersion); SemVersion = LatestReleaseNotes.SemVersion; Version = propsVersion.ToString(); if (GitHubActions != null) { Log.Debug("Add Version Postfix if under CI - GithubAction(s)..."); var buildNumber = GitHubActions.RunNumber; if (ScheduledTargets.Contains(Default)) { VersionPostFix = $"-ci.{buildNumber}"; } else if (ScheduledTargets.Contains(PrePublish)) { VersionPostFix = $"-pre.{buildNumber}"; } } else if (ScheduledTargets.Contains(PrePublish)) { VersionPostFix = $"-pre"; } Log.Information("Building version {Version} with postfix {VersionPostFix}", Version, VersionPostFix); } Target Clean => _ => _ .Before(Restore) .Executes(() => { SourceDirectory.GlobDirectories("**/bin", "**/obj").ForEach(dir => dir.DeleteDirectory()); }); Target Restore => _ => _ .Executes(() => { DotNetRestore(s => s.SetProjectFile(Solution)); }); Target Compile => _ => _ .DependsOn(Restore) .Executes(() => { DotNetBuild(s => s .SetProjectFile(Solution) .SetConfiguration(Configuration) .SetProperty("GeneratePackageOnBuild", "True") .SetProperty("VersionPostFix", VersionPostFix ?? string.Empty)); }); Target RunUnitTests => _ => _ .DependsOn(Compile) .Executes(() => { var TestProject = SourceDirectory / "ElectronNET.IntegrationTests" / "ElectronNET.IntegrationTests.csproj"; DotNetTest(s => s .SetProjectFile(TestProject) .SetConfiguration(Configuration) .When(_ => GitHubActions.Instance is not null, x => x.SetLoggers("GitHubActions")) ); }); Target PublishPackages => _ => _ .DependsOn(Compile) .DependsOn(RunUnitTests) .Executes(() => { var apiKey = Environment.GetEnvironmentVariable("NUGET_API_KEY"); if (apiKey.IsNullOrEmpty()) { throw new BuildAbortedException("Could not resolve the NuGet API key."); } foreach (var nupkg in ResultDirectory.GlobFiles("*.nupkg")) { DotNetNuGetPush(s => s .SetTargetPath(nupkg) .SetSource("https://api.nuget.org/v3/index.json") .SetApiKey(apiKey)); } }); Target PublishPreRelease => _ => _ .DependsOn(PublishPackages) .Executes(() => { string gitHubToken; if (GitHubActions != null) { gitHubToken = GitHubActions.Token; } else { gitHubToken = Environment.GetEnvironmentVariable("GITHUB_TOKEN"); } if (gitHubToken.IsNullOrEmpty()) { throw new BuildAbortedException("Could not resolve GitHub token."); } var credentials = new Credentials(gitHubToken); GitHubTasks.GitHubClient = new GitHubClient( new ProductHeaderValue(nameof(NukeBuild)), new InMemoryCredentialStore(credentials)); GitHubTasks.GitHubClient.Repository.Release .Create("ElectronNET", "Electron.NET", new NewRelease(Version + VersionPostFix) { Name = "ElectronNET.Core " + Version + VersionPostFix, Body = String.Join(Environment.NewLine, LatestReleaseNotes.Notes), Prerelease = true, TargetCommitish = "develop", }); }); Target PublishRelease => _ => _ .DependsOn(PublishPackages) .Executes(() => { string gitHubToken; if (GitHubActions != null) { gitHubToken = GitHubActions.Token; } else { gitHubToken = Environment.GetEnvironmentVariable("GITHUB_TOKEN"); } if (gitHubToken.IsNullOrEmpty()) { throw new BuildAbortedException("Could not resolve GitHub token."); } var credentials = new Credentials(gitHubToken); GitHubTasks.GitHubClient = new GitHubClient( new ProductHeaderValue(nameof(NukeBuild)), new InMemoryCredentialStore(credentials)); GitHubTasks.GitHubClient.Repository.Release .Create("ElectronNET", "Electron.NET", new NewRelease(Version) { Name = "ElectronNET.Core " + Version, Body = String.Join(Environment.NewLine, LatestReleaseNotes.Notes), Prerelease = false, TargetCommitish = "main", }); }); Target Package => _ => _ .DependsOn(RunUnitTests) .DependsOn(Compile); Target Default => _ => _ .DependsOn(Package); Target Publish => _ => _ .DependsOn(PublishRelease); Target PrePublish => _ => _ .DependsOn(PublishPreRelease); } ================================================ FILE: nuke/CommonPropsParser.cs ================================================ using System; using System.Linq; using System.Xml.Linq; /// /// Parses a version from an MSBuild .props file (XML). /// public sealed class CommonPropsParser { /// /// Initializes a new instance of the class. /// public CommonPropsParser() { } public Version Parse(string propsPath) { var doc = XDocument.Load(propsPath); var versionElement = doc .Descendants() .FirstOrDefault(e => e.Name.LocalName == "Version"); if (Version.TryParse(versionElement?.Value.Trim(), out var version)) { version = new Version(version.Major, version.Minor, version.Build); return version; } return null; } } ================================================ FILE: nuke/Configuration.cs ================================================ using System; using System.ComponentModel; using System.Linq; using Nuke.Common.Tooling; [TypeConverter(typeof(TypeConverter))] public class Configuration : Enumeration { public static Configuration Debug = new Configuration { Value = nameof(Debug) }; public static Configuration Release = new Configuration { Value = nameof(Release) }; public static implicit operator string(Configuration configuration) { return configuration.Value; } } ================================================ FILE: nuke/Directory.Build.props ================================================ ================================================ FILE: nuke/Directory.Build.targets ================================================ ================================================ FILE: nuke/Extensions/StringExtensions.cs ================================================ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. using System; // ReSharper disable once CheckNamespace /// /// Contains extension methods for . /// /// /// Original from Cake build tool source: /// https://github.com/cake-build/cake/blob/9828d7b246d332054896e52ba56983822feb3f05/src/Cake.Core/Extensions/StringExtensions.cs /// public static class StringExtensions { /// /// Quotes the specified . /// /// The string to quote. /// A quoted string. public static string Quote(this string value) { if (!IsQuoted(value)) { value = string.Concat("\"", value, "\""); } return value; } /// /// Unquote the specified . /// /// The string to unquote. /// An unquoted string. public static string UnQuote(this string value) { if (IsQuoted(value)) { value = value.Trim('"'); } return value; } /// /// Splits the into lines. /// /// The string to split. /// The lines making up the provided string. public static string[] SplitLines(this string content) { content = NormalizeLineEndings(content); return content.Split(new[] { "\r\n" }, StringSplitOptions.None); } /// /// Normalizes the line endings in a . /// /// The string to normalize line endings in. /// A with normalized line endings. public static string NormalizeLineEndings(this string value) { if (value != null) { value = value.Replace("\r\n", "\n"); value = value.Replace("\r", string.Empty); return value.Replace("\n", "\r\n"); } return string.Empty; } private static bool IsQuoted(this string value) { return value.StartsWith("\"", StringComparison.OrdinalIgnoreCase) && value.EndsWith("\"", StringComparison.OrdinalIgnoreCase); } } ================================================ FILE: nuke/ReleaseNotes.cs ================================================ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. using System; using System.Collections.Generic; using System.Linq; /// /// Represent release notes. /// /// /// Original from Cake build tool source: /// https://github.com/cake-build/cake/blob/9828d7b246d332054896e52ba56983822feb3f05/src/Cake.Common/ReleaseNotes.cs /// public sealed class ReleaseNotes { private readonly List _notes; /// /// Gets the version. /// /// The version. public SemVersion SemVersion { get; } /// /// Gets the version. /// /// The version. public Version Version { get; } /// /// Gets the release notes. /// /// The release notes. public IReadOnlyList Notes => _notes; /// /// Gets the raw text of the line that was extracted from. /// /// The raw text of the Version line. public string RawVersionLine { get; } /// /// Initializes a new instance of the class. /// /// The semantic version. /// The notes. /// The raw text of the version line. public ReleaseNotes(SemVersion semVersion, IEnumerable notes, string rawVersionLine) : this( semVersion?.AssemblyVersion ?? throw new ArgumentNullException(nameof(semVersion)), semVersion, notes, rawVersionLine) { } /// /// Initializes a new instance of the class. /// /// The version. /// The notes. /// The raw text of the version line. public ReleaseNotes(Version version, IEnumerable notes, string rawVersionLine) : this( version ?? throw new ArgumentNullException(nameof(version)), new SemVersion(version.Major, version.Minor, version.Build), notes, rawVersionLine) { } private ReleaseNotes(Version version, SemVersion semVersion, IEnumerable notes, string rawVersionLine) { Version = version ?? throw new ArgumentNullException(nameof(version)); SemVersion = semVersion ?? throw new ArgumentNullException(nameof(semVersion)); RawVersionLine = rawVersionLine; _notes = new List(notes ?? Enumerable.Empty()); } } ================================================ FILE: nuke/ReleaseNotesParser.cs ================================================ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. using System; using System.Collections.Generic; using System.Linq; using System.Text.RegularExpressions; using Microsoft.Build.Exceptions; /// /// The release notes parser. /// /// /// Original from Cake build tool source: /// https://github.com/cake-build/cake/blob/9828d7b246d332054896e52ba56983822feb3f05/src/Cake.Common/ReleaseNotesParser.cs /// public sealed class ReleaseNotesParser { private readonly Regex _versionRegex; /// /// Initializes a new instance of the class. /// public ReleaseNotesParser() { _versionRegex = new Regex(@"(?\d+(\s*\.\s*\d+){0,3})(?-[a-z][0-9a-z-]*)?"); } /// /// Parses all release notes. /// /// The content. /// All release notes. public IReadOnlyList Parse(string content) { if (content == null) { throw new ArgumentNullException(nameof(content)); } var lines = content.SplitLines(); if (lines.Length > 0) { var line = lines[0].Trim(); if (line.StartsWith("#", StringComparison.OrdinalIgnoreCase)) { return ParseComplexFormat(lines); } if (line.StartsWith("*", StringComparison.OrdinalIgnoreCase)) { return ParseSimpleFormat(lines); } } throw new BuildAbortedException("Unknown release notes format."); } private IReadOnlyList ParseComplexFormat(string[] lines) { var lineIndex = 0; var result = new List(); while (true) { if (lineIndex >= lines.Length) { break; } // Create release notes. var semVer = SemVersion.Zero; var version = SemVersion.TryParse(lines[lineIndex], out semVer); if (!version) { throw new BuildAbortedException("Could not parse version from release notes header."); } var rawVersionLine = lines[lineIndex]; // Increase the line index. lineIndex++; // Parse content. var notes = new List(); while (true) { // Sanity checks. if (lineIndex >= lines.Length) { break; } if (lines[lineIndex].StartsWith("# ", StringComparison.OrdinalIgnoreCase)) { break; } // Get the current line. var line = (lines[lineIndex] ?? string.Empty).Trim(); if (!string.IsNullOrWhiteSpace(line)) { notes.Add(line); } lineIndex++; } result.Add(new ReleaseNotes(semVer, notes, rawVersionLine)); } return result.OrderByDescending(x => x.SemVersion).ToArray(); } private IReadOnlyList ParseSimpleFormat(string[] lines) { var lineIndex = 0; var result = new List(); while (true) { if (lineIndex >= lines.Length) { break; } // Trim the current line. var line = (lines[lineIndex] ?? string.Empty); if (string.IsNullOrWhiteSpace(line)) { lineIndex++; continue; } // Parse header. var semVer = SemVersion.Zero; var version = SemVersion.TryParse(lines[lineIndex], out semVer); if (!version) { throw new BuildAbortedException("Could not parse version from release notes header."); } // Parse the description. line = line.Substring(semVer.ToString().Length).Trim('-', ' '); // Add the release notes to the result. result.Add(new ReleaseNotes(semVer, new[] { line }, line)); lineIndex++; } return result.OrderByDescending(x => x.SemVersion).ToArray(); } } ================================================ FILE: nuke/SemVersion.cs ================================================ // Licensed to the .NET Foundation under one or more agreements. // The .NET Foundation licenses this file to you under the MIT license. // See the LICENSE file in the project root for more information. using System; using System.Globalization; using System.Text; using System.Text.RegularExpressions; /// /// Class for representing semantic versions. /// /// /// Original from Cake build tool source: /// https://github.com/cake-build/cake/blob/9828d7b246d332054896e52ba56983822feb3f05/src/Cake.Common/SemanticVersion.cs /// public class SemVersion : IComparable, IComparable, IEquatable { /// /// Gets the default version of a SemanticVersion. /// public static SemVersion Zero { get; } = new SemVersion(0, 0, 0, null, null, "0.0.0"); /// /// Regex property for parsing a semantic version number. /// public static readonly Regex SemVerRegex = new Regex( @"(?0|(?:[1-9]\d*))(?:\.(?0|(?:[1-9]\d*))(?:\.(?0|(?:[1-9]\d*)))?(?:\-(?[0-9A-Z\.-]+))?(?:\+(?[0-9A-Z\.-]+))?)?", RegexOptions.CultureInvariant | RegexOptions.ExplicitCapture | RegexOptions.IgnoreCase); /// /// Gets the major number of the version. /// public int Major { get; } /// /// Gets the minor number of the version. /// public int Minor { get; } /// /// Gets the patch number of the version. /// public int Patch { get; } /// /// Gets the prerelease of the version. /// public string PreRelease { get; } /// /// Gets the meta of the version. /// public string Meta { get; } /// /// Gets a value indicating whether semantic version is a prerelease or not. /// public bool IsPreRelease { get; } /// /// Gets a value indicating whether semantic version has meta or not. /// public bool HasMeta { get; } /// /// Gets the VersionString of the semantic version. /// public string VersionString { get; } /// /// Gets the AssemblyVersion of the semantic version. /// public Version AssemblyVersion { get; } /// /// Initializes a new instance of the class. /// /// Major number. /// Minor number. /// Patch number. /// Prerelease string. /// Meta string. public SemVersion(int major, int minor, int patch, string preRelease = null, string meta = null) : this(major, minor, patch, preRelease, meta, null) { } /// /// Initializes a new instance of the class. /// /// Major number. /// Minor number. /// Patch number. /// Prerelease string. /// Meta string. /// The complete version number. public SemVersion(int major, int minor, int patch, string preRelease, string meta, string versionString) { Major = major; Minor = minor; Patch = patch; AssemblyVersion = new Version(major, minor, patch); IsPreRelease = !string.IsNullOrEmpty(preRelease); HasMeta = !string.IsNullOrEmpty(meta); PreRelease = IsPreRelease ? preRelease : null; Meta = HasMeta ? meta : null; if (!string.IsNullOrEmpty(versionString)) { VersionString = versionString; } else { var sb = new StringBuilder(); sb.AppendFormat(CultureInfo.InvariantCulture, "{0}.{1}.{2}", Major, Minor, Patch); if (IsPreRelease) { sb.AppendFormat(CultureInfo.InvariantCulture, "-{0}", PreRelease); } if (HasMeta) { sb.AppendFormat(CultureInfo.InvariantCulture, "+{0}", Meta); } VersionString = sb.ToString(); } } /// /// Method which tries to parse a semantic version string. /// /// the version that should be parsed. /// the out parameter the parsed version should be stored in. /// Returns a boolean indicating if the parse was successful. public static bool TryParse(string version, out SemVersion semVersion) { semVersion = Zero; if (string.IsNullOrEmpty(version)) { return false; } var match = SemVerRegex.Match(version); if (!match.Success) { return false; } if (!int.TryParse( match.Groups["Major"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var major) || !int.TryParse( match.Groups["Minor"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var minor) || !int.TryParse( match.Groups["Patch"].Value, NumberStyles.Integer, CultureInfo.InvariantCulture, out var patch)) { return false; } semVersion = new SemVersion( major, minor, patch, match.Groups["PreRelease"]?.Value, match.Groups["Meta"]?.Value, version); return true; } /// /// Checks if two SemVersion objects are equal. /// /// the other SemVersion want to test equality to. /// A boolean indicating whether the objecst we're equal or not. public bool Equals(SemVersion other) { return other is object && Major == other.Major && Minor == other.Minor && Patch == other.Patch && string.Equals(PreRelease, other.PreRelease, StringComparison.OrdinalIgnoreCase) && string.Equals(Meta, other.Meta, StringComparison.OrdinalIgnoreCase); } /// /// Compares to SemVersion objects to and another. /// /// The SemVersion object we compare with. /// Return 0 if the objects are identical, 1 if the version is newer and -1 if the version is older. public int CompareTo(SemVersion other) { if (other is null) { return 1; } if (Equals(other)) { return 0; } if (Major > other.Major) { return 1; } if (Major < other.Major) { return -1; } if (Minor > other.Minor) { return 1; } if (Minor < other.Minor) { return -1; } if (Patch > other.Patch) { return 1; } if (Patch < other.Patch) { return -1; } if (IsPreRelease != other.IsPreRelease) { return other.IsPreRelease ? 1 : -1; } switch (StringComparer.InvariantCultureIgnoreCase.Compare(PreRelease, other.PreRelease)) { case 1: return 1; case -1: return -1; default: { return (string.IsNullOrEmpty(Meta) != string.IsNullOrEmpty(other.Meta)) ? string.IsNullOrEmpty(Meta) ? 1 : -1 : StringComparer.InvariantCultureIgnoreCase.Compare(Meta, other.Meta); } } } /// /// Compares to SemVersion objects to and another. /// /// The object we compare with. /// Return 0 if the objects are identical, 1 if the version is newer and -1 if the version is older. public int CompareTo(object obj) { return (obj is SemVersion semVersion) ? CompareTo(semVersion) : -1; } /// /// Equals-method for the SemVersion class. /// /// the other SemVersion want to test equality to. /// A boolean indicating whether the objecst we're equal or not. public override bool Equals(object obj) { return (obj is SemVersion semVersion) && Equals(semVersion); } /// /// Method for getting the hashcode of the SemVersion object. /// /// The hashcode of the SemVersion object. public override int GetHashCode() { unchecked { var hashCode = Major; hashCode = (hashCode * 397) ^ Minor; hashCode = (hashCode * 397) ^ Patch; hashCode = (hashCode * 397) ^ (PreRelease != null ? StringComparer.OrdinalIgnoreCase.GetHashCode(PreRelease) : 0); hashCode = (hashCode * 397) ^ (Meta != null ? StringComparer.OrdinalIgnoreCase.GetHashCode(Meta) : 0); return hashCode; } } /// /// Returns the string representation of an SemVersion object. /// /// The string representation of the object. public override string ToString() { int[] verParts = { Major, Minor, Patch }; string ver = string.Join(".", verParts); return $"{ver}{(IsPreRelease ? "-" : string.Empty)}{PreRelease}{Meta}"; } /// /// The greater than-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was greater than operand2. public static bool operator >(SemVersion operand1, SemVersion operand2) => operand1 is { } && operand1.CompareTo(operand2) == 1; /// /// The less than-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was less than operand2. public static bool operator <(SemVersion operand1, SemVersion operand2) => operand1 is { } ? operand1.CompareTo(operand2) == -1 : operand2 is { }; /// /// The greater than or equal to-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was greater than or equal to operand2. public static bool operator >=(SemVersion operand1, SemVersion operand2) => operand1 is { } ? operand1.CompareTo(operand2) >= 0 : operand2 is null; /// /// The lesser than or equal to-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was lesser than or equal to operand2. public static bool operator <=(SemVersion operand1, SemVersion operand2) => operand1 is null || operand1.CompareTo(operand2) <= 0; /// /// The equal to-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was equal to operand2. public static bool operator ==(SemVersion operand1, SemVersion operand2) => operand1?.Equals(operand2) ?? operand2 is null; /// /// The not equal to-operator for the SemVersion class. /// /// first SemVersion. /// second. SemVersion. /// A value indicating if the operand1 was not equal to operand2. public static bool operator !=(SemVersion operand1, SemVersion operand2) => !(operand1?.Equals(operand2) ?? operand2 is null); } ================================================ FILE: nuke/_build.csproj ================================================ Exe net10.0 CS0649;CS0169 .. .. 1 ================================================ FILE: src/.editorconfig ================================================ [*.cs] # CA1416: Validate platform compatibility dotnet_diagnostic.CA1416.severity = error ================================================ FILE: src/ElectronNET/.electron/.gitkeep ================================================ ================================================ FILE: src/ElectronNET/ElectronNET.csproj ================================================  net6.0;net8.0;net10.0 ..\..\artifacts $(PackageNamePrefix) $(PackageId) $(DescriptionFirstPart) This package contains the ElectronNET project system. false false disable .electron\%(RecursiveDir)%(FileName)%(Extension) Never true .electron\ true build\ True MSBuild:Compile MSBuild:Compile ================================================ FILE: src/ElectronNET/build/ElectronNET.Core.props ================================================ 30.4.0 26.0 win-x64 true $(MSBuildProjectName.Replace(".", "-").ToLower()) electron-builder.json $(MSBuildProjectName) false false false $(MSBuildThisFileDirectory)ElectronNET.LateImport.targets $(CollectUpToDateCheckBuiltDesignTimeDependsOn);ElectronCollectUpToDateCheckBuiltDesignTime $(FileSystemPublishDependsOn);ElectronFileSystemPublishClearItems ================================================ FILE: src/ElectronNET/build/ElectronNET.Core.targets ================================================ win $(Title) $(ElectronPackageId) <_IsMsAspNetProject>False <_IsMsAspNetProject Condition="'$(UsingMicrosoftNETSdkWeb)' == 'true'">True $(ElectronPackageId) ================================================ FILE: src/ElectronNET/build/ElectronNET.DesignTime.targets ================================================ True Project Project $(ElectronSplashScreen.Replace('$(MSBuildProjectDirectory)', '').TrimStart('\')) $(ElectronIcon.Replace('$(MSBuildProjectDirectory)', '').TrimStart('\')) <_ProjectDir>$([System.IO.Path]::GetFullPath('$(MSBuildProjectDirectory)'))\ $([System.String]::Substring($(ElectronSplashScreen), $([System.String]::Length($(_ProjectDir))))) ================================================ FILE: src/ElectronNET/build/ElectronNET.LateImport.targets ================================================ Never Never Never Never Never Never $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)\..\..\ElectronNET.Host')) $([System.IO.Path]::GetFullPath('$(MSBuildThisFileDirectory)\..\.electron')) .electron $([System.IO.Path]::GetFileName($(ElectronSplashScreen))) $([System.IO.Path]::GetFileName($(ElectronIcon))) $(OutDir)$(ElectronDirName)\ $(TargetDir)$(ElectronDirName)\ $(IntermediateOutputPath)$(ElectronDirName)\ $(ElectronIntermediateOutputPath)package.json <_ProjectPropertiesFolder>$(MSBuildProjectDirectory)\Properties\ <_ElectronBuilderExpectedPath>$(_ProjectPropertiesFolder)$(ElectronBuilderJson) <_NeedCopyElectronBuilderFile>True <_NeedCopyElectronBuilderFile Condition="Exists($(_ElectronBuilderExpectedPath))">False true $(TargetName) $([System.Text.RegularExpressions.Regex]::Replace('$(Version)', '^(\d+\.\d+\.\d+)(?:\.\d+)?(.*)$', '$1$2')) linux $(Title) $(Title.Replace(' ', '-')) <_NonIntermediatePublishDir>$(PublishDir) $(PublishDir) $(IntermediateOutputPath)PubTmp\ false true $(ElectronDirName)\%(RecursiveDir)%(FileName)%(Extension) PreserveNewest $(ElectronDirName)\%(RelativeDir)%(FileName)%(Extension) $(ElectronDirName)\%(FileName)%(Extension) $(ElectronDirName)\%(DestinationRelativePath) $(ElectronDirName)\%(DestinationRelativePath) PreserveNewest <_ElectronFiles Include="$(ElectronSplashScreen)" Condition="'$(ElectronSplashScreen)'!=''" /> <_ElectronFiles Include="$(ElectronIcon)" Condition="'$(ElectronIcon)'!=''" /> <_ElectronFiles Update="**"> PreserveNewest <_ElectronFilesToCopy Include="@(_ElectronFiles->'%(FullPath)')" /> <_ElectronFilesToCopyWithTargetPath Include="@(_ElectronFilesToCopy)"> $(ElectronDirName)\%(FileName)%(Extension) <_SourceItemsToCopyToOutputDirectoryIfDifferent Include="@(_ElectronFilesToCopyWithTargetPath)"/> $(OutDir)$(ElectronDirName)\node_modules\electron-host-hook x64 ia32 arm64 x64 armv7l arm64 x64 arm64 win linux mac win32 linux darwin $(ElectronArch) arm <_CurrentOSPlatform Condition="$([MSBuild]::IsOSPlatform('Windows'))">win <_CurrentOSPlatform Condition="$([MSBuild]::IsOSPlatform('Linux'))">linux <_CurrentOSPlatform Condition="$([MSBuild]::IsOSPlatform('OSX'))">mac false true <_IsCrossCompileAllowed>false <_IsCrossCompileAllowed Condition="'$(_CurrentOSPlatform)' == 'win' AND '$(ElectronPlatform)' == 'linux' AND '$(IsLinuxWsl)' == 'true'">true <_IsPlatformMismatch>false <_IsPlatformMismatch Condition="'$(_CurrentOSPlatform)' != '$(ElectronPlatform)' AND '$(_IsCrossCompileAllowed)' != 'true'">true $([System.IO.Path]::GetFullPath('$(ElectronOutDir)')) <_NpmCmd>npm install --no-bin-links <_NpmCmd Condition="'$(_IsPlatformMismatch)' == 'true'">$(_NpmCmd) --os=$(NpmOs) --cpu=$(NpmCpu) --arch=$(NpmCpu) --platform=$(NpmOs) <_NpmCmd Condition="'$(IsLinuxWsl)' == 'true'">wsl bash -ic '$(_NpmCmd)' <_ElectronFrameworksDir>$(ElectronOutDir)node_modules\electron\dist\Electron.app\Contents\Frameworks <_ElectronFrameworkDirs Include="$(_ElectronFrameworksDir)\Electron Framework.framework" /> <_ElectronFrameworkDirs Include="$(_ElectronFrameworksDir)\Mantle.framework" /> <_ElectronFrameworkDirs Include="$(_ElectronFrameworksDir)\ReactiveObjC.framework" /> <_ElectronFrameworkDirs Include="$(_ElectronFrameworksDir)\Squirrel.framework" /> <_OriginalPublishDir>$(PublishDir) $(_OriginalPublishDir)bin\ true <_PublishIntermediateOutputPathFiles Remove="@(_PublishIntermediateOutputPathFiles)"> <_ElectronPublishAppAfterTarget Condition="'$(UsingMicrosoftNETSdkWeb)' == 'true'">AfterPublish <_ElectronPublishAppAfterTarget Condition="'$(UsingMicrosoftNETSdkWeb)' != 'true'">Publish $(_OriginalPublishDir) $(_NonIntermediatePublishDir) $(_OriginalPublishDir) $(ElectronPublishDir)%(RecursiveDir)%(FileName)%(Extension) $([System.IO.Path]::GetFullPath('$(ElectronPublishDir)')) $([System.IO.Path]::GetFullPath('$(PublishUrl.TrimEnd("\"))')) false true <_NpmCmd>npm install electron-builder@$(ElectronBuilderVersion) --save-dev <_NpmCmd Condition="'$(IsLinuxWsl)' == 'true'">wsl bash -ic '$(_NpmCmd)' $(ElectronPaParams) -c.appId "$(ElectronPackageId)" $(ElectronPaParams) -c.buildVersion "$(Version)" $(ElectronPaParams) -c.copyright "$(Copyright)" $(ElectronPaParams) -c.extraResources "bin/**/*" <_NpxCmd>npx electron-builder --config=./$(ElectronBuilderJson) --$(ElectronPlatform) --$(ElectronArch) -c.electronVersion=$(ElectronVersion) -c.directories.output "$(ElectronPublishUrlFullPath)" $(ElectronPaParams) <_NpxCmd Condition="'$(IsLinuxWsl)' == 'true'">wsl bash -ic '$(_NpxCmd)' ================================================ FILE: src/ElectronNET/build/ElectronNET.MigrationChecks.targets ================================================ ElectronCheckNoPackageJson; ElectronCheckRootPackageJsonNoElectron; ElectronCheckRootPackageJsonNotCopied; ElectronCheckNoManifestJson; ElectronCheckElectronBuilderJson; ElectronCheckNoParentPaths; ElectronCheckPubxmlFiles <_InvalidPackageJson Include="$(MSBuildProjectDirectory)\**\package.json" Exclude="$(MSBuildProjectDirectory)\package.json; $(MSBuildProjectDirectory)\ElectronHostHook\**\package.json; $(MSBuildProjectDirectory)\bin\**\package.json; $(MSBuildProjectDirectory)\obj\**\package.json; $(MSBuildProjectDirectory)\publish\**\package.json; $(MSBuildProjectDirectory)\node_modules\**\package.json" /> <_InvalidPackageLockJson Include="$(MSBuildProjectDirectory)\**\package-lock.json" Exclude="$(MSBuildProjectDirectory)\ElectronHostHook\**\package-lock.json; $(MSBuildProjectDirectory)\bin\**\package-lock.json; $(MSBuildProjectDirectory)\obj\**\package-lock.json; $(MSBuildProjectDirectory)\publish\**\package-lock.json; $(MSBuildProjectDirectory)\node_modules\**\package-lock.json" /> <_HasInvalidPackageJson>false <_HasInvalidPackageJson Condition="@(_InvalidPackageJson->Count()) > 0 OR @(_InvalidPackageLockJson->Count()) > 0">true <_RootPackageJsonLines Include="$([System.IO.File]::ReadAllLines('$(MSBuildProjectDirectory)\package.json'))" /> <_RootPackageJsonContent>@(_RootPackageJsonLines, ' ') <_RootPackageJsonHasElectron>false <_RootPackageJsonHasElectron Condition="$([System.Text.RegularExpressions.Regex]::IsMatch('$(_RootPackageJsonContent)', 'electron', System.Text.RegularExpressions.RegexOptions.IgnoreCase))">true <_RootPackageJsonFile Include="@(Content);@(None)" Condition="'%(Identity)' == 'package.json' OR '%(Identity)' == '$(MSBuildProjectDirectory)\package.json'" /> <_RootPackageJsonIsCopied>false <_RootPackageJsonIsCopied Condition="'@(_RootPackageJsonFile)' != '' AND ( '%(_RootPackageJsonFile.CopyToOutputDirectory)' != '' OR '%(_RootPackageJsonFile.CopyToPublishDirectory)' != '' )">true <_InvalidManifestJson Include="$(MSBuildProjectDirectory)\**\electron.manifest.json;$(MSBuildProjectDirectory)\**\electron-manifest.json" Exclude="$(MSBuildProjectDirectory)\bin\**\*; $(MSBuildProjectDirectory)\obj\**\*; $(MSBuildProjectDirectory)\publish\**\*; $(MSBuildProjectDirectory)\node_modules\**\*" /> <_HasInvalidManifestJson>false <_HasInvalidManifestJson Condition="@(_InvalidManifestJson->Count()) > 0">true <_ElectronBuilderJsonInProperties Include="$(MSBuildProjectDirectory)\Properties\electron-builder.json" /> <_HasElectronBuilderJsonInProperties>false <_HasElectronBuilderJsonInProperties Condition="Exists('$(MSBuildProjectDirectory)\Properties\electron-builder.json')">true <_ElectronBuilderJsonWrongLocation Include="$(MSBuildProjectDirectory)\**\electron-builder.json" Exclude="$(MSBuildProjectDirectory)\Properties\electron-builder.json; $(MSBuildProjectDirectory)\bin\**\*; $(MSBuildProjectDirectory)\obj\**\*; $(MSBuildProjectDirectory)\publish\**\*; $(MSBuildProjectDirectory)\node_modules\**\*" /> <_HasElectronBuilderJsonWrongLocation>false <_HasElectronBuilderJsonWrongLocation Condition="@(_ElectronBuilderJsonWrongLocation->Count()) > 0">true <_ElectronBuilderJsonPath>$(MSBuildProjectDirectory)\Properties\electron-builder.json <_ElectronBuilderJsonContent>@(_ElectronBuilderJsonLines, ' ') <_HasParentPathReference>false <_HasParentPathReference Condition="$(_ElectronBuilderJsonContent.Contains('../')) OR $(_ElectronBuilderJsonContent.Contains('..\\'))" >true <_PubxmlFiles Include="$(MSBuildProjectDirectory)\Properties\PublishProfiles\*.pubxml" /> <_IsAspNetProject>false <_IsAspNetProject Condition="'$(UsingMicrosoftNETSdkWeb)' == 'true'">true <_HasPubxmlFiles>false <_HasPubxmlFiles Condition="@(_PubxmlFiles->Count()) > 0">true <_PubxmlFileInfo Include="@(_PubxmlFiles)" Condition="'%(Identity)' != ''"> $([System.IO.File]::ReadAllText('%(Identity)')) <_PubxmlFileInfoWithFlags Include="@(_PubxmlFileInfo)" Condition="'%(Identity)' != ''"> $([System.Text.RegularExpressions.Regex]::IsMatch('%(FileContent)', '<WebPublishMethod>')) <_AspNetMissingWebPublishMethod Include="@(_PubxmlFileInfoWithFlags)" Condition="'$(_IsAspNetProject)' == 'true' AND '%(HasWebPublishMethod)' == 'False'" /> <_ConsolePubxmlWithAspNetProperties Include="@(_PubxmlFileInfoWithFlags)" Condition="'$(_IsAspNetProject)' != 'true' AND '%(HasWebPublishMethod)' == 'True'" /> ================================================ FILE: src/ElectronNET/build/ElectronNETRules.Project.xaml ================================================ ================================================ FILE: src/ElectronNET/build/ElectronNETRules.Project2.xaml ================================================ ================================================ FILE: src/ElectronNET/build/electron-builder.json ================================================ { "$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json", "compression": "maximum", "linux": { "target": [ "tar.xz" ], "executableArgs": [ "--no-sandbox" ], "artifactName": "${name}-${arch}-${version}.${ext}" }, "win": { "target": [ { "target": "portable", "arch": "x64" } ] } } ================================================ FILE: src/ElectronNET/build/package.template.json ================================================ { "name": "$(ElectronPackageId)", "productName": "$(ElectronTitle)", "build": { "appId": "$(ElectronPackageId)", "linux": { "desktop": { "entry": { "Name": "$(Title)" } }, "executableName": "$(ElectronPackageId)" }, "deb": { "desktop": { "entry": { "Name": "$(Title)" } } } }, "description": "$(Description)", "version": "$(Version)", "main": "main.js", "author": { "name": "$(Company)" }, "license": "$(License)", "executable": "$(TargetName)", "singleInstance": $(ElectronSingleInstance), "homepage": "$(ProjectUrl)", "splashscreen": { "imageFile": "$(ElectronSplashScreen)" }, "scripts": { "start": "tsc -p ." }, "dependencies": { "dasherize": "^2.0.0", "electron-updater": "^6.6.2", "image-size": "^1.2.1", "portscanner": "^2.2.0", "socket.io": "^4.8.1", "electron-host-hook": "file:./ElectronHostHook" }, "devDependencies": { "@types/node": "^22.18", "electron": "$(ElectronVersion)", "eslint": "^9.37.0", "typescript": "^5.9.3" } } ================================================ FILE: src/ElectronNET/build/update_electron_versions.py ================================================ #!/usr/bin/env python3 """ Update Electron version list in ElectronNETRules.Project.xaml This script: 1. Downloads the Electron releases feed from GitHub 2. Filters for stable releases >= 23.0.0 3. Generates the ElectronVersion enum XML 4. Updates the XAML file with the new version list """ import json import re import urllib.request from pathlib import Path def download_releases(): """Download Electron releases JSON from GitHub.""" url = "https://releases.electronjs.org/releases.json" print(f"Downloading releases from {url}...") with urllib.request.urlopen(url) as response: data = response.read() print(f"Downloaded {len(data)} bytes") return json.loads(data) def filter_versions(releases, min_version="23.0.0"): """Filter and sort stable Electron versions.""" print(f"Filtering versions >= {min_version}...") # Regular expression for stable versions (major.minor.patch) stable_pattern = re.compile(r'^\d+\.\d+\.\d+$') # Parse minimum version min_parts = tuple(map(int, min_version.split('.'))) # Filter and collect versions versions = set() for release in releases: version = release.get('version', '') if stable_pattern.match(version): parts = tuple(map(int, version.split('.'))) if parts >= min_parts: versions.add(version) # Sort versions sorted_versions = sorted(versions, key=lambda v: tuple(map(int, v.split('.')))) print(f"Found {len(sorted_versions)} stable versions") return sorted_versions def generate_enum_xml(versions): """Generate the ElectronVersion enum property XML.""" lines = [ ' ', ' ', ] for version in versions: lines.append(f' ') lines.append(' ') return '\n'.join(lines) def update_xaml_file(xaml_path, enum_xml): """Update the XAML file with the new enum.""" print(f"Updating {xaml_path}...") # Read the original file content = Path(xaml_path).read_text(encoding='utf-8') # Find the ElectronVersion enum markers start_marker = ' invocators; private readonly ConcurrentDictionary invocationEventNames = new(); private readonly ConcurrentDictionary invocationMessageNames = new(); private readonly ConcurrentDictionary methodMessageNames = new(); private static readonly ConcurrentDictionary eventContainers = new(); private static readonly ConcurrentDictionary> AllInvocators = new(); private readonly object objLock = new object(); public virtual int Id { get => -1; // ReSharper disable once ValueParameterNotUsed protected set { } } protected abstract SocketTaskEventNameTypes SocketTaskEventNameType { get; } protected virtual SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.NoDashUpperFirst; protected virtual SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; protected ApiBase() { this.objectName = this.GetType().Name.LowerFirst(); this.invocators = AllInvocators.GetOrAdd(this.objectName, _ => new ConcurrentDictionary()); } protected void CallMethod0([CallerMemberName] string callerName = null) { var messageName = this.methodMessageNames.GetOrAdd(callerName, s => this.objectName + s); if (this.Id >= 0) { BridgeConnector.Socket.Emit(messageName, this.Id); } else { BridgeConnector.Socket.Emit(messageName); } } protected void CallMethod1(object val1, [CallerMemberName] string callerName = null) { var messageName = this.methodMessageNames.GetOrAdd(callerName, s => this.objectName + s); if (this.Id >= 0) { BridgeConnector.Socket.Emit(messageName, this.Id, val1); } else { BridgeConnector.Socket.Emit(messageName, val1); } } protected void CallMethod2(object val1, object val2, [CallerMemberName] string callerName = null) { var messageName = this.methodMessageNames.GetOrAdd(callerName, s => this.objectName + s); if (this.Id >= 0) { BridgeConnector.Socket.Emit(messageName, this.Id, val1, val2); } else { BridgeConnector.Socket.Emit(messageName, val1, val2); } } protected void CallMethod3(object val1, object val2, object val3, [CallerMemberName] string callerName = null) { var messageName = this.methodMessageNames.GetOrAdd(callerName, s => this.objectName + s); if (this.Id >= 0) { BridgeConnector.Socket.Emit(messageName, this.Id, val1, val2, val3); } else { BridgeConnector.Socket.Emit(messageName, val1, val2, val3); } } protected Task InvokeAsync(object arg = null, [CallerMemberName] string callerName = null) { return this.InvokeAsyncWithTimeout(InvocationTimeout, arg, callerName); } protected Task InvokeAsyncWithTimeout(TimeSpan invocationTimeout, object arg = null, [CallerMemberName] string callerName = null) { Debug.Assert(callerName != null, nameof(callerName) + " != null"); lock (this.objLock) { return this.invocators.GetOrAdd(callerName, _ => { var getter = new Invocator(this, callerName, invocationTimeout, arg); getter.Task().ContinueWith(_ => { lock (this.objLock) { return this.invocators.TryRemove(callerName, out var _); } }); return getter; }).Task(); } } protected void AddEvent(Action value, int? id = null, [CallerMemberName] string callerName = null) { Debug.Assert(callerName != null, nameof(callerName) + " != null"); var eventName = this.EventName(callerName); var eventKey = this.EventKey(eventName, id); lock (this.objLock) { var container = eventContainers.GetOrAdd(eventKey, _ => { var container = new EventContainer(); BridgeConnector.Socket.On(eventKey, container.OnEventAction); BridgeConnector.Socket.Emit($"register-{eventName}", id); return container; }); container.Register(value); } } protected void RemoveEvent(Action value, int? id = null, [CallerMemberName] string callerName = null) { Debug.Assert(callerName != null, nameof(callerName) + " != null"); var eventName = this.EventName(callerName); var eventKey = this.EventKey(eventName, id); lock (this.objLock) { if (eventContainers.TryGetValue(eventKey, out var container) && !container.Unregister(value)) { BridgeConnector.Socket.Off(eventKey); eventContainers.TryRemove(eventKey, out _); } } } protected void AddEvent(Action value, int? id = null, [CallerMemberName] string callerName = null) { Debug.Assert(callerName != null, nameof(callerName) + " != null"); var eventName = this.EventName(callerName); var eventKey = this.EventKey(eventName, id); lock (this.objLock) { var container = eventContainers.GetOrAdd(eventKey, _ => { var container = new EventContainer(); BridgeConnector.Socket.On(eventKey, container.OnEventActionT); BridgeConnector.Socket.Emit($"register-{eventName}", id); return container; }); container.Register(value); } } protected void RemoveEvent(Action value, int? id = null, [CallerMemberName] string callerName = null) { Debug.Assert(callerName != null, nameof(callerName) + " != null"); var eventName = this.EventName(callerName); var eventKey = this.EventKey(eventName, id); lock (this.objLock) { if (eventContainers.TryGetValue(eventKey, out var container) && !container.Unregister(value)) { BridgeConnector.Socket.Off(eventKey); eventContainers.TryRemove(eventKey, out _); } } } private string EventName(string callerName) { switch (this.SocketEventNameType) { case SocketEventNameTypes.DashedLower: return $"{this.objectName}-{callerName.ToDashedEventName()}"; case SocketEventNameTypes.CamelCase: return $"{this.objectName}-{callerName.ToCamelCaseEventName()}"; default: throw new ArgumentOutOfRangeException(); } } private string EventKey(string eventName, int? id) { return string.Format(CultureInfo.InvariantCulture, "{0}{1:D}", eventName, id); } internal abstract class Invocator { public abstract Task Task(); } internal class Invocator : Invocator { private readonly Task tcsTask; private TaskCompletionSource tcs; public Invocator(ApiBase apiBase, string callerName, TimeSpan timeout, object arg = null) { this.tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); this.tcsTask = this.tcs.Task; string eventName; string messageName; switch (apiBase.SocketTaskEventNameType) { case SocketTaskEventNameTypes.DashesLowerFirst: eventName = apiBase.invocationEventNames.GetOrAdd(callerName, s => $"{apiBase.objectName}-{s.StripAsync().LowerFirst()}-completed"); break; case SocketTaskEventNameTypes.NoDashUpperFirst: eventName = apiBase.invocationEventNames.GetOrAdd(callerName, s => $"{apiBase.objectName}{s.StripAsync()}Completed"); break; default: throw new ArgumentOutOfRangeException(); } switch (apiBase.SocketTaskMessageNameType) { case SocketTaskMessageNameTypes.DashesLowerFirst: messageName = apiBase.invocationMessageNames.GetOrAdd(callerName, s => $"{apiBase.objectName}-{s.StripAsync().LowerFirst()}"); break; case SocketTaskMessageNameTypes.NoDashUpperFirst: messageName = apiBase.invocationMessageNames.GetOrAdd(callerName, s => apiBase.objectName + s.StripAsync()); break; default: throw new ArgumentOutOfRangeException(); } BridgeConnector.Socket.Once(eventName, (result) => { lock (this) { try { var value = result; this.tcs?.SetResult(value); } catch (Exception ex) { this.tcs?.TrySetException(ex); } finally { this.tcs = null; } } }); if (arg != null) { _ = apiBase.Id >= 0 ? BridgeConnector.Socket.Emit(messageName, apiBase.Id, arg) : BridgeConnector.Socket.Emit(messageName, arg); } else { _ = apiBase.Id >= 0 ? BridgeConnector.Socket.Emit(messageName, apiBase.Id) : BridgeConnector.Socket.Emit(messageName); } System.Threading.Tasks.Task.Delay(timeout).ContinueWith(_ => { if (this.tcs != null) { lock (this) { if (this.tcs != null) { var ex = new TimeoutException( $"No response after {(long)timeout.TotalMilliseconds}ms trying to retrieve value {apiBase.objectName}.{callerName}()" ); this.tcs.TrySetException(ex); this.tcs = null; } } } }); } public override Task Task() { return this.tcsTask as Task; } } [SuppressMessage("ReSharper", "InconsistentlySynchronizedField")] private class EventContainer { private Action eventAction; private Delegate eventActionT; private Action GetEventActionT() { return (Action)this.eventActionT; } private void SetEventActionT(Action actionT) { this.eventActionT = actionT; } public void OnEventAction() => this.eventAction?.Invoke(); public void OnEventActionT(T p) => this.GetEventActionT()?.Invoke(p); public void Register(Action receiver) { this.eventAction += receiver; } public void Register(Action receiver) { var actionT = this.GetEventActionT(); actionT += receiver; this.SetEventActionT(actionT); } public bool Unregister(Action receiver) { this.eventAction -= receiver; return this.eventAction != null; } public bool Unregister(Action receiver) { var actionT = this.GetEventActionT(); actionT -= receiver; this.SetEventActionT(actionT); return actionT != null; } } } } ================================================ FILE: src/ElectronNET.API/API/App.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Extensions; using System; using System.Runtime.InteropServices; using System.Runtime.Versioning; using System.Text.Json; using System.Threading; using System.Threading.Tasks; // ReSharper disable InconsistentNaming namespace ElectronNET.API { /// /// Control your application's event lifecycle. /// public sealed class App : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.NoDashUpperFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Emitted when all windows have been closed. /// /// If you do not subscribe to this event and all windows are closed, the default behavior is to quit /// the app; however, if you subscribe, you control whether the app quits or not.If the user pressed /// Cmd + Q, or the developer called , Electron will first try to close all the windows /// and then emit the event, and in this case the event /// would not be emitted. /// public event Action WindowAllClosed { add { if (_windowAllClosed == null) { BridgeConnector.Socket.On("app-window-all-closed" + GetHashCode(), () => { if (!Electron.WindowManager.IsQuitOnWindowAllClosed || RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { _windowAllClosed(); } }); BridgeConnector.Socket.Emit("register-app-window-all-closed", GetHashCode()); } _windowAllClosed += value; } remove { _windowAllClosed -= value; if (_windowAllClosed == null) BridgeConnector.Socket.Off("app-window-all-closed" + GetHashCode()); } } private event Action _windowAllClosed; /// /// Emitted before the application starts closing its windows. /// /// Note: If application quit was initiated by then /// is emitted after emitting close event on all windows and closing them. /// /// Note: On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout. /// public event Func BeforeQuit { add { if (_beforeQuit == null) { BridgeConnector.Socket.On("app-before-quit" + GetHashCode(), async () => { await this._beforeQuit(new QuitEventArgs()).ConfigureAwait(false); if (_preventQuit) { _preventQuit = false; } else { if (_willQuit == null && _quitting == null) { Exit(); } else if (_willQuit != null) { await this._willQuit(new QuitEventArgs()).ConfigureAwait(false); if (_preventQuit) { _preventQuit = false; } else { if (_quitting == null) { Exit(); } else { await this._quitting().ConfigureAwait(false); Exit(); } } } else if (_quitting != null) { await this._quitting().ConfigureAwait(false); Exit(); } } }); BridgeConnector.Socket.Emit("register-app-before-quit", GetHashCode()); } _beforeQuit += value; } remove { _beforeQuit -= value; if (_beforeQuit == null) BridgeConnector.Socket.Off("app-before-quit" + GetHashCode()); } } private event Func _beforeQuit; /// /// Emitted when all windows have been closed and the application will quit. /// /// See the description of the event for the differences between the /// and events. /// /// Note: On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout. /// public event Func WillQuit { add { if (_willQuit == null) { BridgeConnector.Socket.On("app-will-quit" + GetHashCode(), async () => { await this._willQuit(new QuitEventArgs()).ConfigureAwait(false); if (_preventQuit) { _preventQuit = false; } else { if (_quitting == null) { Exit(); } else { await this._quitting().ConfigureAwait(false); Exit(); } } }); BridgeConnector.Socket.Emit("register-app-will-quit", GetHashCode()); } _willQuit += value; } remove { _willQuit -= value; if (_willQuit == null) BridgeConnector.Socket.Off("app-will-quit" + GetHashCode()); } } private event Func _willQuit; /// /// Emitted when the application is quitting. /// /// Note: On Windows, this event will not be emitted if the app is closed due to a shutdown/restart of the system or a user logout. /// public event Func Quitting { add { if (_quitting == null) { BridgeConnector.Socket.On("app-will-quit" + GetHashCode() + "quitting", async () => { if (_willQuit == null) { await this._quitting().ConfigureAwait(false); Exit(); } }); BridgeConnector.Socket.Emit("register-app-will-quit", GetHashCode() + "quitting"); } _quitting += value; } remove { _quitting -= value; if (_quitting == null) BridgeConnector.Socket.Off("app-will-quit" + GetHashCode() + "quitting"); } } private event Func _quitting; /// /// Emitted when a blurred. /// public event Action BrowserWindowBlur { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when a gets focused. /// public event Action BrowserWindowFocus { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when a new is created. /// public event Action BrowserWindowCreated { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when a new is created. /// public event Action WebContentsCreated { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when Chrome’s accessibility support changes. This event fires when assistive technologies, such as /// screen readers, are enabled or disabled. See https://www.chromium.org/developers/design-documents/accessibility for more details. /// /// when Chrome's accessibility support is enabled, otherwise. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action AccessibilitySupportChanged { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when the application has finished basic startup. /// public event Action Ready { add { if (IsReady) { value(); } _ready += value; } remove { _ready -= value; } } private event Action _ready; /// /// Application host fully started. /// public bool IsReady { get { return _isReady; } internal set { _isReady = value; if (value) { _ready?.Invoke(); } } } private bool _isReady = false; /// /// Emitted when a MacOS user wants to open a file with the application. The open-file event is usually emitted /// when the application is already open and the OS wants to reuse the application to open the file. /// open-file is also emitted when a file is dropped onto the dock and the application is not yet running. /// /// On Windows, you have to parse the arguments using App.CommandLine to get the filepath. /// [SupportedOSPlatform("macOS")] public event Action OpenFile { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when a MacOS user wants to open a URL with the application. Your application's Info.plist file must /// define the URL scheme within the CFBundleURLTypes key, and set NSPrincipalClass to AtomApplication. /// [SupportedOSPlatform("macOS")] public event Action OpenUrl { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// A property that indicates the current application's name, which is the name in the /// application's package.json file. /// /// Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You /// should usually also specify a productName field, which is your application's full capitalized name, and /// which will be preferred over name by Electron. /// public string Name { [Obsolete("Use the asynchronous version NameAsync instead")] get { return NameAsync.Result; } set { BridgeConnector.Socket.Emit("appSetName", value); } } /// /// A property that indicates the current application's name, which is the name in the /// application's package.json file. /// /// Usually the name field of package.json is a short lowercase name, according to the npm modules spec. You /// should usually also specify a productName field, which is your application's full capitalized name, and /// which will be preferred over name by Electron. /// public Task NameAsync { get { return this.InvokeAsync(); } } internal App() { CommandLine = new CommandLine(); } internal static App Instance { get { if (_app == null) { lock (_syncRoot) { if (_app == null) { _app = new App(); } } } return _app; } } private static App _app; private static object _syncRoot = new object(); /// /// Try to close all windows. The event will be emitted first. If all windows are successfully /// closed, the event will be emitted and by default the application will terminate. This method /// guarantees that all beforeunload and unload event handlers are correctly executed. It is possible /// that a window cancels the quitting by returning in the beforeunload event handler. /// public void Quit() { this.CallMethod0(); } /// /// All windows will be closed immediately without asking user and the and /// events will not be emitted. /// /// Exits immediately with exitCode. exitCode defaults to 0. public void Exit(int exitCode = 0) { this.CallMethod1(exitCode); } public void DisposeSocket() { BridgeConnector.Socket.Dispose(); } /// /// Relaunches the app when current instance exits. By default the new instance will use the same working directory /// and command line arguments with current instance. /// /// Note that this method does not quit the app when executed, you have to call or /// after calling to make the app restart. /// /// When is called for multiple times, multiple instances will be started after current instance /// exited. /// public void Relaunch() { this.CallMethod0(); } /// /// Relaunches the app when current instance exits. By default the new instance will use the same working directory /// and command line arguments with current instance. When is specified, the /// will be passed as command line arguments instead. When /// is specified, the will be executed for relaunch instead of current app. /// /// Note that this method does not quit the app when executed, you have to call or /// after calling to make the app restart. /// /// When is called for multiple times, multiple instances will be started after current instance /// exited. /// /// Options for the relaunch. public void Relaunch(RelaunchOptions relaunchOptions) { this.CallMethod1(relaunchOptions); } /// /// On Linux, focuses on the first visible window. On macOS, makes the application the active app. On Windows, focuses /// on the application's first window. /// public void Focus() { this.CallMethod0(); } /// /// On Linux, focuses on the first visible window. On macOS, makes the application the active app. On Windows, focuses /// on the application's first window. /// /// You should seek to use the option as sparingly as possible. /// public void Focus(FocusOptions focusOptions) { this.CallMethod1(focusOptions); } /// /// Hides all application windows without minimizing them. /// [SupportedOSPlatform("macOS")] public void Hide() { this.CallMethod0(); } /// /// Shows application windows after they were hidden. Does not automatically focus them. /// [SupportedOSPlatform("macOS")] public void Show() { this.CallMethod0(); } /// /// The current application directory. /// public async Task GetAppPathAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Sets or creates a directory your app's logs which can then be manipulated with /// or . /// /// Calling without a path parameter will result in this directory being set to /// ~/Library/Logs/YourAppName on macOS, and inside the userData directory on Linux and Windows. /// /// A custom path for your logs. Must be absolute. public void SetAppLogsPath(string path) { this.CallMethod1(path); } /// /// The path to a special directory. If is called without called /// being called first, a default directory will be created equivalent /// to calling without a path parameter. /// /// Special directory. /// The cancellation token. /// A path to a special directory or file associated with name. public async Task GetPathAsync(PathName pathName, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appGetPathCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appGetPath", pathName); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Overrides the path to a special directory or file associated with name. If the path specifies a directory /// that does not exist, an Error is thrown. In that case, the directory should be created with fs.mkdirSync or similar. /// /// You can only override paths of a name defined in . /// /// By default, web pages' cookies and caches will be stored under the directory. If you /// want to change this location, you have to override the path before the /// event of the module is emitted. /// Special directory. /// New path to a special directory. /// public void SetPath(PathName name, string path) { this.CallMethod2(name, path); } /// /// The version of the loaded application. If no version is found in the application’s package.json file, /// the version of the current bundle or executable is returned. /// /// The version of the loaded application. public async Task GetVersionAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// The current application locale. Possible return values are documented here. /// /// Note: When distributing your packaged app, you have to also ship the locales folder. /// /// Note: On Windows, you have to call it after the events gets emitted. /// /// The current application locale. public async Task GetLocaleAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Adds path to the recent documents list. This list is managed by the OS. On Windows you can visit the /// list from the task bar, and on macOS you can visit it from dock menu. /// /// Path to add. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void AddRecentDocument(string path) { this.CallMethod1(path); } /// /// Clears the recent documents list. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void ClearRecentDocuments() { this.CallMethod0(); } /// /// Sets the current executable as the default handler for a protocol (aka URI scheme). It allows you to /// integrate your app deeper into the operating system. Once registered, all links with your-protocol:// /// will be opened with the current executable. The whole link, including protocol, will be passed to your /// application as a parameter. /// /// Note: On macOS, you can only register protocols that have been added to your app's info.plist, which /// cannot be modified at runtime. However, you can change the file during build time via /// Electron Forge, /// Electron Packager, or by editing info.plist /// with a text editor. Please refer to /// Apple's documentation /// for details. /// /// Note: In a Windows Store environment (when packaged as an appx) this API will return true for all calls but /// the registry key it sets won't be accessible by other applications. In order to register your Windows Store /// application as a default protocol handler you must declare the protocol in your manifest. /// /// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally. /// /// /// The name of your protocol, without ://. For example, if you want your app to handle electron:// links, /// call this method with electron as the parameter. /// The cancellation token. /// Whether the call succeeded. public async Task SetAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default) { return await this.SetAsDefaultProtocolClientAsync(protocol, null, null, cancellationToken).ConfigureAwait(false); } /// /// Sets the current executable as the default handler for a protocol (aka URI scheme). It allows you to /// integrate your app deeper into the operating system. Once registered, all links with your-protocol:// /// will be opened with the current executable. The whole link, including protocol, will be passed to your /// application as a parameter. /// /// Note: On macOS, you can only register protocols that have been added to your app's info.plist, which /// cannot be modified at runtime. However, you can change the file during build time via /// Electron Forge, /// Electron Packager, or by editing info.plist /// with a text editor. Please refer to /// Apple's documentation /// for details. /// /// Note: In a Windows Store environment (when packaged as an appx) this API will return true for all calls but /// the registry key it sets won't be accessible by other applications. In order to register your Windows Store /// application as a default protocol handler you must declare the protocol in your manifest. /// /// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally. /// /// /// The name of your protocol, without ://. For example, if you want your app to handle electron:// links, /// call this method with electron as the parameter. /// The path to the Electron executable. Defaults to process.execPath /// The cancellation token. /// Whether the call succeeded. public async Task SetAsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default) { return await this.SetAsDefaultProtocolClientAsync(protocol, path, null, cancellationToken).ConfigureAwait(false); } /// /// Sets the current executable as the default handler for a protocol (aka URI scheme). It allows you to /// integrate your app deeper into the operating system. Once registered, all links with your-protocol:// /// will be opened with the current executable. The whole link, including protocol, will be passed to your /// application as a parameter. /// /// Note: On macOS, you can only register protocols that have been added to your app's info.plist, which /// cannot be modified at runtime. However, you can change the file during build time via /// Electron Forge, /// Electron Packager, or by editing info.plist /// with a text editor. Please refer to /// Apple's documentation /// for details. /// /// Note: In a Windows Store environment (when packaged as an appx) this API will return true for all calls but /// the registry key it sets won't be accessible by other applications. In order to register your Windows Store /// application as a default protocol handler you must declare the protocol in your manifest. /// /// The API uses the Windows Registry and LSSetDefaultHandlerForURLScheme internally. /// /// /// The name of your protocol, without ://. For example, if you want your app to handle electron:// links, /// call this method with electron as the parameter. /// The path to the Electron executable. Defaults to process.execPath /// Arguments passed to the executable. Defaults to an empty array. /// The cancellation token. /// Whether the call succeeded. public async Task SetAsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appSetAsDefaultProtocolClientCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appSetAsDefaultProtocolClient", protocol, path, args); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// This method checks if the current executable as the default handler for a protocol (aka URI scheme). /// If so, it will remove the app as the default handler. /// /// The name of your protocol, without ://. /// The cancellation token. /// Whether the call succeeded. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task RemoveAsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default) { return await this.RemoveAsDefaultProtocolClientAsync(protocol, null, null, cancellationToken).ConfigureAwait(false); } /// /// This method checks if the current executable as the default handler for a protocol (aka URI scheme). /// If so, it will remove the app as the default handler. /// /// The name of your protocol, without ://. /// Defaults to process.execPath. /// The cancellation token. /// Whether the call succeeded. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task RemoveAsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default) { return await this.RemoveAsDefaultProtocolClientAsync(protocol, path, null, cancellationToken).ConfigureAwait(false); } /// /// This method checks if the current executable as the default handler for a protocol (aka URI scheme). /// If so, it will remove the app as the default handler. /// /// The name of your protocol, without ://. /// Defaults to process.execPath. /// Defaults to an empty array. /// The cancellation token. /// Whether the call succeeded. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task RemoveAsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appRemoveAsDefaultProtocolClientCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appRemoveAsDefaultProtocolClient", protocol, path, args); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// This method checks if the current executable is the default handler for a protocol (aka URI scheme). /// /// Note: On macOS, you can use this method to check if the app has been registered as the default protocol /// handler for a protocol. You can also verify this by checking ~/Library/Preferences/com.apple.LaunchServices.plist /// on the macOS machine. Please refer to Apple's documentation /// for details. /// /// The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally. /// /// The name of your protocol, without ://. /// The cancellation token. /// Whether the current executable is the default handler for a protocol (aka URI scheme). public async Task IsDefaultProtocolClientAsync(string protocol, CancellationToken cancellationToken = default) { return await this.IsDefaultProtocolClientAsync(protocol, null, null, cancellationToken).ConfigureAwait(false); } /// /// This method checks if the current executable is the default handler for a protocol (aka URI scheme). /// /// Note: On macOS, you can use this method to check if the app has been registered as the default protocol /// handler for a protocol. You can also verify this by checking ~/Library/Preferences/com.apple.LaunchServices.plist /// on the macOS machine. Please refer to Apple's documentation /// for details. /// /// The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally. /// /// The name of your protocol, without ://. /// Defaults to process.execPath. /// The cancellation token. /// Whether the current executable is the default handler for a protocol (aka URI scheme). public async Task IsDefaultProtocolClientAsync(string protocol, string path, CancellationToken cancellationToken = default) { return await this.IsDefaultProtocolClientAsync(protocol, path, null, cancellationToken).ConfigureAwait(false); } /// /// This method checks if the current executable is the default handler for a protocol (aka URI scheme). /// /// Note: On macOS, you can use this method to check if the app has been registered as the default protocol /// handler for a protocol. You can also verify this by checking ~/Library/Preferences/com.apple.LaunchServices.plist /// on the macOS machine. Please refer to Apple's documentation /// for details. /// /// The API uses the Windows Registry and LSCopyDefaultHandlerForURLScheme internally. /// /// The name of your protocol, without ://. /// Defaults to process.execPath. /// Defaults to an empty array. /// The cancellation token. /// Whether the current executable is the default handler for a protocol (aka URI scheme). public async Task IsDefaultProtocolClientAsync(string protocol, string path, string[] args, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appIsDefaultProtocolClientCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appIsDefaultProtocolClient", protocol, path, args); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Adds tasks to the category of the JumpList on Windows. /// /// Note: If you'd like to customize the Jump List even more use instead. /// /// Array of objects. /// The cancellation token. /// Whether the call succeeded. [SupportedOSPlatform("Windows")] public async Task SetUserTasksAsync(UserTask[] userTasks, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appSetUserTasksCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appSetUserTasks", userTasks); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Jump List settings for the application. /// /// The cancellation token. /// Jump List settings. [SupportedOSPlatform("Windows")] public async Task GetJumpListSettingsAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Sets or removes a custom Jump List for the application. If categories is null the previously set custom /// Jump List (if any) will be replaced by the standard Jump List for the app (managed by Windows). /// /// Note: If a object has neither the nor /// the property set then its is assumed /// to be . If the property is set but /// the property is omitted then the is /// assumed to be . /// /// Note: Users can remove items from custom categories, and Windows will not allow a removed item to be added /// back into a custom category until after the next successful call to . Any attempt /// to re-add a removed item to a custom category earlier than that will result in the entire custom category being /// omitted from the Jump List. The list of removed items can be obtained using . /// /// Array of objects. [SupportedOSPlatform("Windows")] public void SetJumpList(JumpListCategory[] categories) { this.CallMethod1(categories); } /// /// The return value of this method indicates whether or not this instance of your application successfully obtained /// the lock. If it failed to obtain the lock, you can assume that another instance of your application is already /// running with the lock and exit immediately. /// /// I.e.This method returns if your process is the primary instance of your application and your /// app should continue loading. It returns if your process should immediately quit as it has /// sent its parameters to another instance that has already acquired the lock. /// /// On macOS, the system enforces single instance automatically when users try to open a second instance of your app /// in Finder, and the open-file and open-url events will be emitted for that.However when users start your app in /// command line, the system's single instance mechanism will be bypassed, and you have to use this method to ensure /// single instance. /// /// Lambda with an array of the second instance’s command line arguments. /// The second parameter is the working directory path. /// The cancellation token. /// This method returns false if your process is the primary instance of the application and your app /// should continue loading. And returns true if your process has sent its parameters to another instance, and /// you should immediately quit. /// public async Task RequestSingleInstanceLockAsync(Action newInstanceOpened, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appRequestSingleInstanceLockCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Off("secondInstance"); BridgeConnector.Socket.On("secondInstance", (result) => { var arr = result.EnumerateArray(); var e = arr.GetEnumerator(); e.MoveNext(); var args = e.Current.Deserialize(JsonSerializerOptions.Default); e.MoveNext(); var workingDirectory = e.Current.GetString(); newInstanceOpened(args, workingDirectory); }); BridgeConnector.Socket.Emit("appRequestSingleInstanceLock"); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Releases all locks that were created by makeSingleInstance. This will allow /// multiple instances of the application to once again run side by side. /// public void ReleaseSingleInstanceLock() { this.CallMethod0(); } /// /// This method returns whether or not this instance of your app is currently holding the single instance lock. /// You can request the lock with and release with /// . /// /// The cancellation token. public async Task HasSingleInstanceLockAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Creates an NSUserActivity and sets it as the current activity. The activity is /// eligible for Handoff /// to another device afterward. /// /// Uniquely identifies the activity. Maps to NSUserActivity.activityType. /// App-specific state to store for use by another device. [SupportedOSPlatform("macOS")] public void SetUserActivity(string type, object userInfo) { SetUserActivity(type, userInfo, null); } /// /// Creates an NSUserActivity and sets it as the current activity. The activity is /// eligible for Handoff /// to another device afterward. /// /// /// Uniquely identifies the activity. Maps to NSUserActivity.activityType. /// /// App-specific state to store for use by another device. /// /// The webpage to load in a browser if no suitable app is installed on the resuming device. The scheme must be http or https. /// [SupportedOSPlatform("macOS")] public void SetUserActivity(string type, object userInfo, string webpageUrl) { this.CallMethod3(type, userInfo, webpageUrl); } /// /// The type of the currently running activity. /// /// The cancellation token. [SupportedOSPlatform("macOS")] public async Task GetCurrentActivityTypeAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Invalidates the current Handoff user activity. /// [SupportedOSPlatform("macOS")] public void InvalidateCurrentActivity() { this.CallMethod0(); } /// /// Marks the current Handoff user activity as inactive without invalidating it. /// [SupportedOSPlatform("macOS")] public void ResignCurrentActivity() { this.CallMethod0(); } /// /// Changes the Application User Model ID to id. /// /// Model Id. [SupportedOSPlatform("Windows")] public void SetAppUserModelId(string id) { this.CallMethod1(id); } /// TODO: Check new parameter which is a function [App.ImportCertificate] /// /// Imports the certificate in pkcs12 format into the platform certificate store. /// callback is called with the result of import operation, a value of 0 indicates /// success while any other value indicates failure according to chromium net_error_list. /// /// /// The cancellation token. /// Result of import. Value of 0 indicates success. [SupportedOSPlatform("Linux")] public async Task ImportCertificateAsync(ImportCertificateOptions options, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appImportCertificateCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appImportCertificate", options); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Memory and cpu usage statistics of all the processes associated with the app. /// /// /// Array of ProcessMetric objects that correspond to memory and cpu usage /// statistics of all the processes associated with the app. /// The cancellation token. /// public async Task GetAppMetricsAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// The Graphics Feature Status from chrome://gpu/. /// /// Note: This information is only usable after the gpu-info-update event is emitted. /// The cancellation token. /// public async Task GetGpuFeatureStatusAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Sets the counter badge for current app. Setting the count to 0 will hide the badge. /// On macOS it shows on the dock icon. On Linux it only works for Unity launcher. /// /// Note: Unity launcher requires the existence of a .desktop file to work, for more /// information please read Desktop Environment Integration. /// /// Counter badge. /// The cancellation token. /// Whether the call succeeded. [SupportedOSPlatform("Linux")] [SupportedOSPlatform("macOS")] public async Task SetBadgeCountAsync(int count, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appSetBadgeCountCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appSetBadgeCount", count); return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// The current value displayed in the counter badge. /// /// The cancellation token. [SupportedOSPlatform("Linux")] [SupportedOSPlatform("macOS")] public async Task GetBadgeCountAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// A object that allows you to read and manipulate the command line arguments that Chromium uses. /// public CommandLine CommandLine { get; internal set; } /// /// Whether the current desktop environment is Unity launcher. /// /// The cancellation token. [SupportedOSPlatform("Linux")] public async Task IsUnityRunningAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// If you provided path and args options to then you need to pass the same /// arguments here for to be set correctly. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task GetLoginItemSettingsAsync(CancellationToken cancellationToken = default) { return await this.GetLoginItemSettingsAsync(null, cancellationToken).ConfigureAwait(false); } /// /// If you provided path and args options to then you need to pass the same /// arguments here for to be set correctly. /// /// /// The cancellation token. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task GetLoginItemSettingsAsync(LoginItemSettingsOptions options, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var taskCompletionSource = new TaskCompletionSource(); using (cancellationToken.Register(() => taskCompletionSource.TrySetCanceled())) { BridgeConnector.Socket.Once("appGetLoginItemSettingsCompleted", taskCompletionSource.SetResult); if (options == null) { BridgeConnector.Socket.Emit("appGetLoginItemSettings"); } else { BridgeConnector.Socket.Emit("appGetLoginItemSettings", options); } return await taskCompletionSource.Task .ConfigureAwait(false); } } /// /// Set the app's login item settings. /// To work with Electron's autoUpdater on Windows, which uses Squirrel, /// you'll want to set the launch path to Update.exe, and pass arguments that specify your application name. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetLoginItemSettings(LoginSettings loginSettings) { this.CallMethod1(loginSettings); } /// /// if Chrome's accessibility support is enabled, otherwise. This API will /// return if the use of assistive technologies, such as screen readers, has been detected. /// See Chromium's accessibility docs for more details. /// /// if Chrome’s accessibility support is enabled, otherwise. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public async Task IsAccessibilitySupportEnabledAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); return await this.InvokeAsync().ConfigureAwait(false); } /// /// Manually enables Chrome's accessibility support, allowing to expose accessibility switch to users in application settings. /// See Chromium's accessibility docs for more details. /// Disabled () by default. /// /// This API must be called after the event is emitted. /// /// Note: Rendering accessibility tree can significantly affect the performance of your app. It should not be enabled by default. /// /// Enable or disable accessibility tree rendering. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetAccessibilitySupportEnabled(bool enabled) { this.CallMethod1(enabled); } /// /// Show the app's about panel options. These options can be overridden with /// . /// public void ShowAboutPanel() { this.CallMethod0(); } /// /// Set the about panel options. This will override the values defined in the app's .plist file on macOS. See the /// Apple docs /// for more details. On Linux, values must be set in order to be shown; there are no defaults. /// /// If you do not set credits but still wish to surface them in your app, AppKit will look for a file named "Credits.html", /// "Credits.rtf", and "Credits.rtfd", in that order, in the bundle returned by the NSBundle class method main. The first file /// found is used, and if none is found, the info area is left blank. See Apple /// documentation for more information. /// /// About panel options. public void SetAboutPanelOptions(AboutPanelOptions options) { this.CallMethod1(options); } /// /// A which is the user agent string Electron will use as a global fallback. /// /// This is the user agent that will be used when no user agent is set at the webContents or /// session level. It is useful for ensuring that your entire app has the same user agent. Set to a /// custom value as early as possible in your app's initialization to ensure that your overridden value /// is used. /// public string UserAgentFallback { [Obsolete("Use the asynchronous version UserAgentFallbackAsync instead")] get { return UserAgentFallbackAsync.Result; } set { BridgeConnector.Socket.Emit("appSetUserAgentFallback", value); } } /// /// A which is the user agent string Electron will use as a global fallback. /// /// This is the user agent that will be used when no user agent is set at the webContents or /// session level. It is useful for ensuring that your entire app has the same user agent. Set to a /// custom value as early as possible in your app's initialization to ensure that your overridden value /// is used. /// public Task UserAgentFallbackAsync { get { return Task.Run(() => { var taskCompletionSource = new TaskCompletionSource(); BridgeConnector.Socket.Once("appGetUserAgentFallbackCompleted", taskCompletionSource.SetResult); BridgeConnector.Socket.Emit("appGetUserAgentFallback"); return taskCompletionSource.Task; }); } } internal void PreventQuit() { _preventQuit = true; } private bool _preventQuit = false; private const string ModuleName = "app"; /// /// Subscribe to an unmapped event on the module. /// /// The event name /// The handler public void On(string eventName, Action action) => Events.Instance.On(ModuleName, eventName, action); /// /// Subscribe to an unmapped event on the module. /// /// The event name /// The handler public async Task On(string eventName, Action action) => await Events.Instance.On(ModuleName, eventName, action).ConfigureAwait(false); /// /// Subscribe to an unmapped event on the module once. /// /// The event name /// The handler public void Once(string eventName, Action action) => Events.Instance.Once(ModuleName, eventName, action); /// /// Subscribe to an unmapped event on the module once. /// /// The event name /// The handler public async Task Once(string eventName, Action action) => await Events.Instance.Once(ModuleName, eventName, action).ConfigureAwait(false); } } ================================================ FILE: src/ElectronNET.API/API/AutoUpdater.cs ================================================ using ElectronNET.API.Entities; using System; using System.Collections.Generic; using System.Threading.Tasks; // ReSharper disable InconsistentNaming namespace ElectronNET.API { /// /// Enable apps to automatically update themselves. Based on electron-updater. /// public sealed class AutoUpdater : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Whether to automatically download an update when it is found. (Default is true) /// public bool AutoDownload { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("autoUpdater-autoDownload-set", value); } } /// /// Whether to automatically install a downloaded update on app quit (if `QuitAndInstall` was not called before). /// /// Applicable only on Windows and Linux. /// public bool AutoInstallOnAppQuit { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("autoUpdater-autoInstallOnAppQuit-set", value); } } /// /// *GitHub provider only.* Whether to allow update to pre-release versions. /// Defaults to "true" if application version contains prerelease components (e.g. "0.12.1-alpha.1", here "alpha" is a prerelease component), otherwise "false". /// /// If "true", downgrade will be allowed("allowDowngrade" will be set to "true"). /// public bool AllowPrerelease { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("autoUpdater-allowPrerelease-set", value); } } /// /// *GitHub provider only.* /// Get all release notes (from current version to latest), not just the latest (Default is false). /// public bool FullChangelog { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("autoUpdater-fullChangelog-set", value); } } /// /// Whether to allow version downgrade (when a user from the beta channel wants to go back to the stable channel). /// Taken in account only if channel differs (pre-release version component in terms of semantic versioning). /// Default is false. /// public bool AllowDowngrade { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("autoUpdater-allowDowngrade-set", value); } } /// /// For test only. /// public string UpdateConfigPath { get { return Task.Run(() => this.InvokeAsync()).Result; } } /// /// The current application version /// public Task CurrentVersionAsync { get { return Task.Run(() => this.InvokeAsync()); } } /// /// Get the update channel. Not applicable for GitHub. /// Doesn’t return channel from the update configuration, only if was previously set. /// [Obsolete("Use the asynchronous version ChannelAsync instead")] public string Channel { get { return ChannelAsync.Result; } } /// /// Get the update channel. Not applicable for GitHub. /// Doesn’t return channel from the update configuration, only if was previously set. /// public Task ChannelAsync { get { return Task.Run(() => this.InvokeAsync()); } } /// /// Set the update channel. Not applicable for GitHub. /// public string SetChannel { set { BridgeConnector.Socket.Emit("autoUpdater-channel-set", value); } } /// /// The request headers. /// public Task> RequestHeadersAsync { get { return Task.Run(() => this.InvokeAsync>()); } } /// /// The request headers. /// public Dictionary RequestHeaders { set { BridgeConnector.Socket.Emit("autoUpdater-requestHeaders-set", value); } } /// /// Emitted when there is an error while updating. /// public event Action OnError { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when checking if an update has started. /// public event Action OnCheckingForUpdate { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when there is an available update. /// The update is downloaded automatically if AutoDownload is true. /// public event Action OnUpdateAvailable { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when there is no available update. /// public event Action OnUpdateNotAvailable { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted on download progress. /// public event Action OnDownloadProgress { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted on download complete. /// public event Action OnUpdateDownloaded { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } private static AutoUpdater _autoUpdater; private static object _syncRoot = new object(); internal AutoUpdater() { } internal static AutoUpdater Instance { get { if (_autoUpdater == null) { lock (_syncRoot) { if (_autoUpdater == null) { _autoUpdater = new AutoUpdater(); } } } return _autoUpdater; } } /// /// Asks the server whether there is an update. /// /// public Task CheckForUpdatesAsync() { var taskCompletionSource = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("autoUpdater-checkForUpdates-completed" + guid, (result) => { try { BridgeConnector.Socket.Off("autoUpdater-checkForUpdatesError" + guid); taskCompletionSource.SetResult(result); } catch (Exception ex) { taskCompletionSource.SetException(ex); } }); BridgeConnector.Socket.Once("autoUpdater-checkForUpdatesError" + guid, (result) => { BridgeConnector.Socket.Off("autoUpdater-checkForUpdates-completed" + guid); string message = "An error occurred in CheckForUpdatesAsync"; if (!string.IsNullOrEmpty(result)) message = result; taskCompletionSource.SetException(new Exception(message)); }); BridgeConnector.Socket.Emit("autoUpdater-checkForUpdates", guid); return taskCompletionSource.Task; } /// /// Asks the server whether there is an update. /// /// This will immediately download an update, then install when the app quits. /// /// public Task CheckForUpdatesAndNotifyAsync() { var taskCompletionSource = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("autoUpdater-checkForUpdatesAndNotify-completed" + guid, (result) => { try { BridgeConnector.Socket.Off("autoUpdater-checkForUpdatesAndNotifyError" + guid); taskCompletionSource.SetResult(result); } catch (Exception ex) { taskCompletionSource.SetException(ex); } }); BridgeConnector.Socket.Once("autoUpdater-checkForUpdatesAndNotifyError" + guid, (result) => { BridgeConnector.Socket.Off("autoUpdater-checkForUpdatesAndNotify-completed" + guid); string message = "An error occurred in CheckForUpdatesAndNotifyAsync"; if (!string.IsNullOrEmpty(result)) message = result; taskCompletionSource.SetException(new Exception(message)); }); BridgeConnector.Socket.Emit("autoUpdater-checkForUpdatesAndNotify", guid); return taskCompletionSource.Task; } /// /// Restarts the app and installs the update after it has been downloaded. /// It should only be called after `update-downloaded` has been emitted. /// /// Note: QuitAndInstall() will close all application windows first and only emit `before-quit` event on `app` after that. /// This is different from the normal quit event sequence. /// /// *windows-only* Runs the installer in silent mode. Defaults to `false`. /// Run the app after finish even on silent install. Not applicable for macOS. Ignored if `isSilent` is set to `false`. public void QuitAndInstall(bool isSilent = false, bool isForceRunAfter = false) { BridgeConnector.Socket.Emit("autoUpdater-quitAndInstall", isSilent, isForceRunAfter); } /// /// Start downloading update manually. You can use this method if "AutoDownload" option is set to "false". /// /// Path to downloaded file. public Task DownloadUpdateAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("autoUpdater-downloadUpdate-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("autoUpdater-downloadUpdate", guid); return tcs.Task; } /// /// Feed URL. /// /// Feed URL. public Task GetFeedURLAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("autoUpdater-getFeedURL-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("autoUpdater-getFeedURL", guid); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/BrowserView.cs ================================================ using ElectronNET.API.Entities; using System.Threading.Tasks; namespace ElectronNET.API { /// /// A BrowserView can be used to embed additional web content into a BrowserWindow. /// It is like a child window, except that it is positioned relative to its owning window. /// It is meant to be an alternative to the webview tag. /// public class BrowserView : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; /// /// Gets the identifier. /// public override int Id { get; protected set; } /// /// Render and control web pages. /// public WebContents WebContents { get; internal set; } /// /// Resizes and moves the view to the supplied bounds relative to the window. /// (experimental) /// public Rectangle Bounds { get { return Task.Run(() => this.InvokeAsync()).Result; } set { BridgeConnector.Socket.Emit("browserView-bounds-set", Id, value); } } /// /// BrowserView /// internal BrowserView(int id) { Id = id; // Workaround: increase the Id so as not to conflict with BrowserWindow id // the backend detect about the value an BrowserView WebContents = new WebContents(id + 1000); } /// /// (experimental) /// /// public void SetAutoResize(AutoResizeOptions options) { BridgeConnector.Socket.Emit("browserView-setAutoResize", Id, options); } /// /// Color in #aarrggbb or #argb form. The alpha channel is optional. /// (experimental) /// /// Color in #aarrggbb or #argb form. The alpha channel is optional. public void SetBackgroundColor(string color) { BridgeConnector.Socket.Emit("browserView-setBackgroundColor", Id, color); } } } ================================================ FILE: src/ElectronNET.API/API/BrowserWindow.cs ================================================ using System; using System.Collections.Generic; using System.Linq; using System.Runtime.InteropServices; using System.Runtime.Versioning; using System.Threading.Tasks; using ElectronNET.API.Entities; using ElectronNET.API.Extensions; // ReSharper disable InconsistentNaming namespace ElectronNET.API; /// /// Create and control browser windows. /// public class BrowserWindow : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Gets the identifier. /// /// /// The identifier. /// public override int Id { get; protected set; } /// /// Emitted when the web page has been rendered (while not being shown) and /// window can be displayed without a visual flash. /// public event Action OnReadyToShow { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the document changed its title. /// public event Action OnPageTitleUpdated { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is going to be closed. /// public event Action OnClose { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is closed. /// After you have received this event you should remove the /// reference to the window and avoid using it any more. /// public event Action OnClosed { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when window session is going to end due to force shutdown or machine restart or session log off. /// [SupportedOSPlatform("Windows")] public event Action OnSessionEnd { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the web page becomes unresponsive. /// public event Action OnUnresponsive { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the unresponsive web page becomes responsive again. /// public event Action OnResponsive { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window loses focus. /// public event Action OnBlur { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window gains focus. /// public event Action OnFocus { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is shown. /// public event Action OnShow { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is hidden. /// public event Action OnHide { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when window is maximized. /// public event Action OnMaximize { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window exits from a maximized state. /// public event Action OnUnmaximize { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is minimized. /// public event Action OnMinimize { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is restored from a minimized state. /// public event Action OnRestore { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is being resized. /// public event Action OnResize { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is being moved to a new position. /// /// Note: On macOS this event is just an alias of moved. /// public event Action OnMove { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window is moved or resized. /// /// /// While not being an original Electron event, this one includes the bounds values, /// saving the additional roundtrip for calling . /// public event Action OnBoundsChanged { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// macOS: Emitted once when the window is moved to a new position. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnMoved { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window enters a full-screen state. /// public event Action OnEnterFullScreen { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window leaves a full-screen state. /// public event Action OnLeaveFullScreen { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window enters a full-screen state triggered by HTML API. /// public event Action OnEnterHtmlFullScreen { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window leaves a full-screen state triggered by HTML API. /// public event Action OnLeaveHtmlFullScreen { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when an App Command is invoked. These are typically related to /// keyboard media keys or browser commands, as well as the “Back” button /// built into some mice on Windows. /// /// Commands are lowercased, underscores are replaced with hyphens, /// and the APPCOMMAND_ prefix is stripped off.e.g.APPCOMMAND_BROWSER_BACKWARD /// is emitted as browser-backward. /// [SupportedOSPlatform("Windows")] [SupportedOSPlatform("Linux")] public event Action OnAppCommand { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted on 3-finger swipe. Possible directions are up, right, down, left. /// [SupportedOSPlatform("macOS")] public event Action OnSwipe { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window opens a sheet. /// [SupportedOSPlatform("macOS")] public event Action OnSheetBegin { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the window has closed a sheet. /// [SupportedOSPlatform("macOS")] public event Action OnSheetEnd { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the native new tab button is clicked. /// [SupportedOSPlatform("macOS")] public event Action OnNewWindowForTab { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } internal BrowserWindow(int id) { Id = id; WebContents = new WebContents(id); } /// /// Force closing the window, the unload and beforeunload event won’t be /// emitted for the web page, and close event will also not be emitted /// for this window, but it guarantees the closed event will be emitted. /// public void Destroy() => this.CallMethod0(); /// /// Try to close the window. This has the same effect as a user manually /// clicking the close button of the window. The web page may cancel the close though. /// public void Close() => this.CallMethod0(); /// /// Focuses on the window. /// public void Focus() => this.CallMethod0(); /// /// Removes focus from the window. /// public void Blur() => this.CallMethod0(); /// /// Whether the window is focused. /// /// public Task IsFocusedAsync() => this.InvokeAsync(); /// /// Whether the window is destroyed. /// /// public Task IsDestroyedAsync() => this.InvokeAsync(); /// /// Shows and gives focus to the window. /// public void Show() => this.CallMethod0(); /// /// Shows the window but doesn’t focus on it. /// public void ShowInactive() => this.CallMethod0(); /// /// Hides the window. /// public void Hide() => this.CallMethod0(); /// /// Whether the window is visible to the user. /// /// public Task IsVisibleAsync() => this.InvokeAsync(); /// /// Whether current window is a modal window. /// /// public Task IsModalAsync() => this.InvokeAsync(); /// /// Maximizes the window. This will also show (but not focus) the window if it isn’t being displayed already. /// public void Maximize() => this.CallMethod0(); /// /// Unmaximizes the window. /// public void Unmaximize() => this.CallMethod0(); /// /// Whether the window is maximized. /// /// public Task IsMaximizedAsync() => this.InvokeAsync(); /// /// Minimizes the window. On some platforms the minimized window will be shown in the Dock. /// public void Minimize() => this.CallMethod0(); /// /// Restores the window from minimized state to its previous state. /// public void Restore() => this.CallMethod0(); /// /// Whether the window is minimized. /// /// public Task IsMinimizedAsync() => this.InvokeAsync(); /// /// Sets whether the window should be in fullscreen mode. /// /// public void SetFullScreen(bool flag) => this.CallMethod1(flag); /// /// Whether the window is in fullscreen mode. /// /// public Task IsFullScreenAsync() => this.InvokeAsync(); /// /// This will make a window maintain an aspect ratio. The extra size allows a developer to have space, /// specified in pixels, not included within the aspect ratio calculations. This API already takes into /// account the difference between a window’s size and its content size. /// /// Consider a normal window with an HD video player and associated controls.Perhaps there are 15 pixels /// of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below /// the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within /// the player itself we would call this function with arguments of 16/9 and[40, 50]. The second argument /// doesn’t care where the extra width and height are within the content view–only that they exist. Just /// sum any extra width and height areas you have within the overall content view. /// /// The aspect ratio to maintain for some portion of the content view. /// The extra size not to be included while maintaining the aspect ratio. public void SetAspectRatio(double aspectRatio, Size extraSize) => this.CallMethod2(aspectRatio, extraSize); /// /// This will make a window maintain an aspect ratio. The extra size allows a developer to have space, /// specified in pixels, not included within the aspect ratio calculations. This API already takes into /// account the difference between a window’s size and its content size. /// /// Consider a normal window with an HD video player and associated controls.Perhaps there are 15 pixels /// of controls on the left edge, 25 pixels of controls on the right edge and 50 pixels of controls below /// the player. In order to maintain a 16:9 aspect ratio (standard aspect ratio for HD @1920x1080) within /// the player itself we would call this function with arguments of 16/9 and[40, 50]. The second argument /// doesn’t care where the extra width and height are within the content view–only that they exist. Just /// sum any extra width and height areas you have within the overall content view. /// /// The aspect ratio to maintain for some portion of the content view. /// The extra size not to be included while maintaining the aspect ratio. public void SetAspectRatio(int aspectRatio, Size extraSize) => this.CallMethod2(aspectRatio, extraSize); /// /// Uses Quick Look to preview a file at a given path. /// /// The absolute path to the file to preview with QuickLook. This is important as /// Quick Look uses the file name and file extension on the path to determine the content type of the /// file to open. [SupportedOSPlatform("macOS")] public void PreviewFile(string path) => this.CallMethod1(path); /// /// Uses Quick Look to preview a file at a given path. /// /// The absolute path to the file to preview with QuickLook. This is important as /// Quick Look uses the file name and file extension on the path to determine the content type of the /// file to open. /// The name of the file to display on the Quick Look modal view. This is /// purely visual and does not affect the content type of the file. Defaults to path. [SupportedOSPlatform("macOS")] public void PreviewFile(string path, string displayname) => this.CallMethod2(path, displayname); /// /// Closes the currently open Quick Look panel. /// [SupportedOSPlatform("macOS")] public void CloseFilePreview() => this.CallMethod0(); /// /// Resizes and moves the window to the supplied bounds /// /// public void SetBounds(Rectangle bounds) => this.CallMethod1(bounds); /// /// Resizes and moves the window to the supplied bounds /// /// /// public void SetBounds(Rectangle bounds, bool animate) => this.CallMethod2(bounds, animate); /// /// Gets the bounds asynchronous. /// /// public Task GetBoundsAsync() => this.InvokeAsync(); /// /// Resizes and moves the window’s client area (e.g. the web page) to the supplied bounds. /// /// public void SetContentBounds(Rectangle bounds) => this.CallMethod1(bounds); /// /// Resizes and moves the window’s client area (e.g. the web page) to the supplied bounds. /// /// /// public void SetContentBounds(Rectangle bounds, bool animate) => this.CallMethod2(bounds, animate); /// /// Gets the content bounds asynchronous. /// /// public Task GetContentBoundsAsync() => this.InvokeAsync(); /// /// Resizes the window to width and height. /// /// /// public void SetSize(int width, int height) => this.CallMethod2(width, height); /// /// Resizes the window to width and height. /// /// /// /// public void SetSize(int width, int height, bool animate) => this.CallMethod3(width, height, animate); /// /// Contains the window’s width and height. /// /// public Task GetSizeAsync() => this.InvokeAsync(); /// /// Resizes the window’s client area (e.g. the web page) to width and height. /// /// /// public void SetContentSize(int width, int height) => this.CallMethod2(width, height); /// /// Resizes the window’s client area (e.g. the web page) to width and height. /// /// /// /// public void SetContentSize(int width, int height, bool animate) => this.CallMethod3(width, height, animate); /// /// Contains the window’s client area’s width and height. /// /// public Task GetContentSizeAsync() => this.InvokeAsync(); /// /// Sets the minimum size of window to width and height. /// /// /// public void SetMinimumSize(int width, int height) => this.CallMethod2(width, height); /// /// Contains the window’s minimum width and height. /// /// public Task GetMinimumSizeAsync() => this.InvokeAsync(); /// /// Sets the maximum size of window to width and height. /// /// /// public void SetMaximumSize(int width, int height) => this.CallMethod2(width, height); /// /// Contains the window’s maximum width and height. /// /// public Task GetMaximumSizeAsync() => this.InvokeAsync(); /// /// Sets whether the window can be manually resized by user. /// /// public void SetResizable(bool resizable) => this.CallMethod1(resizable); /// /// Whether the window can be manually resized by user. /// /// public Task IsResizableAsync() => this.InvokeAsync(); /// /// Sets whether the window can be moved by user. On Linux does nothing. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetMovable(bool movable) => this.CallMethod1(movable); /// /// Whether the window can be moved by user. /// /// On Linux always returns true. /// /// On Linux always returns true. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task IsMovableAsync() => this.InvokeAsync(); /// /// Sets whether the window can be manually minimized by user. On Linux does nothing. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetMinimizable(bool minimizable) => this.CallMethod1(minimizable); /// /// Whether the window can be manually minimized by user. /// /// On Linux always returns true. /// /// On Linux always returns true. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task IsMinimizableAsync() => this.InvokeAsync(); /// /// Sets whether the window can be manually maximized by user. On Linux does nothing. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetMaximizable(bool maximizable) => this.CallMethod1(maximizable); /// /// Whether the window can be manually maximized by user. /// /// On Linux always returns true. /// /// On Linux always returns true. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task IsMaximizableAsync() => this.InvokeAsync(); /// /// Sets whether the maximize/zoom window button toggles fullscreen mode or maximizes the window. /// /// public void SetFullScreenable(bool fullscreenable) => this.CallMethod1(fullscreenable); /// /// Whether the maximize/zoom window button toggles fullscreen mode or maximizes the window. /// /// public Task IsFullScreenableAsync() => this.InvokeAsync(); /// /// Sets whether the window can be manually closed by user. On Linux does nothing. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetClosable(bool closable) => this.CallMethod1(closable); /// /// Whether the window can be manually closed by user. /// /// On Linux always returns true. /// /// On Linux always returns true. [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task IsClosableAsync() => this.InvokeAsync(); /// /// Sets whether the window should show always on top of other windows. /// After setting this, the window is still a normal window, not a toolbox /// window which can not be focused on. /// /// public void SetAlwaysOnTop(bool flag) => this.CallMethod1(flag); /// /// Sets whether the window should show always on top of other windows. /// After setting this, the window is still a normal window, not a toolbox /// window which can not be focused on. /// /// /// Values include normal, floating, torn-off-menu, modal-panel, main-menu, /// status, pop-up-menu and screen-saver. The default is floating. /// See the macOS docs public void SetAlwaysOnTop(bool flag, OnTopLevel level) => this.CallMethod2(flag, level); /// /// Sets whether the window should show always on top of other windows. /// After setting this, the window is still a normal window, not a toolbox /// window which can not be focused on. /// /// /// Values include normal, floating, torn-off-menu, modal-panel, main-menu, /// status, pop-up-menu and screen-saver. The default is floating. /// See the macOS docs /// The number of layers higher to set this window relative to the given level. /// The default is 0. Note that Apple discourages setting levels higher than 1 above screen-saver. public void SetAlwaysOnTop(bool flag, OnTopLevel level, int relativeLevel) => this.CallMethod3(flag, level, relativeLevel); /// /// Whether the window is always on top of other windows. /// /// public Task IsAlwaysOnTopAsync() => this.InvokeAsync(); /// /// Moves window to the center of the screen. /// public void Center() => this.CallMethod0(); /// /// Moves window to x and y. /// /// /// public void SetPosition(int x, int y) { // Workaround Windows 10 / Electron Bug // https://github.com/electron/electron/issues/4045 //if (isWindows10()) //{ // x = x - 7; //} this.CallMethod2(x, y); } /// /// Moves window to x and y. /// /// /// /// public void SetPosition(int x, int y, bool animate) { // Workaround Windows 10 / Electron Bug // https://github.com/electron/electron/issues/4045 //if (isWindows10()) //{ // x = x - 7; //} this.CallMethod3(x, y, animate); } private bool isWindows10() { return RuntimeInformation.OSDescription.Contains("Windows 10"); } /// /// Contains the window’s current position. /// /// public Task GetPositionAsync() => this.InvokeAsync(); /// /// Changes the title of native window to title. /// /// public void SetTitle(string title) => this.CallMethod1(title); /// /// The title of the native window. /// /// Note: The title of web page can be different from the title of the native window. /// /// public Task GetTitleAsync() => this.InvokeAsync(); /// /// Changes the attachment point for sheets on macOS. /// By default, sheets are attached just below the window frame, /// but you may want to display them beneath a HTML-rendered toolbar. /// /// [SupportedOSPlatform("macOS")] public void SetSheetOffset(float offsetY) => this.CallMethod1(offsetY); /// /// Changes the attachment point for sheets on macOS. /// By default, sheets are attached just below the window frame, /// but you may want to display them beneath a HTML-rendered toolbar. /// /// /// [SupportedOSPlatform("macOS")] public void SetSheetOffset(float offsetY, float offsetX) => this.CallMethod2(offsetY, offsetX); /// /// Starts or stops flashing the window to attract user’s attention. /// /// public void FlashFrame(bool flag) => this.CallMethod1(flag); /// /// Makes the window not show in the taskbar. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetSkipTaskbar(bool skip) => this.CallMethod1(skip); /// /// Enters or leaves the kiosk mode. /// /// public void SetKiosk(bool flag) => this.CallMethod1(flag); /// /// Whether the window is in kiosk mode. /// /// public Task IsKioskAsync() => this.InvokeAsync(); /// /// Returns the native type of the handle is HWND on Windows, NSView* on macOS, and Window (unsigned long) on Linux. /// /// string of the native handle obtained, HWND on Windows, NSView* on macOS, and Window (unsigned long) on Linux. public Task GetNativeWindowHandle() => this.InvokeAsync(); /// /// Sets the pathname of the file the window represents, /// and the icon of the file will show in window’s title bar. /// /// [SupportedOSPlatform("macOS")] public void SetRepresentedFilename(string filename) => this.CallMethod1(filename); /// /// The pathname of the file the window represents. /// /// [SupportedOSPlatform("macOS")] public Task GetRepresentedFilenameAsync() => this.InvokeAsync(); /// /// Specifies whether the window’s document has been edited, /// and the icon in title bar will become gray when set to true. /// /// [SupportedOSPlatform("macOS")] public void SetDocumentEdited(bool edited) => this.CallMethod1(edited); /// /// Whether the window’s document has been edited. /// /// [SupportedOSPlatform("macOS")] public Task IsDocumentEditedAsync() => this.InvokeAsync(); /// /// Focuses the on web view. /// public void FocusOnWebView() => this.CallMethod0(); /// /// Blurs the web view. /// public void BlurWebView() => this.CallMethod0(); /// /// The url can be a remote address (e.g. http://) or /// a path to a local HTML file using the file:// protocol. /// /// public void LoadURL(string url) => this.CallMethod1(url); /// /// The url can be a remote address (e.g. http://) or /// a path to a local HTML file using the file:// protocol. /// /// /// public void LoadURL(string url, LoadURLOptions options) => this.CallMethod2(url, options); /// /// Same as webContents.reload. /// public void Reload() => this.CallMethod0(); /// /// Gets the menu items. /// /// /// The menu items. /// public IReadOnlyCollection MenuItems { get { return _items.AsReadOnly(); } } private List _items = new List(); /// /// Sets the menu as the window’s menu bar, /// setting it to null will remove the menu bar. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public void SetMenu(MenuItem[] menuItems) { menuItems.AddMenuItemsId(); this.CallMethod1(menuItems); _items.AddRange(menuItems); BridgeConnector.Socket.Off("windowMenuItemClicked"); BridgeConnector.Socket.On("windowMenuItemClicked", (id) => { MenuItem menuItem = _items.GetMenuItem(id); menuItem?.Click(); }); } /// /// Remove the window's menu bar. /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public void RemoveMenu() => this.CallMethod0(); /// /// Sets progress value in progress bar. Valid range is [0, 1.0]. Remove progress /// 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 /// are none, normal, indeterminate, error, and paused. If you call setProgressBar /// without a mode set (but with a value within the valid range), normal will be /// assumed. /// /// public void SetProgressBar(double progress) => this.CallMethod1(progress); /// /// Sets progress value in progress bar. Valid range is [0, 1.0]. Remove progress /// 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 /// are none, normal, indeterminate, error, and paused. If you call setProgressBar /// without a mode set (but with a value within the valid range), normal will be /// assumed. /// /// /// public void SetProgressBar(double progress, ProgressBarOptions progressBarOptions) => this.CallMethod2(progress, progressBarOptions); /// /// Sets whether the window should have a shadow. On Windows and Linux does nothing. /// /// public void SetHasShadow(bool hasShadow) => this.CallMethod1(hasShadow); /// /// Whether the window has a shadow. /// /// On Windows and Linux always returns true. /// /// public Task HasShadowAsync() => this.InvokeAsync(); /// /// Gets the thumbar buttons. /// /// /// The thumbar buttons. /// public IReadOnlyCollection ThumbarButtons { get { return _thumbarButtons.AsReadOnly(); } } private List _thumbarButtons = new List(); /// /// Add a thumbnail toolbar with a specified set of buttons to the thumbnail /// image of a window in a taskbar button layout. Returns a Boolean object /// indicates whether the thumbnail has been added successfully. /// /// The number of buttons in thumbnail toolbar should be no greater than 7 due /// to the limited room.Once you setup the thumbnail toolbar, the toolbar cannot /// be removed due to the platform’s limitation.But you can call the API with an /// empty array to clean the buttons. /// /// /// Whether the buttons were added successfully. [SupportedOSPlatform("Windows")] public Task SetThumbarButtonsAsync(ThumbarButton[] thumbarButtons) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("browserWindowSetThumbarButtons-completed", tcs.SetResult); thumbarButtons.AddThumbarButtonsId(); BridgeConnector.Socket.Emit("browserWindowSetThumbarButtons", Id, thumbarButtons); _thumbarButtons.Clear(); _thumbarButtons.AddRange(thumbarButtons); BridgeConnector.Socket.Off("thumbarButtonClicked"); BridgeConnector.Socket.On("thumbarButtonClicked", (id) => { ThumbarButton thumbarButton = _thumbarButtons.GetThumbarButton(id); thumbarButton?.Click(); }); return tcs.Task; } /// /// Sets the region of the window to show as the thumbnail image displayed when hovering over /// the window in the taskbar. You can reset the thumbnail to be the entire window by specifying /// an empty region: {x: 0, y: 0, width: 0, height: 0}. /// /// [SupportedOSPlatform("Windows")] public void SetThumbnailClip(Rectangle rectangle) => this.CallMethod1(rectangle); /// /// Sets the toolTip that is displayed when hovering over the window thumbnail in the taskbar. /// /// [SupportedOSPlatform("Windows")] public void SetThumbnailToolTip(string tooltip) => this.CallMethod1(tooltip); /// /// Sets the properties for the window’s taskbar button. /// /// Note: relaunchCommand and relaunchDisplayName must always be set together. /// If one of those properties is not set, then neither will be used. /// /// [SupportedOSPlatform("Windows")] public void SetAppDetails(AppDetailsOptions options) => this.CallMethod1(options); /// /// Same as webContents.showDefinitionForSelection(). /// [SupportedOSPlatform("macOS")] public void ShowDefinitionForSelection() => this.CallMethod0(); /// /// Sets whether the window menu bar should hide itself automatically. /// Once set the menu bar will only show when users press the single Alt key. /// /// If the menu bar is already visible, calling setAutoHideMenuBar(true) won’t hide it immediately. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public void SetAutoHideMenuBar(bool hide) => this.CallMethod1(hide); /// /// Whether menu bar automatically hides itself. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public Task IsMenuBarAutoHideAsync() => this.InvokeAsync(); /// /// Sets whether the menu bar should be visible. If the menu bar is auto-hide, /// users can still bring up the menu bar by pressing the single Alt key. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public void SetMenuBarVisibility(bool visible) => this.CallMethod1(visible); /// /// Whether the menu bar is visible. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] public Task IsMenuBarVisibleAsync() => this.InvokeAsync(); /// /// Sets whether the window should be visible on all workspaces. /// /// Note: This API does nothing on Windows. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("macOS")] public void SetVisibleOnAllWorkspaces(bool visible) => this.CallMethod1(visible); /// /// Whether the window is visible on all workspaces. /// /// Note: This API always returns false on Windows. /// /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("macOS")] public Task IsVisibleOnAllWorkspacesAsync() => this.InvokeAsync(); /// /// Makes the window ignore all mouse events. /// /// All mouse events happened in this window will be passed to the window /// below this window, but if this window has focus, it will still receive keyboard events. /// /// public void SetIgnoreMouseEvents(bool ignore) => this.CallMethod1(ignore); /// /// Prevents the window contents from being captured by other apps. /// /// On macOS it sets the NSWindow’s sharingType to NSWindowSharingNone. /// On Windows it calls SetWindowDisplayAffinity with WDA_MONITOR. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetContentProtection(bool enable) => this.CallMethod1(enable); /// /// Changes whether the window can be focused. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void SetFocusable(bool focusable) => this.CallMethod1(focusable); /// /// Sets parent as current window’s parent window, /// passing null will turn current window into a top-level window. /// /// public void SetParentWindow(BrowserWindow parent) { if (parent == null) { BridgeConnector.Socket.Emit("browserWindowSetParentWindow", Id, null); } else { BridgeConnector.Socket.Emit("browserWindowSetParentWindow", Id, parent); } } /// /// The parent window. /// /// public async Task GetParentWindowAsync() { var browserWindowId = await this.InvokeAsync().ConfigureAwait(false); var browserWindow = Electron.WindowManager.BrowserWindows.ToList().Single(x => x.Id == browserWindowId); return browserWindow; } /// /// All child windows. /// /// public async Task> GetChildWindowsAsync() { var browserWindowIds = await this.InvokeAsync().ConfigureAwait(false); var browserWindows = new List(); foreach (var id in browserWindowIds) { var browserWindow = Electron.WindowManager.BrowserWindows.ToList().Single(x => x.Id == id); browserWindows.Add(browserWindow); } return browserWindows; } /// /// Controls whether to hide cursor when typing. /// /// [SupportedOSPlatform("macOS")] public void SetAutoHideCursor(bool autoHide) => this.CallMethod1(autoHide); /// /// Adds a vibrancy effect to the browser window. /// Passing null or an empty string will remove the vibrancy effect on the window. /// /// Can be appearance-based, light, dark, titlebar, selection, /// menu, popover, sidebar, medium-light or ultra-dark. /// See the macOS documentation for more details. [SupportedOSPlatform("macOS")] public void SetVibrancy(Vibrancy type) => this.CallMethod1(type); /// /// Render and control web pages. /// public WebContents WebContents { get; internal set; } /// /// A BrowserView can be used to embed additional web content into a BrowserWindow. /// It is like a child window, except that it is positioned relative to its owning window. /// It is meant to be an alternative to the webview tag. /// /// public void SetBrowserView(BrowserView browserView) { // This message name does not match the default ApiBase naming convention. BridgeConnector.Socket.Emit("browserWindow-setBrowserView", Id, browserView.Id); } } ================================================ FILE: src/ElectronNET.API/API/Clipboard.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System.Runtime.Versioning; using System.Text.Json; using System.Threading.Tasks; // ReSharper disable InconsistentNaming namespace ElectronNET.API { /// /// Perform copy and paste operations on the system clipboard. /// public sealed class Clipboard : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; private static Clipboard _clipboard; private static object _syncRoot = new object(); internal Clipboard() { } internal static Clipboard Instance { get { if (_clipboard == null) { lock (_syncRoot) { if (_clipboard == null) { _clipboard = new Clipboard(); } } } return _clipboard; } } /// /// Read the content in the clipboard as plain text. /// /// /// The content in the clipboard as plain text. public Task ReadTextAsync(string type = "") => this.InvokeAsync(type); /// /// Writes the text into the clipboard as plain text. /// /// /// public void WriteText(string text, string type = "") { BridgeConnector.Socket.Emit("clipboard-writeText", text, type); } /// /// The content in the clipboard as markup. /// /// /// public Task ReadHTMLAsync(string type = "") => this.InvokeAsync(type); /// /// Writes markup to the clipboard. /// /// /// public void WriteHTML(string markup, string type = "") { BridgeConnector.Socket.Emit("clipboard-writeHTML", markup, type); } /// /// The content in the clipboard as RTF. /// /// /// public Task ReadRTFAsync(string type = "") => this.InvokeAsync(type); /// /// Writes the text into the clipboard in RTF. /// /// /// public void WriteRTF(string text, string type = "") { BridgeConnector.Socket.Emit("clipboard-writeRTF", text, type); } /// /// Returns an Object containing title and url keys representing /// the bookmark in the clipboard. The title and url values will /// be empty strings when the bookmark is unavailable. /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task ReadBookmarkAsync() => this.InvokeAsync(); /// /// Writes the title and url into the clipboard as a bookmark. /// /// Note: Most apps on Windows don’t support pasting bookmarks /// into them so you can use clipboard.write to write both a /// bookmark and fallback text to the clipboard. /// /// /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public void WriteBookmark(string title, string url, string type = "") { BridgeConnector.Socket.Emit("clipboard-writeBookmark", title, url, type); } /// /// macOS: The text on the find pasteboard. This method uses synchronous IPC /// when called from the renderer process. The cached value is reread from the /// find pasteboard whenever the application is activated. /// /// [SupportedOSPlatform("macOS")] public Task ReadFindTextAsync() => this.InvokeAsync(); /// /// macOS: Writes the text into the find pasteboard as plain text. This method uses /// synchronous IPC when called from the renderer process. /// /// [SupportedOSPlatform("macOS")] public void WriteFindText(string text) { BridgeConnector.Socket.Emit("clipboard-writeFindText", text); } /// /// Clears the clipboard content. /// /// public void Clear(string type = "") { BridgeConnector.Socket.Emit("clipboard-clear", type); } /// /// An array of supported formats for the clipboard type. /// /// /// public Task AvailableFormatsAsync(string type = "") => this.InvokeAsync(type); /// /// Writes data to the clipboard. /// /// /// public void Write(Data data, string type = "") { BridgeConnector.Socket.Emit("clipboard-write", data, type); } /// /// Reads an image from the clipboard. /// /// /// public Task ReadImageAsync(string type = "") => this.InvokeAsync(type); /// /// Writes an image to the clipboard. /// /// /// public void WriteImage(NativeImage image, string type = "") { BridgeConnector.Socket.Emit("clipboard-writeImage", JsonSerializer.Serialize(image, ElectronJson.Options), type); } } } ================================================ FILE: src/ElectronNET.API/API/CommandLine.cs ================================================ using System.Threading; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Manipulate the command line arguments for your app that Chromium reads. /// public sealed class CommandLine { internal CommandLine() { } internal static CommandLine Instance { get { if (_commandLine == null) { lock (_syncRoot) { if (_commandLine == null) { _commandLine = new CommandLine(); } } } return _commandLine; } } private static CommandLine _commandLine; private static object _syncRoot = new object(); /// /// Append a switch (with optional value) to Chromium's command line. /// /// A command-line switch, without the leading -- /// (optional) - A value for the given switch /// /// Note: This will not affect process.argv. The intended usage of this function is to control Chromium's behavior. /// public void AppendSwitch(string the_switch, string value = "") { BridgeConnector.Socket.Emit("appCommandLineAppendSwitch", the_switch, value); } /// /// Append an argument to Chromium's command line. The argument will be quoted correctly. Switches will precede arguments regardless of appending order. /// /// If you're appending an argument like --switch=value, consider using appendSwitch('switch', 'value') instead. /// /// The argument to append to the command line /// /// Note: This will not affect process.argv. The intended usage of this function is to control Chromium's behavior. /// public void AppendArgument(string value) { BridgeConnector.Socket.Emit("appCommandLineAppendArgument", value); } /// /// Whether the command-line switch is present. /// /// A command-line switch /// /// Whether the command-line switch is present. public async Task HasSwitchAsync(string switchName, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("appCommandLineHasSwitchCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("appCommandLineHasSwitch", switchName); return await tcs.Task.ConfigureAwait(false); } } /// /// The command-line switch value. /// /// A command-line switch /// /// The command-line switch value. /// /// Note: When the switch is not present or has no value, it returns empty string. /// public async Task GetSwitchValueAsync(string switchName, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("appCommandLineGetSwitchValueCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("appCommandLineGetSwitchValue", switchName); return await tcs.Task.ConfigureAwait(false); } } } } ================================================ FILE: src/ElectronNET.API/API/Cookies.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System; using System.Text.Json; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Query and modify a session's cookies. /// public class Cookies { /// /// Gets the identifier. /// /// /// The identifier. /// public int Id { get; private set; } internal Cookies(int id) { Id = id; } /// /// Emitted when a cookie is changed because it was added, edited, removed, or expired. /// public event Action OnChanged { add { if (_changed == null) { BridgeConnector.Socket.On("webContents-session-cookies-changed" + Id, (args) => { var e = args.EnumerateArray().GetEnumerator(); e.MoveNext(); var cookie = e.Current.Deserialize(ElectronJson.Options); e.MoveNext(); var cause = e.Current.Deserialize(ElectronJson.Options); e.MoveNext(); var removed = e.Current.GetBoolean(); _changed(cookie, cause, removed); }); BridgeConnector.Socket.Emit("register-webContents-session-cookies-changed", Id); } _changed += value; } remove { _changed -= value; if (_changed == null) { BridgeConnector.Socket.Off("webContents-session-cookies-changed" + Id); } } } private event Action _changed; /// /// Sends a request to get all cookies matching filter, and resolves a callack with the response. /// /// /// /// A task which resolves an array of cookie objects. public Task GetAsync(CookieFilter filter) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-cookies-get-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-cookies-get", Id, filter, guid); return tcs.Task; } /// /// /// /// /// public Task SetAsync(CookieDetails details) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-cookies-set-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-cookies-set", Id, details, guid); return tcs.Task; } /// /// Removes the cookies matching url and name /// /// The URL associated with the cookie. /// The name of cookie to remove. /// A task which resolves when the cookie has been removed public Task RemoveAsync(string url, string name) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-cookies-remove-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-cookies-remove", Id, url, name, guid); return tcs.Task; } /// /// Writes any unwritten cookies data to disk. /// /// A task which resolves when the cookie store has been flushed public Task FlushStoreAsync() { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-cookies-flushStore-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-cookies-flushStore", Id, guid); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/Dialog.cs ================================================ using ElectronNET.API.Entities; using System; using System.Runtime.Versioning; using System.Text.Json; 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; private static object _syncRoot = new object(); internal Dialog() { } internal static Dialog Instance { get { if (_dialog == null) { lock (_syncRoot) { if (_dialog == null) { _dialog = new Dialog(); } } } return _dialog; } } /// /// Note: On Windows and Linux an open dialog can not be both a file selector /// and a directory selector, so if you set properties to ['openFile', 'openDirectory'] /// on these platforms, a directory selector will be shown. /// /// The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. /// /// An array of file paths chosen by the user public Task ShowOpenDialogAsync(BrowserWindow browserWindow, OpenDialogOptions options) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("showOpenDialogComplete" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("showOpenDialog", browserWindow, options, guid); return tcs.Task; } /// /// Dialog for save files. /// /// The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. /// /// Returns String, the path of the file chosen by the user, if a callback is provided it returns an empty string. public Task ShowSaveDialogAsync(BrowserWindow browserWindow, SaveDialogOptions options) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("showSaveDialogComplete" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("showSaveDialog", browserWindow, options, guid); return tcs.Task; } /// /// Shows a message box, it will block the process until the message box is closed. /// It returns the index of the clicked button. The browserWindow argument allows /// the dialog to attach itself to a parent window, making it modal. If a callback /// is passed, the dialog will not block the process.The API call will be /// asynchronous and the result will be passed via callback(response). /// /// /// The API call will be asynchronous and the result will be passed via MessageBoxResult. public async Task ShowMessageBoxAsync(string message) { return await this.ShowMessageBoxAsync(null, new MessageBoxOptions(message)).ConfigureAwait(false); } /// /// Shows a message box, it will block the process until the message box is closed. /// It returns the index of the clicked button. The browserWindow argument allows /// the dialog to attach itself to a parent window, making it modal. If a callback /// is passed, the dialog will not block the process.The API call will be /// asynchronous and the result will be passed via callback(response). /// /// /// The API call will be asynchronous and the result will be passed via MessageBoxResult. public async Task ShowMessageBoxAsync(MessageBoxOptions messageBoxOptions) { return await this.ShowMessageBoxAsync(null, messageBoxOptions).ConfigureAwait(false); } /// /// Shows a message box, it will block the process until the message box is closed. /// It returns the index of the clicked button. If a callback /// is passed, the dialog will not block the process. /// /// The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. /// /// The API call will be asynchronous and the result will be passed via MessageBoxResult. public async Task ShowMessageBoxAsync(BrowserWindow browserWindow, string message) { return await this.ShowMessageBoxAsync(browserWindow, new MessageBoxOptions(message)).ConfigureAwait(false); } /// /// Shows a message box, it will block the process until the message box is closed. /// It returns the index of the clicked button. If a callback /// is passed, the dialog will not block the process. /// /// The browserWindow argument allows the dialog to attach itself to a parent window, making it modal. /// /// The API call will be asynchronous and the result will be passed via MessageBoxResult. public Task ShowMessageBoxAsync(BrowserWindow browserWindow, MessageBoxOptions messageBoxOptions) { var tcs = new TaskCompletionSource(); var guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("showMessageBoxComplete" + guid, (args) => { // args is [response:int, checkboxChecked:boolean] var arr = args.EnumerateArray(); var e = arr.GetEnumerator(); e.MoveNext(); var response = e.Current.GetInt32(); e.MoveNext(); var checkbox = e.Current.GetBoolean(); tcs.SetResult(new MessageBoxResult { Response = response, CheckboxChecked = checkbox }); }); if (browserWindow == null) { BridgeConnector.Socket.Emit("showMessageBox", messageBoxOptions, guid); } else { BridgeConnector.Socket.Emit("showMessageBox", browserWindow, messageBoxOptions, guid); } return tcs.Task; } /// /// Displays a modal dialog that shows an error message. /// /// This API can be called safely before the ready event the app module emits, /// it is usually used to report errors in early stage of startup.If called /// before the app readyevent on Linux, the message will be emitted to stderr, /// and no GUI dialog will appear. /// /// The title to display in the error box. /// The text content to display in the error box. public void ShowErrorBox(string title, string content) { BridgeConnector.Socket.Emit("showErrorBox", title, content); } /// /// On macOS, this displays a modal dialog that shows a message and certificate information, /// and gives the user the option of trusting/importing the certificate. If you provide a /// browserWindow argument the dialog will be attached to the parent window, making it modal. /// /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task ShowCertificateTrustDialogAsync(CertificateTrustDialogOptions options) { return ShowCertificateTrustDialogAsync(null, options); } /// /// On macOS, this displays a modal dialog that shows a message and certificate information, /// and gives the user the option of trusting/importing the certificate. If you provide a /// browserWindow argument the dialog will be attached to the parent window, making it modal. /// /// /// /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task ShowCertificateTrustDialogAsync(BrowserWindow browserWindow, CertificateTrustDialogOptions options) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("showCertificateTrustDialogComplete" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("showCertificateTrustDialog", browserWindow, options, guid); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/Dock.cs ================================================ using System.Collections.Generic; using System.Runtime.Versioning; using System.Threading; using System.Threading.Tasks; using ElectronNET.API.Entities; using ElectronNET.API.Extensions; namespace ElectronNET.API { /// /// Control your app in the macOS dock. /// [SupportedOSPlatform("macOS")] public sealed class Dock { private static Dock _dock; private static object _syncRoot = new object(); internal Dock() { } internal static Dock Instance { get { if (_dock == null) { lock (_syncRoot) { if (_dock == null) { _dock = new Dock(); } } } return _dock; } } /// /// When is passed, the dock icon will bounce until either the application becomes /// active or the request is canceled. When is passed, the dock icon will bounce /// for one second. However, the request remains active until either the application becomes active or the request is canceled. /// /// Note: This method can only be used while the app is not focused; when the app is focused it will return -1. /// /// Can be critical or informational. The default is informational. /// The cancellation token. /// Return an ID representing the request. public async Task BounceAsync(DockBounceType type, CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("dock-bounce-completed", tcs.SetResult); BridgeConnector.Socket.Emit("dock-bounce", type); return await tcs.Task .ConfigureAwait(false); } } /// /// Cancel the bounce of id. /// /// Id of the request. public void CancelBounce(int id) { BridgeConnector.Socket.Emit("dock-cancelBounce", id); } /// /// Bounces the Downloads stack if the filePath is inside the Downloads folder. /// /// public void DownloadFinished(string filePath) { BridgeConnector.Socket.Emit("dock-downloadFinished", filePath); } /// /// Sets the string to be displayed in the dock’s badging area. /// /// public void SetBadge(string text) { BridgeConnector.Socket.Emit("dock-setBadge", text); } /// /// Gets the string to be displayed in the dock’s badging area. /// /// The cancellation token. /// The badge string of the dock. public async Task GetBadgeAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("dock-getBadge-completed", tcs.SetResult); BridgeConnector.Socket.Emit("dock-getBadge"); return await tcs.Task .ConfigureAwait(false); } } /// /// Hides the dock icon. /// public void Hide() { BridgeConnector.Socket.Emit("dock-hide"); } /// /// Shows the dock icon. /// public void Show() { BridgeConnector.Socket.Emit("dock-show"); } /// /// Whether the dock icon is visible. The app.dock.show() call is asynchronous /// so this method might not return true immediately after that call. /// /// The cancellation token. /// Whether the dock icon is visible. public async Task IsVisibleAsync(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("dock-isVisible-completed", tcs.SetResult); BridgeConnector.Socket.Emit("dock-isVisible"); return await tcs.Task .ConfigureAwait(false); } } /// /// Gets the dock menu items. /// /// /// The menu items. /// public IReadOnlyCollection MenuItems { get { return _items.AsReadOnly(); } } private List _items = new List(); /// /// Sets the application's dock menu. /// public void SetMenu(MenuItem[] menuItems) { menuItems.AddMenuItemsId(); BridgeConnector.Socket.Emit("dock-setMenu", new[] { menuItems }); _items.AddRange(menuItems); BridgeConnector.Socket.Off("dockMenuItemClicked"); BridgeConnector.Socket.On("dockMenuItemClicked", (id) => { MenuItem menuItem = _items.GetMenuItem(id); menuItem?.Click(); }); } /// /// TODO: Menu (macOS) still to be implemented /// Gets the application's dock menu. /// public async Task GetMenu(CancellationToken cancellationToken = default) { cancellationToken.ThrowIfCancellationRequested(); var tcs = new TaskCompletionSource(); using (cancellationToken.Register(() => tcs.TrySetCanceled())) { BridgeConnector.Socket.Once("dock-getMenu-completed", tcs.SetResult); BridgeConnector.Socket.Emit("dock-getMenu"); return await tcs.Task .ConfigureAwait(false); } } /// /// Sets the image associated with this dock icon. /// /// public void SetIcon(string image) { BridgeConnector.Socket.Emit("dock-setIcon", image); } } } ================================================ FILE: src/ElectronNET.API/API/Electron.cs ================================================ namespace ElectronNET.API { /// /// The Electron.NET API /// public static class Electron { /// /// Communicate asynchronously from the main process to renderer processes. /// public static IpcMain IpcMain { get { return IpcMain.Instance; } } /// /// Control your application's event lifecycle. /// public static App App { get { return App.Instance; } } /// /// Enable apps to automatically update themselves. Based on electron-updater. /// public static AutoUpdater AutoUpdater { get { return AutoUpdater.Instance; } } /// /// Control your windows. /// public static WindowManager WindowManager { get { return WindowManager.Instance; } } /// /// Create native application menus and context menus. /// public static Menu Menu { get { return Menu.Instance; } } /// /// Display native system dialogs for opening and saving files, alerting, etc. /// public static Dialog Dialog { get { return Dialog.Instance; } } /// /// Create OS desktop notifications /// public static Notification Notification { get { return Notification.Instance; } } /// /// Add icons and context menus to the system’s notification area. /// public static Tray Tray { get { return Tray.Instance; } } /// /// Detect keyboard events when the application does not have keyboard focus. /// public static GlobalShortcut GlobalShortcut { get { return GlobalShortcut.Instance; } } /// /// Manage files and URLs using their default applications. /// public static Shell Shell { get { return Shell.Instance; } } /// /// Retrieve information about screen size, displays, cursor position, etc. /// public static Screen Screen { get { return Screen.Instance; } } /// /// Perform copy and paste operations on the system clipboard. /// public static Clipboard Clipboard { get { return Clipboard.Instance; } } /// /// Allows you to execute native JavaScript/TypeScript code from the host process. /// /// It is only possible if the Electron.NET CLI has previously added an /// ElectronHostHook directory: /// electronize add HostHook /// public static HostHook HostHook { get { return HostHook.Instance; } } /// /// Allows you to execute native Lock and Unlock process. /// public static PowerMonitor PowerMonitor { get { return PowerMonitor.Instance; } } /// /// Read and respond to changes in Chromium's native color theme. /// public static NativeTheme NativeTheme { get { return NativeTheme.Instance; } } /// /// Control your app in the macOS dock. /// public static Dock Dock { get { return Dock.Instance; } } /// /// Electeon extensions to the Nodejs process object. /// public static Process Process { get { return Process.Instance; } } } } ================================================ FILE: src/ElectronNET.API/API/Entities/AboutPanelOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// About panel options. /// /// Up-to-date with Electron API 39.2 public class AboutPanelOptions { /// /// The app's name. /// public string ApplicationName { get; set; } /// /// The app's version. /// public string ApplicationVersion { get; set; } /// /// Copyright information. /// public string Copyright { get; set; } /// /// The app's build version number (macOS). /// [SupportedOSPlatform("macos")] public string Version { get; set; } /// /// Credit information (macOS, Windows). /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] public string Credits { get; set; } /// /// List of app authors (Linux). /// [SupportedOSPlatform("linux")] public string[] Authors { get; set; } /// /// The app's website (Linux). /// [SupportedOSPlatform("linux")] public string Website { get; set; } /// /// Path to the app's icon in a JPEG or PNG file format. On Linux, will be shown as 64x64 pixels while retaining aspect ratio. On Windows, a 48x48 PNG will result in the best visual quality. /// [SupportedOSPlatform("linux")] [SupportedOSPlatform("windows")] public string IconPath { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/AddRepresentationOptions.cs ================================================ using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class AddRepresentationOptions { /// /// Gets or sets the width in pixels. Defaults to 0. Required if a bitmap buffer is specified as . /// public int? Width { get; set; } /// /// Gets or sets the height in pixels. Defaults to 0. Required if a bitmap buffer is specified as . /// public int? Height { get; set; } /// /// Gets or sets the image scale factor. Defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; /// /// Gets or sets the buffer containing the raw image data. /// public byte[] Buffer { get; set; } /// /// Gets or sets the data URL containing a base 64 encoded PNG or JPEG image. /// public string DataUrl { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/AppDetailsOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class AppDetailsOptions { /// /// Window's App User Model ID. It has to be set, otherwise the other options will have no effect. /// public string AppId { get; set; } /// /// Window's relaunch icon resource path. /// public string AppIconPath { get; set; } /// /// Index of the icon in . Ignored when is not set. Default is 0. /// public int AppIconIndex { get; set; } /// /// Window's relaunch command. /// public string RelaunchCommand { get; set; } /// /// Window's relaunch display name. /// public string RelaunchDisplayName { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/AutoResizeOptions.cs ================================================ using System.ComponentModel; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class AutoResizeOptions { /// /// If `true`, the view's width will grow and shrink together with the window. /// `false` by default. /// [DefaultValue(false)] public bool Width { get; set; } = false; /// /// If `true`, the view's height will grow and shrink together with the window. /// `false` by default. /// [DefaultValue(false)] public bool Height { get; set; } = false; /// /// If `true`, the view's x position and width will grow and shrink proportionally /// with the window. `false` by default. /// [DefaultValue(false)] public bool Horizontal { get; set; } = false; /// /// If `true`, the view's y position and height will grow and shrink proportionally /// with the window. `false` by default. /// [DefaultValue(false)] public bool Vertical { get; set; } = false; } } ================================================ FILE: src/ElectronNET.API/API/Entities/BitmapOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class BitmapOptions { /// /// The image scale factor. Defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/Blob.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class Blob : IPostData { /// /// The object represents a Blob /// public string Type { get; } = "blob"; /// /// The UUID of the Blob being uploaded /// public string BlobUUID { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/BlockMapDataHolder.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// public class BlockMapDataHolder { /// /// The file size. Used to verify downloaded size (save one HTTP request to get length). /// Also used when block map data is embedded into the file(appimage, windows web installer package). /// public double Size { get; set; } /// /// The block map file size. Used when block map data is embedded into the file (appimage, windows web installer package). /// This information can be obtained from the file itself, but it requires additional HTTP request, /// so, to reduce request count, block map size is specified in the update metadata too. /// public double BlockMapSize { get; set; } /// /// The file checksum. /// public string Sha512 { get; set; } /// /// /// public bool IsAdminRightsRequired { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/BrowserViewConstructorOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class BrowserViewConstructorOptions { /// /// Gets or sets the web preferences for the view (see WebPreferences). /// public WebPreferences WebPreferences { get; set; } /// /// Gets or sets a proxy to use on creation in the format host:port. /// The proxy can be alternatively set using the BrowserView.WebContents.SetProxyAsync function. /// /// This is custom shortcut. Not part of the Electron API. public string Proxy { get; set; } /// /// Gets or sets the credentials of the proxy in the format username:password. /// These will only be used if the Proxy field is also set. /// /// This is custom shortcut. Not part of the Electron API. public string ProxyCredentials { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/BrowserWindowOptions.cs ================================================ using ElectronNET.Converter; using System.ComponentModel; using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// public class BrowserWindowOptions { /// /// Window's width in pixels. Default is 800. /// public int Width { get; set; } = 800; /// /// Window's height in pixels. Default is 600. /// public int Height { get; set; } = 600; /// /// ( if y is used) Window's left offset from screen. Default is to center the /// window. /// public int? X { get; set; } /// /// ( if x is used) Window's top offset from screen. Default is to center the /// window. /// public int? Y { get; set; } /// /// The width and height would be used as web page's size, which means the actual /// window's size will include window frame's size and be slightly larger. Default /// is false. /// public bool UseContentSize { get; set; } /// /// Show window in the center of the screen. /// public bool Center { get; set; } /// /// Window's minimum width. Default is 0. /// public int MinWidth { get; set; } /// /// Window's minimum height. Default is 0. /// public int MinHeight { get; set; } /// /// Window's maximum width. Default is no limit. /// public int MaxWidth { get; set; } /// /// Window's maximum height. Default is no limit. /// public int MaxHeight { get; set; } /// /// Whether window is resizable. Default is true. /// [DefaultValue(true)] public bool Resizable { get; set; } = true; /// /// Whether window is movable. This is not implemented on Linux. Default is true. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool Movable { get; set; } = true; /// /// Whether window is minimizable. This is not implemented on Linux. Default is true. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool Minimizable { get; set; } = true; /// /// Whether window is maximizable. This is not implemented on Linux. Default is true. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool Maximizable { get; set; } = true; /// /// Whether window is closable. This is not implemented on Linux. Default is true. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool Closable { get; set; } = true; /// /// Whether the window can be focused. Default is true. On Windows setting /// focusable: false also implies setting skipTaskbar: true. On Linux setting /// focusable: false makes the window stop interacting with wm, so the window will /// always stay on top in all workspaces. /// [DefaultValue(true)] public bool Focusable { get; set; } = true; /// /// Whether the window should always stay on top of other windows. Default is false. /// public bool AlwaysOnTop { get; set; } /// /// Whether the window should show in fullscreen. When explicitly set to false the /// fullscreen button will be hidden or disabled on macOS.Default is false. /// public bool Fullscreen { get; set; } /// /// Whether the window can be put into fullscreen mode. On macOS, also whether the /// maximize/zoom button should toggle full screen mode or maximize window. Default /// is true (Electron default). /// [DefaultValue(true)] public bool Fullscreenable { get; set; } = true; // FIX: previously defaulted to false in C# /// /// Whether to show the window in taskbar. Default is false. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] public bool SkipTaskbar { get; set; } /// /// Determines if Blazor is used. Will disable "module" and "process" globals. Default is false. /// public bool IsRunningBlazor { get; set; } /// /// The kiosk mode. Default is false. /// public bool Kiosk { get; set; } /// /// Default window title. Default is "Electron.NET". /// public string Title { get; set; } = "Electron.NET"; /// /// The window icon. Can be a NativeImage or a string path. On Windows it is recommended to use ICO icons; when undefined, the executable's icon will be used. /// public string Icon { get; set; } /// /// Whether window should be shown when created. Default is true. /// [DefaultValue(true)] public bool Show { get; set; } = true; /// /// Specify false to create a frameless window. Default is true. /// [DefaultValue(true)] public bool Frame { get; set; } = true; /// /// Whether this is a modal window. This only works when the window is a child /// window.Default is false. /// public bool Modal { get; set; } /// /// Whether the web view accepts a single mouse-down event that simultaneously /// activates the window.Default is false. /// [SupportedOSPlatform("macos")] public bool AcceptFirstMouse { get; set; } /// /// Whether to hide cursor when typing. Default is false. /// public bool DisableAutoHideCursor { get; set; } /// /// Auto hide the menu bar unless the Alt key is pressed. Default is false. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("linux")] public bool AutoHideMenuBar { get; set; } /// /// Enable the window to be resized larger than screen. Default is false. /// [SupportedOSPlatform("macos")] public bool EnableLargerThanScreen { get; set; } /// /// The window's background color in Hex, RGB, RGBA, HSL, HSLA or named CSS color format. Alpha in #AARRGGBB format is supported if transparent is set to true. Default is #FFF (white). /// public string BackgroundColor { get; set; } /// /// Initial opacity of the window, between 0.0 (fully transparent) and 1.0 (fully opaque). Only implemented on Windows and macOS. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("macos")] public double? Opacity { get; set; } /// /// Whether window should have a shadow. Default is true. /// public bool HasShadow { get; set; } /// /// Forces using dark theme for the window, only works on some GTK+3 desktop environments. Default is false. /// public bool DarkTheme { get; set; } /// /// Makes the window transparent. Default is false. /// public bool Transparent { get; set; } /// /// The type of window, default is normal window. /// public string Type { get; set; } /// /// The style of window title bar. Default is default. Possible values are: /// 'default' | 'hidden' | 'hiddenInset' | 'customButtonsOnHover' /// public TitleBarStyle TitleBarStyle { get; set; } /// /// Set a custom position for the traffic light buttons in frameless windows (macOS). /// [SupportedOSPlatform("macos")] public Point TrafficLightPosition { get; set; } /// /// Configures the window's title bar overlay when using a frameless window. /// Can be either: /// - false: No title bar overlay. /// - true: Enables the default title bar overlay. /// - An object defining custom overlay options (such as height, color, etc.). /// /// Default is false. /// [JsonConverter(typeof(TitleBarOverlayConverter))] public TitleBarOverlay TitleBarOverlay { get; set; } /// /// Shows the title in the title bar in full screen mode on macOS for all titleBarStyle options. Default is false. /// /// Not documented by MCP base-window-options / browser-window-options. public bool FullscreenWindowTitle { get; set; } /// /// Use WS_THICKFRAME style for frameless windows on Windows, which adds standard /// window frame.Setting it to false will remove window shadow and window /// animations. Default is true. /// [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool ThickFrame { get; set; } = true; /// /// Whether frameless window should have rounded corners. Default is true. Setting this /// property to false will prevent the window from being fullscreenable on macOS. On /// Windows versions older than Windows 11 Build 22000 this property has no effect, and /// frameless windows will not have rounded corners. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] [DefaultValue(true)] public bool RoundedCorners { get; set; } = true; /// /// Add a type of vibrancy effect to the window, only on macOS. Can be /// appearance-based, titlebar, selection, menu, popover, sidebar, header, sheet, /// window, hud, fullscreen-ui, tooltip, content, under-window, or under-page. /// [SupportedOSPlatform("macos")] public Vibrancy Vibrancy { get; set; } /// /// Controls the behavior on macOS when option-clicking the green stoplight button /// on the toolbar or by clicking the Window > Zoom menu item.If true, the window /// will grow to the preferred width of the web page when zoomed, false will cause /// it to zoom to the width of the screen.This will also affect the behavior when /// calling maximize() directly.Default is false. /// [SupportedOSPlatform("macos")] public bool ZoomToPageWidth { get; set; } /// /// Tab group name, allows opening the window as a native tab on macOS 10.12+. /// Windows with the same tabbing identifier will be grouped together.This also /// adds a native new tab button to your window's tab bar and allows your app and /// window to receive the new-window-for-tab event. /// [SupportedOSPlatform("macos")] public string TabbingIdentifier { get; set; } /// /// Settings of web page's features. /// public WebPreferences WebPreferences { get; set; } /// /// A proxy to set on creation in the format host:port. /// The proxy can be alternatively set using the BrowserWindow.WebContents.SetProxyAsync function. /// /// Not documented by MCP base-window-options / browser-window-options. public string Proxy { get; set; } /// /// The credentials of the Proxy in the format username:password. /// These will only be used if the Proxy field is also set. /// /// Not documented by MCP base-window-options / browser-window-options. public string ProxyCredentials { get; set; } /// /// Gets or sets whether to use pre-Lion fullscreen on macOS. Default is false. /// [SupportedOSPlatform("macos")] public bool SimpleFullscreen { get; set; } /// /// Gets or sets whether the window should be hidden when the user toggles into mission control (macOS). /// [SupportedOSPlatform("macos")] public bool HiddenInMissionControl { get; set; } /// /// Gets or sets how the material appearance should reflect window activity state on macOS. Must be used with the vibrancy property. /// Possible values: 'followWindow' (default), 'active', 'inactive'. /// [SupportedOSPlatform("macos")] public string VisualEffectState { get; set; } /// /// Gets or sets the system-drawn background material on Windows. Can be 'auto', 'none', 'mica', 'acrylic' or 'tabbed'. /// [SupportedOSPlatform("windows")] public string BackgroundMaterial { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CPUUsage.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CPUUsage { /// /// Percentage of CPU used since the last call to getCPUUsage. First call returns 0. /// public double PercentCPUUsage { get; set; } /// /// Total seconds of CPU time used since process startup, if available. /// public double? CumulativeCPUUsage { get; set; } /// /// The number of average idle CPU wakeups per second since the last call to /// getCPUUsage. First call returns 0. Will always return 0 on Windows. /// public double IdleWakeupsPerSecond { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Certificate.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class Certificate { /// /// PEM encoded data /// public string Data { get; set; } /// /// Fingerprint of the certificate /// public string Fingerprint { get; set; } /// /// Issuer principal /// public CertificatePrincipal Issuer { get; set; } /// /// Issuer certificate (if not self-signed) /// public Certificate IssuerCert { get; set; } /// /// Issuer's Common Name /// public string IssuerName { get; set; } /// /// Hex value represented string /// public string SerialNumber { get; set; } /// /// Subject principal /// public CertificatePrincipal Subject { get; set; } /// /// Subject's Common Name /// public string SubjectName { get; set; } /// /// End date of the certificate being valid in seconds /// public int ValidExpiry { get; set; } /// /// Start date of the certificate being valid in seconds /// public int ValidStart { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CertificatePrincipal.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CertificatePrincipal { /// /// Common Name /// public string CommonName { get; set; } /// /// Country or region /// public string Country { get; set; } /// /// Locality /// public string Locality { get; set; } /// /// Organization names /// public string[] Organizations { get; set; } /// /// Organization Unit names /// public string[] OrganizationUnits { get; set; } /// /// State or province /// public string State { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CertificateTrustDialogOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CertificateTrustDialogOptions { /// /// The certificate to trust/import. /// public Certificate Certificate { get; set; } /// /// The message to display to the user. /// public string Message { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ChromeExtensionInfo.cs ================================================ namespace ElectronNET.API.Entities { /// /// Provide metadata about the current loaded Chrome extension /// /// Project-specific: no matching Electron structure found in MCP docs (electronjs). public class ChromeExtensionInfo { /// /// Initializes a new instance of the class. /// /// The name of the Chrome extension. /// The version of the Chrome extension. public ChromeExtensionInfo(string name, string version) { Name = name; Version = version; } /// /// Name of the Chrome extension /// public string Name { get; set; } /// /// Version of the Chrome extension /// public string Version { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ClearStorageDataOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class ClearStorageDataOptions { /// /// Should follow window.location.origin’s representation scheme://host:port. /// public string Origin { get; set; } /// /// The types of storages to clear. Can contain: cookies, filesystem, indexdb, /// localstorage, shadercache, websql, serviceworkers, cachestorage. /// If not specified, all storage types are cleared. /// public string[] Storages { get; set; } /// /// The types of quotas to clear. Can contain: temporary. If not specified, /// all quotas are cleared. The quotas option is deprecated; /// "temporary" is the only remaining supported quota type. /// public string[] Quotas { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Cookie.cs ================================================ namespace ElectronNET.API.Entities { /// /// Cookie structure as used by Electron session.cookies APIs. /// /// Up-to-date with Electron API 39.2 public class Cookie { /// /// Gets or sets the name of the cookie. /// public string Name { get; set; } /// /// Gets or sets the value of the cookie. /// public string Value { get; set; } /// /// Gets or sets the domain of the cookie; this will be normalized with a preceding dot so that it's also valid for subdomains. /// public string Domain { get; set; } /// /// Gets or sets a value indicating whether the cookie is a host-only cookie; this will only be true if no domain was passed. /// public bool? HostOnly { get; set; } /// /// Gets or sets the path of the cookie. /// public string Path { get; set; } /// /// Gets or sets a value indicating whether the cookie is marked as secure. /// public bool? Secure { get; set; } /// /// Gets or sets a value indicating whether the cookie is marked as HTTP only. /// public bool? HttpOnly { get; set; } /// /// Gets or sets a value indicating whether the cookie is a session cookie or a persistent cookie with an expiration date. /// public bool? Session { get; set; } /// /// Gets or sets the expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies. /// public double? ExpirationDate { get; set; } /// /// Gets or sets the SameSite policy applied to this cookie. Can be "unspecified", "no_restriction", "lax" or "strict". /// public string SameSite { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CookieChangedCause.cs ================================================ namespace ElectronNET.API.Entities { using System.Text.Json.Serialization; /// /// The cause of the cookie change (per Electron Cookies 'changed' event). /// public enum CookieChangedCause { /// /// The cookie was changed directly by a consumer's action. /// @explicit, /// /// The cookie was automatically removed due to an insert operation that overwrote it. /// overwrite, /// /// The cookie was automatically removed as it expired. /// expired, /// /// The cookie was automatically evicted during garbage collection. /// evicted, /// /// The cookie was overwritten with an already-expired expiration date. /// [JsonPropertyName("expired_overwrite")] expiredOverwrite } } ================================================ FILE: src/ElectronNET.API/API/Entities/CookieDetails.cs ================================================ using System.ComponentModel; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CookieDetails { /// /// Gets or sets the URL to associate the cookie with. The operation will be rejected if the URL is invalid. /// public string Url { get; set; } /// /// Gets or sets the name of the cookie. Empty by default if omitted. /// [DefaultValue("")] public string Name { get; set; } /// /// Gets or sets the value of the cookie. Empty by default if omitted. /// [DefaultValue("")] public string Value { get; set; } /// /// Gets or sets the domain of the cookie; this will be normalized with a preceding dot so that it's also valid for subdomains. Empty by default if omitted. /// [DefaultValue("")] public string Domain { get; set; } /// /// Gets or sets the path of the cookie. Empty by default if omitted. /// [DefaultValue("")] public string Path { get; set; } /// /// Gets or sets a value indicating whether the cookie should be marked as secure. Defaults to false unless the SameSite policy is set to no_restriction (SameSite=None). /// [DefaultValue(false)] public bool Secure { get; set; } /// /// Gets or sets a value indicating whether the cookie should be marked as HTTP only. Defaults to false. /// [DefaultValue(false)] public bool HttpOnly { get; set; } /// /// Gets or sets the expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie and will not be retained between sessions. /// [DefaultValue(0)] public double ExpirationDate { get; set; } /// /// Gets or sets the SameSite policy to apply to this cookie. Can be "unspecified", "no_restriction", "lax" or "strict". Default is "lax". /// public string SameSite { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CookieFilter.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CookieFilter { /// /// (optional) - Retrieves cookies which are associated with url. Empty implies retrieving cookies of all URLs. /// public string Url { get; set; } /// /// (optional) - Filters cookies by name. /// public string Name { get; set; } /// /// (optional) - Retrieves cookies whose domains match or are subdomains of domains. /// public string Domain { get; set; } /// /// (optional) - Retrieves cookies whose path matches path. /// public string Path { get; set; } /// /// (optional) - Filters cookies by their Secure property. /// public bool? Secure { get; set; } /// /// (optional) - Filters out session or persistent cookies. /// public bool? Session { get; set; } /// /// (optional) - Filters cookies by httpOnly. /// public bool? HttpOnly { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/CreateFromBitmapOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CreateFromBitmapOptions { /// /// Gets or sets the width in pixels. Required for nativeImage.createFromBitmap(buffer, options). /// public int? Width { get; set; } /// /// Gets or sets the height in pixels. Required for nativeImage.createFromBitmap(buffer, options). /// public int? Height { get; set; } /// /// Gets or sets the image scale factor. Optional, defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/CreateFromBufferOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CreateFromBufferOptions { /// /// Gets or sets the width. Required for bitmap buffers passed to nativeImage.createFromBuffer. /// public int? Width { get; set; } /// /// Gets or sets the height. Required for bitmap buffers passed to nativeImage.createFromBuffer. /// public int? Height { get; set; } /// /// The image scale factor. Optional, defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/CreateInterruptedDownloadOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class CreateInterruptedDownloadOptions { /// /// Absolute path of the download. /// public string Path { get; set; } /// /// Complete URL chain for the download. /// public string[] UrlChain { get; set; } /// /// (optional) - MIME type of the download. /// public string MimeType { get; set; } /// /// Start range for the download. /// public int Offset { get; set; } /// /// Total length of the download. /// public int Length { get; set; } /// /// Last-Modified header value. /// public string LastModified { get; set; } /// /// ETag header value. /// public string ETag { get; set; } /// /// (optional) - Time when download was started in number of seconds since UNIX epoch. /// Electron documents this as a Number (Double). /// public double? StartTime { get; set; } /// /// /// /// Absolute path of the download. /// Complete URL chain for the download. /// Start range for the download. /// Total length of the download. /// Last-Modified header value. /// ETag header value. public CreateInterruptedDownloadOptions(string path, string[] urlChain, int offset, int length, string lastModified, string eTag) { Path = path; UrlChain = urlChain; Offset = offset; Length = length; LastModified = lastModified; ETag = eTag; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Data.cs ================================================ 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 image. /// Maps to clipboard.write({ image: NativeImage }). /// public NativeImage Image { get; set; } /// /// Gets or sets the RTF. /// /// /// The RTF. /// public string Rtf { get; set; } /// /// The title of the url at text. /// public string Bookmark { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/DefaultFontFamily.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// public class DefaultFontFamily { /// /// Defaults to Times New Roman. /// public string Standard { get; set; } /// /// Defaults to Times New Roman. /// public string Serif { get; set; } /// /// Defaults to Arial. /// public string SansSerif { get; set; } /// /// Defaults to Courier New. /// public string Monospace { get; set; } /// /// Defaults to Script. /// public string Cursive { get; set; } /// /// Defaults to Impact. /// public string Fantasy { get; set; } /// /// Defaults to Latin Modern Math. /// public string Math { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/DevToolsMode.cs ================================================ namespace ElectronNET.API.Entities { /// /// Opens the devtools with specified dock state, can be left, right, bottom, undocked, /// detach. Defaults to last used dock state. In undocked mode it's possible to dock /// back. In detach mode it's not. /// public enum DevToolsMode { /// /// The right /// right, /// /// The bottom /// bottom, /// /// The undocked /// undocked, /// /// The detach /// detach, /// /// The left /// left, } } ================================================ FILE: src/ElectronNET.API/API/Entities/Display.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class Display { /// /// Gets or sets the accelerometer support status; can be 'available', 'unavailable', or 'unknown'. /// public string AccelerometerSupport { get; set; } /// /// Gets or sets the bounds. /// /// /// The bounds of the display in DIP points. /// public Rectangle Bounds { get; set; } /// /// Gets or sets the number of bits per pixel. /// public int ColorDepth { get; set; } /// /// Gets or sets the color space description used for color conversions. /// public string ColorSpace { get; set; } /// /// Gets or sets the number of bits per color component. /// public int DepthPerComponent { get; set; } /// /// Gets or sets a value indicating whether the display is detected by the system. /// public bool Detected { get; set; } /// /// Gets or sets the display refresh rate. /// public double DisplayFrequency { get; set; } /// /// Gets or sets the unique identifier associated with the display. A value of -1 means the display is invalid or the correct id is not yet known, and a value of -10 means the display is a virtual display assigned to a unified desktop. /// public long Id { get; set; } /// /// Gets or sets a value indicating whether the display is internal (true) or external (false). /// public bool Internal { get; set; } /// /// Gets or sets the user-friendly label, determined by the platform. /// public string Label { get; set; } /// /// Gets or sets the maximum cursor size in native pixels. /// public Size MaximumCursorSize { get; set; } /// /// Gets or sets the display's origin in pixel coordinates. Only available on windowing systems that position displays in pixel coordinates (e.g., X11). /// public Point NativeOrigin { get; set; } /// /// Gets or sets the screen rotation in clock-wise degrees. Can be 0, 90, 180, or 270. /// public int Rotation { get; set; } /// /// Gets or sets the output device's pixel scale factor. /// public double ScaleFactor { get; set; } /// /// Gets or sets the touch support status; can be 'available', 'unavailable', or 'unknown'. /// public string TouchSupport { get; set; } /// /// Gets or sets a value indicating whether the display is monochrome. /// public bool Monochrome { get; set; } /// /// Gets or sets the size. /// /// /// The size. /// public Size Size { get; set; } /// /// Gets or sets the work area of the display in DIP points. /// /// /// The work area of the display in DIP points. /// 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; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/DisplayBalloonOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API { /// /// /// public enum DisplayBalloonIconType { none, info, warning, error, custom } /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] 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; } /// /// (optional) - Icon type for the balloon: none, info, warning, error or custom. /// Default is custom. /// public DisplayBalloonIconType IconType { get; set; } = DisplayBalloonIconType.custom; /// /// (optional) - Use the large version of the icon. Default is true. /// Maps to Windows NIIF_LARGE_ICON. /// public bool LargeIcon { get; set; } = true; /// /// (optional) - Do not play the associated sound. Default is false. /// Maps to Windows NIIF_NOSOUND. /// public bool NoSound { get; set; } /// /// (optional) - Do not display the balloon if the current user is in "quiet time". /// Default is false. Maps to Windows NIIF_RESPECT_QUIET_TIME. /// public bool RespectQuietTime { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/DockBounceType.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Defines the DockBounceType enumeration. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macOS")] public enum DockBounceType { /// /// Dock icon will bounce until either the application becomes active or the request is canceled. /// [Description("critical")] Critical, /// /// The dock icon will bounce for one second. /// [Description("informational")] Informational } } ================================================ FILE: src/ElectronNET.API/API/Entities/EnableNetworkEmulationOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class EnableNetworkEmulationOptions { /// /// Whether to emulate network outage. Defaults to false. /// public bool Offline { get; set; } = false; /// /// RTT in ms. Defaults to 0 which will disable latency throttling. /// Electron documents this as a Number (Double). /// public double Latency { get; set; } /// /// Download rate in Bps. Defaults to 0 which will disable download throttling. /// Electron documents this as a Number (Double). /// public double DownloadThroughput { get; set; } /// /// Upload rate in Bps. Defaults to 0 which will disable upload throttling. /// Electron documents this as a Number (Double). /// public double UploadThroughput { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Extension.cs ================================================ namespace ElectronNET.API.Entities { /// /// Docs: https://electronjs.org/docs/api/structures/extension /// /// Up-to-date with Electron API 39.2 public class Extension { /// /// /// public string Id { get; set; } /// /// Copy of the extension's manifest data. /// public dynamic Manifest { get; set; } /// /// /// public string Name { get; set; } /// /// The extension's file path. /// public string Path { get; set; } /// /// The extension's `chrome-extension://` URL. /// public string Url { get; set; } /// /// /// public string Version { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/FileFilter.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 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; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/FileIconOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class FileIconOptions { /// /// The requested icon size string passed to app.getFileIcon: /// "small" (16x16), "normal" (32x32), or "large" (48x48 on Linux, 32x32 on Windows; unsupported on macOS). /// 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(); } } } ================================================ FILE: src/ElectronNET.API/API/Entities/FileIconSize.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public enum FileIconSize { /// /// small - 16x16 (per app.getFileIcon size mapping). /// small, /// /// normal - 32x32 (per app.getFileIcon size mapping). /// normal, /// /// large - 48x48 on Linux, 32x32 on Windows, unsupported on macOS (per app.getFileIcon size mapping). /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("Windows")] large } } ================================================ FILE: src/ElectronNET.API/API/Entities/FocusOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Controls the behavior of . /// /// Up-to-date with Electron API 39.2 public class FocusOptions { /// /// Make the receiver the active app even if another app is currently active. /// You should seek to use the steal option as sparingly as possible. /// [SupportedOSPlatform("macOS")] public bool Steal { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/GPUFeatureStatus.cs ================================================ using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// /// Graphics Feature Status from chrome://gpu/ as returned by app.getGPUFeatureStatus(). /// Each field reflects the status of a GPU capability reported by Chromium. /// /// Possible values for all fields: /// - disabled_software: Software only. Hardware acceleration disabled (yellow) /// - disabled_off: Disabled (red) /// - disabled_off_ok: Disabled (yellow) /// - unavailable_software: Software only, hardware acceleration unavailable (yellow) /// - unavailable_off: Unavailable (red) /// - unavailable_off_ok: Unavailable (yellow) /// - enabled_readback: Hardware accelerated but at reduced performance (yellow) /// - enabled_force: Hardware accelerated on all pages (green) /// - enabled: Hardware accelerated (green) /// - enabled_on: Enabled (green) /// - enabled_force_on: Force enabled (green) /// /// Up-to-date with Electron API 39.2 public class GPUFeatureStatus { /// /// Gets or sets the status for Canvas. /// [JsonPropertyName("2d_canvas")] public string Canvas { get; set; } /// /// Gets or sets the status for Flash. /// [JsonPropertyName("flash_3d")] public string Flash3D { get; set; } /// /// Gets or sets the status for Flash Stage3D. /// [JsonPropertyName("flash_stage3d")] public string FlashStage3D { get; set; } /// /// Gets or sets the status for Flash Stage3D Baseline profile. /// [JsonPropertyName("flash_stage3d_baseline")] public string FlashStage3dBaseline { get; set; } /// /// Gets or sets the status for Compositing. /// [JsonPropertyName("gpu_compositing")] public string GpuCompositing { get; set; } /// /// Gets or sets the status for Multiple Raster Threads. /// [JsonPropertyName("multiple_raster_threads")] public string MultipleRasterThreads { get; set; } /// /// Gets or sets the status for Native GpuMemoryBuffers. /// [JsonPropertyName("native_gpu_memory_buffers")] public string NativeGpuMemoryBuffers { get; set; } /// /// Gets or sets the status for Rasterization. /// public string Rasterization { get; set; } /// /// Gets or sets the status for Video Decode. /// [JsonPropertyName("video_decode")] public string VideoDecode { get; set; } /// /// Gets or sets the status for Video Encode. /// [JsonPropertyName("video_encode")] public string VideoEncode { get; set; } /// /// Gets or sets the status for VPx Video Decode. /// [JsonPropertyName("vpx_decode")] public string VpxDecode { get; set; } /// /// Gets or sets the status for WebGL. /// public string Webgl { get; set; } /// /// Gets or sets the status for WebGL2. /// public string Webgl2 { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/IPostData.cs ================================================ namespace ElectronNET.API.Entities { /// /// Represents a postData item for loadURL/webContents.loadURL options. /// Valid types per Electron docs: 'rawData' and 'file'. /// /// Up-to-date with Electron API 39.2 public interface IPostData { /// /// One of the following: /// rawData - . /// file - . /// Based on Electron postData definitions. /// public string Type { get; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ImportCertificateOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Options for app.importCertificate(options) on Linux. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("linux")] public class ImportCertificateOptions { /// /// Path for the pkcs12 file. /// public string Certificate { get; set; } /// /// Passphrase for the certificate. /// public string Password { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/InputEvent.cs ================================================ using System.Collections.Generic; namespace ElectronNET.API.Entities { using ElectronNET.Converter; using System.Text.Json.Serialization; /// /// Input event payload as used by webContents 'input-event' and 'before-input-event'. /// Fields map to KeyboardEvent properties where noted, and type/modifiers follow Electron's InputEvent structure. /// /// Up-to-date with Electron API 39.2 public class InputEvent { /// /// Equivalent to KeyboardEvent.key. /// public string Key { get; set; } = ""; /// /// Equivalent to KeyboardEvent.code. /// public string Code { get; set; } = ""; /// /// Equivalent to KeyboardEvent.repeat. /// public bool IsAutoRepeat { get; set; } = false; /// /// Equivalent to KeyboardEvent.isComposing. /// public bool IsComposing { get; set; } = false; /// /// Equivalent to KeyboardEvent.shiftKey. /// public bool Shift { get; set; } = false; /// /// Equivalent to KeyboardEvent.controlKey. /// public bool Control { get; set; } = false; /// /// Equivalent to KeyboardEvent.altKey. /// public bool Alt { get; set; } = false; /// /// Equivalent to KeyboardEvent.metaKey. /// public bool Meta { get; set; } = false; /// /// Equivalent to KeyboardEvent.location. /// public int Location { get; set; } = 0; /// /// An array of modifiers of the event, can be `shift`, `control`, `ctrl`, `alt`, /// `meta`, `command`, `cmd`, `iskeypad`, `isautorepeat`, `leftbuttondown`, /// `middlebuttondown`, `rightbuttondown`, `capslock`, `numlock`, `left`, `right`. /// [JsonConverter(typeof(ModifierTypeListConverter))] public List Modifiers { get; set; } /// /// For MouseInputEvent: The x-coordinate of the event (Integer). /// public int? X { get; set; } /// /// For MouseInputEvent: The y-coordinate of the event (Integer). /// public int? Y { get; set; } /// /// For MouseInputEvent: The button pressed, can be 'left', 'middle', or 'right' (optional). /// public string Button { get; set; } /// /// For MouseInputEvent: Global x in screen coordinates (Integer, optional). /// public int? GlobalX { get; set; } /// /// For MouseInputEvent: Global y in screen coordinates (Integer, optional). /// public int? GlobalY { get; set; } /// /// For MouseInputEvent: Movement delta on x-axis since last event (Integer, optional). /// public int? MovementX { get; set; } /// /// For MouseInputEvent: Movement delta on y-axis since last event (Integer, optional). /// public int? MovementY { get; set; } /// /// For MouseInputEvent: Click count (Integer, optional). /// public int? ClickCount { get; set; } /// /// For MouseWheelInputEvent: Horizontal scroll delta (Integer, optional). /// public int? DeltaX { get; set; } /// /// For MouseWheelInputEvent: Vertical scroll delta (Integer, optional). /// public int? DeltaY { get; set; } /// /// For MouseWheelInputEvent: Horizontal wheel ticks (Integer, optional). /// public int? WheelTicksX { get; set; } /// /// For MouseWheelInputEvent: Vertical wheel ticks (Integer, optional). /// public int? WheelTicksY { get; set; } /// /// For MouseWheelInputEvent: Horizontal acceleration ratio (Integer, optional). /// public int? AccelerationRatioX { get; set; } /// /// For MouseWheelInputEvent: Vertical acceleration ratio (Integer, optional). /// public int? AccelerationRatioY { get; set; } /// /// For MouseWheelInputEvent: True if wheel deltas are precise (optional). /// public bool? HasPreciseScrollingDeltas { get; set; } /// /// For MouseWheelInputEvent: True if the target can scroll (optional). /// public bool? CanScroll { get; set; } /// /// Can be `undefined`, `mouseDown`, `mouseUp`, `mouseMove`, `mouseEnter`, /// `mouseLeave`, `contextMenu`, `mouseWheel`, `rawKeyDown`, `keyDown`, `keyUp`, `char`, /// `gestureScrollBegin`, `gestureScrollEnd`, `gestureScrollUpdate`, /// `gestureFlingStart`, `gestureFlingCancel`, `gesturePinchBegin`, /// `gesturePinchEnd`, `gesturePinchUpdate`, `gestureTapDown`, `gestureShowPress`, /// `gestureTap`, `gestureTapCancel`, `gestureShortPress`, `gestureLongPress`, /// `gestureLongTap`, `gestureTwoFingerTap`, `gestureTapUnconfirmed`, /// `gestureDoubleTap`, `touchStart`, `touchMove`, `touchEnd`, `touchCancel`, /// `touchScrollStarted`, `pointerDown`, `pointerUp`, `pointerMove`, /// `pointerRawUpdate`, `pointerCancel` or `pointerCausedUaAction`. /// public InputEventType Type { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/InputEventType.cs ================================================ namespace ElectronNET.API.Entities; /// /// /// public enum InputEventType { /// /// /// undefined, /// /// /// mouseDown, /// /// /// mouseUp, /// /// /// mouseMove, /// /// /// mouseEnter, /// /// /// mouseLeave, /// /// /// contextMenu, /// /// /// mouseWheel, /// /// /// rawKeyDown, /// /// /// keyDown, /// /// /// keyUp, /// /// /// @char, /// /// /// gestureScrollBegin, /// /// /// gestureScrollEnd, /// /// /// gestureScrollUpdate, /// /// /// gestureFlingStart, /// /// /// gestureFlingCancel, /// /// /// gesturePinchBegin, /// /// /// gesturePinchEnd, /// /// /// gesturePinchUpdate, /// /// /// gestureTapDown, /// /// /// gestureShowPress, /// /// /// gestureTap, /// /// /// gestureTapCancel, /// /// /// gestureShortPress, /// /// /// gestureLongPress, /// /// /// gestureLongTap, /// /// /// gestureTwoFingerTap, /// /// /// gestureTapUnconfirmed, /// /// /// gestureDoubleTap, /// /// /// touchStart, /// /// /// touchMove, /// /// /// touchEnd, /// /// /// touchCancel, /// /// /// touchScrollStarted, /// /// /// pointerDown, /// /// /// pointerUp, /// /// /// pointerMove, /// /// /// pointerRawUpdate, /// /// /// pointerCancel, /// /// /// pointerCausedUaAction } ================================================ FILE: src/ElectronNET.API/API/Entities/JumpListCategory.cs ================================================ using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Jump List category definition used with app.setJumpList(categories). /// Matches Electron's JumpListCategory structure. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class JumpListCategory { /// /// Gets or sets the name; must be set if type is custom, otherwise it should be omitted. /// public string Name { get; set; } /// /// Gets or sets the array of objects if type is tasks or custom; otherwise it should be omitted. /// public JumpListItem[] Items { get; set; } /// /// Gets or sets the category type. One of: tasks | frequent | recent | custom. /// public JumpListCategoryType Type { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/JumpListCategoryType.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Jump list category kinds for app.setJumpList (Windows). /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] public enum JumpListCategoryType { /// /// The tasks /// tasks, /// /// The frequent /// frequent, /// /// The recent /// recent, /// /// The custom /// custom } } ================================================ FILE: src/ElectronNET.API/API/Entities/JumpListItem.cs ================================================ using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Jump List item used in app.setJumpList(categories) on Windows. /// Matches Electron's JumpListItem structure. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class JumpListItem { /// /// Gets or sets the command line arguments when program is executed. Should only be set if type is task. /// public string Args { get; set; } /// /// Gets or sets the description of the task (displayed in a tooltip). Should only be set if type is task. Maximum length 260 characters. /// public string Description { get; set; } /// /// Gets or sets the index of the icon in the resource file. If a resource file contains multiple /// icons this value can be used to specify the zero-based index of the icon that /// should be displayed for this task. If a resource file contains only one icon, /// this property should be set to zero. /// public int IconIndex { get; set; } /// /// Gets or sets the absolute path to an icon to be displayed in a Jump List, which can be an /// arbitrary resource file that contains an icon(e.g. .ico, .exe, .dll). You can /// usually specify process.execPath to show the program icon. /// public string IconPath { get; set; } /// /// Gets or sets the path of the file to open; should only be set if type is file. /// public string Path { get; set; } /// /// Gets or sets the path of the program to execute, usually specify process.execPath /// which opens the current program. Should only be set if type is task. /// public string Program { get; set; } /// /// Gets or sets the text to be displayed for the item in the Jump List. Should only be set if type is task. /// public string Title { get; set; } /// /// Gets or sets the item type. One of: task | separator | file. /// public JumpListItemType Type { get; set; } /// /// Gets or sets the working directory. Default is empty. /// public string WorkingDirectory { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/JumpListItemType.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Jump list item kinds for app.setJumpList (Windows). /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] public enum JumpListItemType { /// /// The task /// task, /// /// The separator /// separator, /// /// The file /// file } } ================================================ FILE: src/ElectronNET.API/API/Entities/JumpListSettings.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Settings returned by app.getJumpListSettings() on Windows. /// Matches Electron's JumpListSettings object. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class JumpListSettings { /// /// The minimum number of items that will be shown in the Jump List. /// public int MinItems { get; set; } = 0; /// /// Array of JumpListItem objects that correspond to items that the user has explicitly removed from custom categories /// in the Jump List. These items must not be re-added to the Jump List in the next call to app.setJumpList(categories); /// Windows will not display any custom category that contains any of the removed items. /// public JumpListItem[] RemovedItems { get; set; } = new JumpListItem[0]; } } ================================================ FILE: src/ElectronNET.API/API/Entities/LoadURLOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// Options for BrowserWindow.loadURL(url, options) / webContents.loadURL(url, options). /// Matches Electron's loadURL options. /// /// Up-to-date with Electron API 39.2 public class LoadURLOptions { /// /// An HTTP Referrer URL. In Electron this may be a string or a Referrer object. /// public string HttpReferrer { get; set; } /// /// A user agent originating the request. /// public string UserAgent { get; set; } /// /// Base URL (with trailing path separator) for files to be loaded by the data URL. /// Needed only if the specified URL is a data URL and needs to load other files. /// public string BaseURLForDataURL { get; set; } /// /// Extra headers separated by "\n". /// public string ExtraHeaders { get; set; } /// /// Post data for the request. Matches Electron's postData: (UploadRawData | UploadFile)[] /// public IPostData[] PostData { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/LoginItemLaunchItem.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Windows launch entry as returned by app.getLoginItemSettings().launchItems. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class LoginItemLaunchItem { /// /// Name value of a registry entry. /// public string Name { get; set; } /// /// The executable to an app that corresponds to a registry entry. /// public string Path { get; set; } /// /// The command-line arguments to pass to the executable. /// public string[] Args { get; set; } /// /// One of user or machine. Indicates whether the registry entry is under HKEY_CURRENT_USER or HKEY_LOCAL_MACHINE. /// public string Scope { get; set; } /// /// True if the app registry key is startup approved and therefore shows as enabled in Task Manager and Windows settings. /// public bool Enabled { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/LoginItemSettings.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Return object for app.getLoginItemSettings() on macOS and Windows. /// /// Up-to-date with Electron API 39.2 public class LoginItemSettings { /// /// if the app is set to open at login. /// public bool OpenAtLogin { get; set; } /// /// if the app is set to open as hidden at login. Deprecated on macOS 13 and up; not available /// on MAS builds. /// [SupportedOSPlatform("macos")] public bool OpenAsHidden { get; set; } /// /// if the app was opened at login automatically. This setting is not available /// on MAS builds. /// [SupportedOSPlatform("macos")] public bool WasOpenedAtLogin { get; set; } /// /// if the app was opened as a hidden login item. This indicates that the app should not /// open any windows at startup. Deprecated on macOS 13 and up; not available on /// MAS builds. /// [SupportedOSPlatform("macos")] public bool WasOpenedAsHidden { get; set; } /// /// if the app was opened as a login item that should restore the state from the previous /// session. This indicates that the app should restore the windows that were open the last time the app was closed. /// Deprecated on macOS 13 and up; not available on MAS builds. /// [SupportedOSPlatform("macos")] public bool RestoreState { get; set; } /// /// macOS status: one of not-registered, enabled, requires-approval, or not-found. /// [SupportedOSPlatform("macos")] public string Status { get; set; } /// /// Windows: true if app is set to open at login and its run key is not deactivated. /// Differs from OpenAtLogin as it ignores the args option; this is true if the given executable would be launched at login with any arguments. /// [SupportedOSPlatform("windows")] public bool ExecutableWillLaunchAtLogin { get; set; } /// /// Windows launch entries found in registry. /// [SupportedOSPlatform("windows")] public LoginItemLaunchItem[] LaunchItems { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/LoginItemSettingsOptions.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// public class LoginItemSettingsOptions { /// /// The executable path to compare against. Defaults to process.execPath. /// [SupportedOSPlatform("windows")] public string Path { get; set; } /// /// The command-line arguments to compare against. Defaults to an empty array. /// [SupportedOSPlatform("windows")] public string[] Args { get; set; } /// /// The type of service to query on macOS 13+. Defaults to 'mainAppService'. Only available on macOS 13 and up. /// [SupportedOSPlatform("macos")] public string Type { get; set; } /// /// The name of the service. Required if type is non-default. Only available on macOS 13 and up. /// [SupportedOSPlatform("macos")] public string ServiceName { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/LoginSettings.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Settings object for app.setLoginItemSettings() on macOS and Windows. /// /// Up-to-date with Electron API 39.2 public class LoginSettings { /// /// to open the app at login, to remove the app as a login item. /// Defaults to . /// public bool OpenAtLogin { get; set; } /// /// to open the app as hidden. Defaults to . The user can edit this /// setting from the System Preferences so app.getLoginItemSettings().wasOpenedAsHidden should be checked when the app is /// opened to know the current value. This setting is not available on MAS builds and does not work on macOS 13 and up. /// [SupportedOSPlatform("macos")] public bool OpenAsHidden { get; set; } /// /// The executable to launch at login. Defaults to process.execPath. /// [SupportedOSPlatform("windows")] public string Path { get; set; } /// /// The command-line arguments to pass to the executable. Defaults to an empty /// array.Take care to wrap paths in quotes. /// [SupportedOSPlatform("windows")] public string[] Args { get; set; } /// /// The type of service to add as a login item. Defaults to 'mainAppService'. Only available on macOS 13 and up. /// [SupportedOSPlatform("macos")] public string Type { get; set; } /// /// The name of the service. Required if Type is non-default. Only available on macOS 13 and up. /// [SupportedOSPlatform("macos")] public string ServiceName { get; set; } /// /// Change the startup approved registry key and enable/disable the app in Task Manager and Windows Settings. Defaults to true. /// [SupportedOSPlatform("windows")] public bool Enabled { get; set; } = true; /// /// Value name to write into registry. Defaults to the app's AppUserModelId(). /// [SupportedOSPlatform("windows")] public string Name { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Margins.cs ================================================ namespace ElectronNET.API.Entities; /// /// Margins object used by webContents.print options and webContents.printToPDF. /// /// Up-to-date with Electron API 39.2 public class Margins { /// /// Gets or sets the margin type. Can be `default`, `none`, `printableArea`, or `custom`. If `custom` is chosen, /// you will also need to specify `top`, `bottom`, `left`, and `right`. /// public string MarginType { get; set; } /// /// Gets or sets the top margin of the printed web page. Units depend on API: /// - webContents.print: pixels /// - webContents.printToPDF: inches /// public double Top { get; set; } /// /// Gets or sets the bottom margin of the printed web page. Units depend on API: /// - webContents.print: pixels /// - webContents.printToPDF: inches /// public double Bottom { get; set; } /// /// Gets or sets the left margin of the printed web page. Units depend on API: /// - webContents.print: pixels /// - webContents.printToPDF: inches /// public double Left { get; set; } /// /// Gets or sets the right margin of the printed web page. Units depend on API: /// - webContents.print: pixels /// - webContents.printToPDF: inches /// public double Right { get; set; } } ================================================ FILE: src/ElectronNET.API/API/Entities/MemoryInfo.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Process memory info as returned by process.getProcessMemoryInfo(). /// Values are reported in Kilobytes. /// /// Up-to-date with Electron API 39.2 public class MemoryInfo { /// /// Gets or sets the amount of memory currently pinned to actual physical RAM. /// public int WorkingSetSize { get; set; } /// /// Gets or sets the maximum amount of memory that has ever been pinned to actual physical RAM. /// public int PeakWorkingSetSize { get; set; } /// /// Gets or sets the amount of memory not shared by other processes, such as JS heap or HTML content. Windows only. /// [SupportedOSPlatform("windows")] public int PrivateBytes { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/MenuItem.cs ================================================ using System; using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class MenuItem { /// /// Will be called with click(menuItem, browserWindow, event) when the menu item is /// clicked. /// [JsonIgnore] public Action Click { get; set; } /// /// Gets or sets the action (role) of the menu item. When specified, the click property will be ignored. /// public MenuRole Role { get; set; } /// /// Gets or sets the menu item type. Can be normal, separator, submenu, checkbox, radio, header (macOS 14+), or palette (macOS 14+). /// public MenuType Type { get; set; } /// /// Gets or sets the label. /// /// /// The label. /// public string Label { get; set; } /// /// Gets or sets the sublabel. /// /// /// The sublabel. /// [SupportedOSPlatform("macos")] public string Sublabel { get; set; } /// /// Hover text for this menu item (macOS). /// [SupportedOSPlatform("macos")] public string ToolTip { 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; } /// /// Gets or sets a value indicating whether the item is enabled. If false, the menu item will be greyed out and unclickable. /// public bool Enabled { get; set; } = true; /// /// Gets or sets a value indicating whether the item is visible. If false, the menu item will be entirely hidden. /// public bool Visible { get; set; } = true; /// /// Gets or sets a value indicating whether the accelerator should work when the item is hidden. Default is true (macOS). /// When false, prevents the accelerator from triggering the item if the item is not visible. /// [SupportedOSPlatform("macos")] public bool? AcceleratorWorksWhenHidden { get; set; } /// /// Gets or sets a value indicating whether the accelerator should be registered with the system or only displayed (Linux/Windows). Defaults to true. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("linux")] public bool? RegisterAccelerator { get; set; } /// /// Gets or sets a value indicating whether the item is checked. Should only be specified for checkbox or radio items. /// public bool Checked { get; set; } /// /// Should be specified for submenu type menu items. If submenu is specified, the /// type: 'submenu' can be omitted.If the value is not a Menu then it will be /// automatically converted to one using Menu.buildFromTemplate. /// public MenuItem[] Submenu { get; set; } /// /// The item to share when the role is shareMenu (macOS). /// [SupportedOSPlatform("macos")] public SharingItem SharingItem { get; set; } /// /// Gets or sets a unique id within a single menu. If defined then it can be used as a reference for placement. /// public string Id { get; internal set; } /// /// This field allows fine-grained definition of the specific location within a given menu. /// public string Position { get; set; } /// /// Gets or sets a list of item ids. Inserts this item before the item(s) with the specified id(s). /// If the referenced item doesn't exist the item will be inserted at the end of the menu. /// Also implies that this item should be placed in the same group as the referenced item(s). /// public string[] Before { get; set; } /// /// Gets or sets a list of item ids. Inserts this item after the item(s) with the specified id(s). /// If the referenced item doesn't exist the item will be inserted at the end of the menu. /// public string[] After { get; set; } /// /// Gets or sets a list of item ids. Places this item's containing group before the containing group /// of the item(s) with the specified id(s). /// public string[] BeforeGroupContaining { get; set; } /// /// Gets or sets a list of item ids. Places this item's containing group after the containing group /// of the item(s) with the specified id(s). /// public string[] AfterGroupContaining { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/MenuRole.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// public enum MenuRole { /// /// The undo /// undo = 1, /// /// The redo /// redo, /// /// The cut /// cut, /// /// The copy /// copy, /// /// The paste /// paste, /// /// The pasteAndMatchStyle /// pasteAndMatchStyle, /// /// The selectAll /// selectAll, /// /// The delete /// delete, /// /// Minimize current window /// minimize, /// /// Close current window /// close, /// /// Quit the application /// quit, /// /// Reload the current window /// reload, /// /// Reload the current window ignoring the cache. /// forceReload, /// /// Toggle developer tools in the current window /// toggleDevTools, /// /// Toggle full screen mode on the current window /// togglefullscreen, /// /// Reset the focused page’s zoom level to the original size /// resetZoom, /// /// Zoom in the focused page by 10% /// zoomIn, /// /// Zoom out the focused page by 10% /// zoomOut, /// /// Whole default “Edit” menu (Undo, Copy, etc.) /// editMenu, /// /// Whole default “Window” menu (Minimize, Close, etc.) /// windowMenu, /// /// Only macOS: Map to the orderFrontStandardAboutPanel action /// about, /// /// Only macOS: Map to the hide action /// hide, /// /// Only macOS: Map to the hideOtherApplications action /// hideOthers, /// /// Only macOS: Map to the unhideAllApplications action /// unhide, /// /// Only macOS: Map to the startSpeaking action /// startSpeaking, /// /// Only macOS: Map to the stopSpeaking action /// stopSpeaking, /// /// Only macOS: Map to the arrangeInFront action /// front, /// /// Only macOS: Map to the performZoom action /// zoom, /// /// Only macOS: The submenu is a “Window” menu /// window, /// /// Only macOS: The submenu is a “Help” menu /// help, /// /// Only macOS: The submenu is a “Services” menu /// services, /// /// Toggle built-in spellchecker. /// toggleSpellChecker, /// /// The submenu is a "File" menu. /// fileMenu, /// /// The submenu is a "View" menu. /// viewMenu, /// /// The application menu. /// appMenu, /// /// The submenu is a "Share" menu. /// shareMenu, /// /// Displays a list of files recently opened by the app. /// recentDocuments, /// /// Clear the recent documents list. /// clearRecentDocuments, /// /// Toggle the tab bar (macOS). /// toggleTabBar, /// /// Select the next tab (macOS). /// selectNextTab, /// /// Select the previous tab (macOS). /// selectPreviousTab, /// /// Show all tabs (macOS). /// showAllTabs, /// /// Merge all windows (macOS). /// mergeAllWindows, /// /// Move the current tab to a new window (macOS). /// moveTabToNewWindow, /// /// Show substitutions panel (macOS). /// showSubstitutions, /// /// Toggle smart quotes (macOS). /// toggleSmartQuotes, /// /// Toggle smart dashes (macOS). /// toggleSmartDashes, /// /// Toggle text replacement (macOS). /// toggleTextReplacement, // Backwards-compatibility aliases (old identifiers) to avoid breaking existing code. // These map to the same enum values as their official values. pasteandmatchstyle = pasteAndMatchStyle, selectall = selectAll, forcereload = forceReload, toggledevtools = toggleDevTools, resetzoom = resetZoom, zoomin = zoomIn, zoomout = zoomOut, hideothers = hideOthers, startspeaking = startSpeaking, stopspeaking = stopSpeaking, togglespellchecker = toggleSpellChecker, togglesmartquotes = toggleSmartQuotes, togglesmartdashes = toggleSmartDashes, toggletextreplacement = toggleTextReplacement } } ================================================ FILE: src/ElectronNET.API/API/Entities/MenuType.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Menu item types matching Electron's MenuItem.type values. /// /// Up-to-date with Electron API 39.2 public enum MenuType { /// /// Normal menu item. /// normal, /// /// Separator between items. /// separator, /// /// Submenu container. /// submenu, /// /// Checkbox item. /// checkbox, /// /// Radio item. /// radio, /// /// Header item (macOS 14+). /// [SupportedOSPlatform("macos")] header, /// /// Palette item (macOS 14+). /// [SupportedOSPlatform("macos")] palette } } ================================================ FILE: src/ElectronNET.API/API/Entities/MessageBoxOptions.cs ================================================ using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Options for dialog.showMessageBox / dialog.showMessageBoxSync. /// /// Up-to-date with Electron API 39.2 public class MessageBoxOptions { /// /// Gets or sets the type. Can be "none", "info", "error", "question" or "warning". On Windows, "question" displays the same icon as "info", unless you set an icon using the "icon" option. On macOS, both "warning" and "error" display the same warning icon. /// public MessageBoxType Type { get; set; } /// /// Gets or sets the array of texts for buttons. On Windows, an empty array will result in one button labeled "OK". /// public string[] Buttons { get; set; } /// /// Gets or sets the index of the button in the buttons array which will be selected by default when the message box opens. /// public int DefaultId { get; set; } /// /// Gets or sets the title of the message box; some platforms will not show it. /// public string Title { get; set; } /// /// Gets or sets the content of the message box. /// public string Message { get; set; } /// /// Gets or sets the extra information of the message. /// public string Detail { get; set; } /// /// Gets or sets the checkbox label. If provided, the message box will include a checkbox with the given label. /// public string CheckboxLabel { get; set; } /// /// Gets or sets the initial checked state of the checkbox. Defaults to false. /// public bool CheckboxChecked { get; set; } /// /// Gets or sets the icon for the message box. /// public string Icon { get; set; } /// /// Gets or sets the custom width of the text in the message box. /// [SupportedOSPlatform("macos")] public int? TextWidth { get; set; } /// /// Gets or sets the index of the button to be used to cancel the dialog via the Esc key. By default this is assigned to the first button with "cancel" or "no" as the label. If no such labeled buttons exist and this option is not set, 0 will be used. /// public int CancelId { get; set; } /// /// Gets or sets a value indicating whether to disable Windows command-links behavior (noLink). /// On Windows Electron will try to figure out which one of the buttons are common buttons (like "Cancel" or "Yes"), and show the others as command links in the dialog. Set to true to disable this behavior. /// [SupportedOSPlatform("windows")] public bool NoLink { get; set; } /// /// Gets or sets a value indicating whether to normalize the keyboard access keys across platforms. Default is false. Enabling this assumes '&' is used in the button labels for the placement of the keyboard /// shortcut access key and labels will be converted so they work correctly on each /// platform, '&' characters are removed on macOS, converted to '_' on Linux, and left /// untouched on Windows. For example, a button label of "View" will be converted to "Vie_w" on Linux and "View" on macOS and can be selected via Alt-W on Windows and /// Linux. /// public bool NormalizeAccessKeys { get; set; } /// /// Initializes a new instance of the class. /// /// The message. public MessageBoxOptions(string message) { Message = message; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/MessageBoxResult.cs ================================================ namespace ElectronNET.API.Entities { /// /// Result returned by dialog.showMessageBox / dialog.showMessageBoxSync. /// /// Up-to-date with Electron API 39.2 public class MessageBoxResult { /// /// The index of the clicked button. /// public int Response { get; set; } /// /// The checked state of the checkbox if CheckboxLabel was set; otherwise false. /// public bool CheckboxChecked { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/MessageBoxType.cs ================================================ namespace ElectronNET.API.Entities { /// /// Message box type for dialog.showMessageBox/showMessageBoxSync. /// /// Up-to-date with Electron API 39.2 public enum MessageBoxType { /// /// The none /// none, /// /// The information /// info, /// /// The error /// error, /// /// The question /// question, /// /// The warning /// warning } } ================================================ FILE: src/ElectronNET.API/API/Entities/ModifierType.cs ================================================ namespace ElectronNET.API.Entities; /// /// Specifies the possible modifier keys for a keyboard input (maps to InputEvent.modifiers). /// /// Up-to-date with Electron API 39.2 public enum ModifierType { /// /// The Shift key. /// shift, /// /// The Control key. /// control, /// /// The Control key (alias for control). /// ctrl, /// /// The Alt key. /// alt, /// /// The Meta key. /// meta, /// /// The Command key. /// command, /// /// The Command key (alias for command). /// cmd, /// /// Indicates whether the keypad modifier key is pressed. /// isKeypad, /// /// Indicates whether the key is an auto-repeated key. /// isAutoRepeat, /// /// Indicates whether the left mouse button is pressed. /// leftButtonDown, /// /// Indicates whether the middle mouse button is pressed. /// middleButtonDown, /// /// Indicates whether the right mouse button is pressed. /// rightButtonDown, /// /// The Caps Lock key. /// capsLock, /// /// The Num Lock key. /// numlock, /// /// The Left key. /// left, /// /// The Right key. /// right } ================================================ FILE: src/ElectronNET.API/API/Entities/NativeImage.cs ================================================ using System; using System.Collections.Generic; using System.Drawing; using System.Drawing.Drawing2D; using System.Drawing.Imaging; using System.IO; using System.Linq; using System.Text.Json.Serialization; using System.Text.RegularExpressions; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Native Image handler for Electron.NET /// [JsonConverter(typeof(NativeImageJsonConverter))] public class NativeImage { private readonly Dictionary _images = new Dictionary(); private bool _isTemplateImage; private static readonly Dictionary ScaleFactorPairs = new Dictionary { { "@2x", 2.0f }, { "@3x", 3.0f }, { "@1x", 1.0f }, { "@4x", 4.0f }, { "@5x", 5.0f }, { "@1.25x", 1.25f }, { "@1.33x", 1.33f }, { "@1.4x", 1.4f }, { "@1.5x", 1.5f }, { "@1.8x", 1.8f }, { "@2.5x", 2.5f } }; private static float? ExtractDpiFromFilePath(string filePath) { var withoutExtension = Path.GetFileNameWithoutExtension(filePath); return ScaleFactorPairs .Where(p => withoutExtension.EndsWith(p.Key)) .Select(p => p.Value) .FirstOrDefault(); } private static Image BytesToImage(byte[] bytes) { var ms = new MemoryStream(bytes); return Image.FromStream(ms); } /// /// Creates an empty NativeImage /// public static NativeImage CreateEmpty() { return new NativeImage(); } /// /// /// public static NativeImage CreateFromBitmap(Bitmap bitmap, CreateFromBitmapOptions options = null) { if (options is null) { options = new CreateFromBitmapOptions(); } return new NativeImage(bitmap, options.ScaleFactor); } /// /// Creates a NativeImage from a byte array. /// public static NativeImage CreateFromBuffer(byte[] buffer, CreateFromBufferOptions options = null) { if (options is null) { options = new CreateFromBufferOptions(); } var ms = new MemoryStream(buffer); var image = Image.FromStream(ms); return new NativeImage(image, options.ScaleFactor); } /// /// Creates a NativeImage from a base64 encoded data URL. /// /// A data URL with a base64 encoded image. public static NativeImage CreateFromDataURL(string dataUrl) { var images = new Dictionary(); var parsedDataUrl = Regex.Match(dataUrl, @"data:image/(?.+?),(?.+)"); var actualData = parsedDataUrl.Groups["data"].Value; var binData = Convert.FromBase64String(actualData); var image = BytesToImage(binData); images.Add(1.0f, image); return new NativeImage(images); } /// /// Creates a NativeImage from an image on the disk. /// /// The path of the image public static NativeImage CreateFromPath(string path) { var images = new Dictionary(); if (Regex.IsMatch(path, "(@.+?x)")) { var dpi = ExtractDpiFromFilePath(path); if (dpi == null) { throw new Exception($"Invalid scaling factor for '{path}'."); } images[dpi.Value] = Image.FromFile(path); } else { var fileNameWithoutExtension = Path.GetFileNameWithoutExtension(path); var extension = Path.GetExtension(path); // Load as 1x dpi images[1.0f] = Image.FromFile(path); foreach (var scale in ScaleFactorPairs) { var fileName = $"{fileNameWithoutExtension}{scale}.{extension}"; if (File.Exists(fileName)) { var dpi = ExtractDpiFromFilePath(fileName); if (dpi != null) { images[dpi.Value] = Image.FromFile(fileName); } } } } return new NativeImage(images); } /// /// Creates an empty NativeImage /// public NativeImage() { } /// /// Creates a NativeImage from a bitmap and scale factor /// public NativeImage(Image bitmap, float scaleFactor = 1.0f) { _images.Add(scaleFactor, bitmap); } /// /// Creates a NativeImage from a dictionary of scales and images. /// public NativeImage(Dictionary imageDictionary) { _images = imageDictionary; } /// /// Crops the image specified by the input rectangle and computes scale factor /// public NativeImage Crop(Rectangle rect) { var images = new Dictionary(); foreach (var image in _images) { images.Add(image.Key, Crop(rect.X, rect.Y, rect.Width, rect.Height, image.Key)); } return new NativeImage(images); } /// /// Resizes the image and computes scale factor /// public NativeImage Resize(ResizeOptions options) { var images = new Dictionary(); foreach (var image in _images) { images.Add(image.Key, Resize(options.Width, options.Height, image.Key)); } return new NativeImage(images); } /// /// Add an image representation for a specific scale factor. /// /// public void AddRepresentation(AddRepresentationOptions options) { if (options.Buffer.Length > 0) { _images[options.ScaleFactor] = CreateFromBuffer(options.Buffer, new CreateFromBufferOptions { ScaleFactor = options.ScaleFactor }) .GetScale(options.ScaleFactor); } else if (!string.IsNullOrEmpty(options.DataUrl)) { _images[options.ScaleFactor] = CreateFromDataURL(options.DataUrl).GetScale(options.ScaleFactor); } } /// /// Gets the aspect ratio for the image based on scale factor /// /// Optional public float GetAspectRatio(float scaleFactor = 1.0f) { var image = GetScale(scaleFactor); if (image != null) { return image.Width / image.Height; } return 0f; } /// /// Returns a byte array that contains the image's raw bitmap pixel data. /// public byte[] GetBitmap(BitmapOptions options) { return ToBitmap(new ToBitmapOptions { ScaleFactor = options.ScaleFactor }); } /// /// Returns a byte array that contains the image's raw bitmap pixel data. /// public byte[] GetNativeHandle() { return ToBitmap(new ToBitmapOptions()); } /// /// Gets the size of the specified image based on scale factor /// public Size GetSize(float scaleFactor = 1.0f) { if (_images.ContainsKey(scaleFactor)) { var image = _images[scaleFactor]; return new Size { Width = image.Width, Height = image.Height }; } return null; } /// /// Checks to see if the NativeImage instance is empty. /// public bool IsEmpty() { return _images.Count <= 0; } /// /// Deprecated. Whether the image is a template image. /// public bool IsTemplateImage => _isTemplateImage; /// /// Whether the image is considered a macOS template image. /// [SupportedOSPlatform("macos")] public bool IsMacTemplateImage => _isTemplateImage; /// /// Deprecated. Marks the image as a template image. /// public void SetTemplateImage(bool option) { _isTemplateImage = option; } /// /// Outputs a bitmap based on the scale factor /// public byte[] ToBitmap(ToBitmapOptions options) { return ImageToBytes(ImageFormat.Bmp, options.ScaleFactor); } /// /// Outputs a data URL based on the scale factor /// public string ToDataURL(ToDataUrlOptions options) { if (!_images.ContainsKey(options.ScaleFactor)) { return null; } var image = _images[options.ScaleFactor]; var mimeType = ImageCodecInfo.GetImageEncoders().FirstOrDefault(x => x.FormatID == image.RawFormat.Guid)?.MimeType; if (mimeType is null) { mimeType = "image/png"; } var bytes = ImageToBytes(image.RawFormat, options.ScaleFactor); var base64 = Convert.ToBase64String(bytes); return $"data:{mimeType};base64,{base64}"; } /// /// Outputs a JPEG for the default scale factor /// public byte[] ToJPEG(int quality) { return ImageToBytes(ImageFormat.Jpeg, 1.0f, quality); } /// /// Outputs a PNG for the specified scale factor /// public byte[] ToPNG(ToPNGOptions options) { return ImageToBytes(ImageFormat.Png, options.ScaleFactor); } private byte[] ImageToBytes(ImageFormat imageFormat = null, float scaleFactor = 1.0f, int quality = 100) { using var ms = new MemoryStream(); if (_images.ContainsKey(scaleFactor)) { var image = _images[scaleFactor]; var encoderCodecInfo = GetEncoder(imageFormat ?? image.RawFormat); var encoder = Encoder.Quality; var encoderParameters = new EncoderParameters(1) { Param = new[] { new EncoderParameter(encoder, quality) } }; image.Save(ms, encoderCodecInfo, encoderParameters); return ms.ToArray(); } return null; } private Image Resize(int? width, int? height, float scaleFactor = 1.0f) { if (!_images.ContainsKey(scaleFactor) || (width is null && height is null)) { return null; } var image = _images[scaleFactor]; using (var g = Graphics.FromImage(image)) { g.CompositingQuality = CompositingQuality.HighQuality; var aspect = GetAspectRatio(scaleFactor); width ??= Convert.ToInt32(image.Width * aspect); height ??= Convert.ToInt32(image.Height * aspect); width = Convert.ToInt32(width * scaleFactor); height = Convert.ToInt32(height * scaleFactor); var bmp = new Bitmap(width.Value, height.Value); g.DrawImage(bmp, new System.Drawing.Rectangle(0, 0, image.Width, image.Height), new System.Drawing.Rectangle(0, 0, bmp.Width, bmp.Height), GraphicsUnit.Pixel); return bmp; } } private Image Crop(int? x, int? y, int? width, int? height, float scaleFactor = 1.0f) { if (!_images.ContainsKey(scaleFactor)) { return null; } var image = _images[scaleFactor]; using (var g = Graphics.FromImage(image)) { g.CompositingQuality = CompositingQuality.HighQuality; x ??= 0; y ??= 0; x = Convert.ToInt32(x * scaleFactor); y = Convert.ToInt32(y * scaleFactor); width ??= image.Width; height ??= image.Height; width = Convert.ToInt32(width * scaleFactor); height = Convert.ToInt32(height * scaleFactor); var bmp = new Bitmap(width.Value, height.Value); g.DrawImage(bmp, new System.Drawing.Rectangle(0, 0, image.Width, image.Height), new System.Drawing.Rectangle(x.Value, y.Value, width.Value, height.Value), GraphicsUnit.Pixel); return bmp; } } private ImageCodecInfo GetEncoder(ImageFormat format) { var codecs = ImageCodecInfo.GetImageDecoders(); foreach (ImageCodecInfo codec in codecs) { if (codec.FormatID == format.Guid) { return codec; } } return null; } internal Dictionary GetAllScaledImages() { var dict = new Dictionary(); try { foreach (var (scale, image) in _images) { dict.Add(scale, Convert.ToBase64String(ImageToBytes(null, scale))); } } catch (Exception ex) { Console.WriteLine(ex); } return dict; } internal Image GetScale(float scaleFactor) { if (_images.ContainsKey(scaleFactor)) { return _images[scaleFactor]; } return null; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/NativeImageJsonConverter.cs ================================================ using ElectronNET.API.Serialization; using System; using System.Collections.Generic; using System.Drawing; using System.IO; using System.Text.Json; using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// Project-specific: JSON converter for NativeImage; no MCP structure equivalent. internal class NativeImageJsonConverter : JsonConverter { public override void Write(Utf8JsonWriter writer, NativeImage value, JsonSerializerOptions options) { if (value is null) { writer.WriteNullValue(); return; } var scaledImages = value.GetAllScaledImages(); JsonSerializer.Serialize(writer, scaledImages, ElectronJson.Options); } public override NativeImage Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { var dict = JsonSerializer.Deserialize>(ref reader, ElectronJson.Options); var newDictionary = new Dictionary(); foreach (var item in dict) { var bytes = Convert.FromBase64String(item.Value); newDictionary.Add(item.Key, Image.FromStream(new MemoryStream(bytes))); } return new NativeImage(newDictionary); } } } ================================================ FILE: src/ElectronNET.API/API/Entities/NotificationAction.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macos")] public class NotificationAction { /// /// Gets or sets the label for the action. /// public string Text { get; set; } /// /// Gets or sets the type of action; can be 'button'. /// public string Type { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/NotificationOptions.cs ================================================ using System; using System.Runtime.Versioning; using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class NotificationOptions { /// /// Gets or sets the title for the notification, which will be shown at the top of the notification window when it is shown. /// public string Title { get; set; } /// /// Gets or sets the subtitle for the notification, which will be displayed below the title. /// [SupportedOSPlatform("macos")] [JsonPropertyName("subtitle")] public string Subtitle { get; set; } /// /// Gets or sets the body text of the notification, which will be displayed below the title or subtitle. /// public string Body { get; set; } /// /// Gets or sets a value indicating whether to suppress the OS notification noise when showing the notification. /// public bool Silent { get; set; } /// /// Gets or sets an icon to use in the notification. Can be a string path or a NativeImage. If a string is passed, it must be a valid path to a local icon file. /// public string Icon { get; set; } /// /// Gets or sets a value indicating whether to add an inline reply option to the notification. /// [SupportedOSPlatform("macos")] public bool HasReply { get; set; } /// /// Gets or sets the timeout duration of the notification. Can be 'default' or 'never'. /// [SupportedOSPlatform("linux")] [SupportedOSPlatform("windows")] public string TimeoutType { get; set; } /// /// Gets or sets the placeholder to write in the inline reply input field. /// [SupportedOSPlatform("macos")] public string ReplyPlaceholder { get; set; } /// /// Gets or sets the name of the sound file to play when the notification is shown. /// [SupportedOSPlatform("macos")] public string Sound { get; set; } /// /// Gets or sets the urgency level of the notification. Can be 'normal', 'critical', or 'low'. /// [SupportedOSPlatform("linux")] public string Urgency { get; set; } /// /// Gets or sets the actions to add to the notification. Please read the available actions and limitations in the NotificationAction documentation. /// [SupportedOSPlatform("macos")] public NotificationAction[] Actions { get; set; } /// /// Gets or sets a custom title for the close button of an alert. An empty string will cause the default localized text to be used. /// [SupportedOSPlatform("macos")] public string CloseButtonText { get; set; } /// /// Gets or sets a custom description of the Notification on Windows superseding all properties above. Provides full customization of design and behavior of the notification. /// [SupportedOSPlatform("windows")] public string ToastXml { get; set; } /// /// Emitted when the notification is shown to the user, note this could be fired /// multiple times as a notification can be shown multiple times through the Show() /// method. /// [JsonIgnore] public Action OnShow { get; set; } /// /// Gets or sets the show identifier. /// /// /// The show identifier. /// [JsonInclude] internal string ShowID { get; set; } /// /// Emitted when the notification is clicked by the user. /// [JsonIgnore] public Action OnClick { get; set; } /// /// Gets or sets the click identifier. /// /// /// The click identifier. /// [JsonInclude] internal string ClickID { get; set; } /// /// Emitted when the notification is closed by manual intervention from the user. /// /// This event is not guarunteed to be emitted in all cases where the notification is closed. /// [JsonIgnore] public Action OnClose { get; set; } /// /// Gets or sets the close identifier. /// /// /// The close identifier. /// [JsonInclude] internal string CloseID { get; set; } /// /// macOS only: Emitted when the user clicks the “Reply” button on a notification with hasReply: true. /// /// The string the user entered into the inline reply field /// [JsonIgnore] [SupportedOSPlatform("macos")] public Action OnReply { get; set; } /// /// Gets or sets the reply identifier. /// /// /// The reply identifier. /// [JsonInclude] internal string ReplyID { get; set; } /// /// macOS only - The index of the action that was activated. /// [JsonIgnore] [SupportedOSPlatform("macos")] public Action OnAction { get; set; } /// /// Gets or sets the action identifier. /// /// /// The action identifier. /// [JsonInclude] internal string ActionID { get; set; } /// /// Windows only: Emitted when an error is encountered while creating and showing the native notification. /// Corresponds to the 'failed' event on Notification. /// [JsonIgnore] [SupportedOSPlatform("windows")] public Action OnFailed { get; set; } /// /// Initializes a new instance of the class. /// /// The title. /// The body. public NotificationOptions(string title, string body) { Title = title; Body = body; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/OnDidFailLoadInfo.cs ================================================ namespace ElectronNET.API.Entities; /// /// 'OnDidFailLoad' event details. /// public class OnDidFailLoadInfo { /// /// The full list of error codes and their meaning is available here /// https://source.chromium.org/chromium/chromium/src/+/main:net/base/net_error_list.h /// public int ErrorCode { get; set; } /// /// Validated URL. /// public string ValidatedUrl { get; set; } /// /// Error description string. /// public string ErrorDescription { get; set; } /// /// True if the event pertains to the main frame. /// public bool IsMainFrame { get; set; } /// /// The process id for the frame. /// public int FrameProcessId { get; set; } /// /// The routing id for the frame. /// public int FrameRoutingId { get; set; } } ================================================ FILE: src/ElectronNET.API/API/Entities/OnDidNavigateInfo.cs ================================================ namespace ElectronNET.API.Entities; /// /// 'did-navigate' event details for main frame navigation. /// /// Up-to-date with Electron API 39.2 public class OnDidNavigateInfo { /// /// The URL navigated to. /// public string Url { get; set; } /// /// HTTP response code (-1 for non-HTTP navigations). /// public int HttpResponseCode { get; set; } /// /// HTTP status text (empty for non-HTTP navigations). /// public string HttpStatusText { get; set; } } ================================================ FILE: src/ElectronNET.API/API/Entities/OnTopLevel.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// String values for the 'level' parameter of BrowserWindow.setAlwaysOnTop. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] 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 } } ================================================ FILE: src/ElectronNET.API/API/Entities/OpenDevToolsOptions.cs ================================================ using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// /// /// public class OpenDevToolsOptions { /// /// Opens the DevTools with specified dock state. Can be left, right, bottom, undocked, or detach. /// Defaults to the last used dock state. In undocked mode it's possible to dock back; in detach mode it's not. /// public DevToolsMode Mode { get; set; } /// /// Whether to bring the opened DevTools window to the foreground. Default is true. /// public bool Activate { get; set; } = true; /// /// A title for the DevTools window (only visible in undocked or detach mode). /// public string Title { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/OpenDialogOptions.cs ================================================ using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { using System.Runtime.Versioning; /// /// /// /// Up-to-date with Electron API 39.2 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; } /// /// Custom label for the confirmation button, when left empty the default label will be used. /// public string ButtonLabel { get; set; } /// /// Gets or sets which features the dialog should use. The following values are supported: /// 'openFile' | 'openDirectory' | 'multiSelections' | 'showHiddenFiles' | 'createDirectory' | 'promptToCreate' | 'noResolveAliases' | 'treatPackageAsDirectory' /// public OpenDialogProperty[] Properties { get; set; } /// /// Gets or sets the message to display above input boxes. /// [SupportedOSPlatform("macos")] public string Message { get; set; } /// /// Gets or sets the filters specifying an array of file types that can be displayed or /// selected when you want to limit the user to a specific type. For example: /// /// /// /// new FileFilter[] /// { /// new FileFiler { Name = "Images", Extensions = new string[] { "jpg", "png", "gif" } }, /// new FileFiler { Name = "Movies", Extensions = new string[] { "mkv", "avi", "mp4" } }, /// new FileFiler { Name = "Custom File Type", Extensions= new string[] {"as" } }, /// new FileFiler { Name = "All Files", Extensions= new string[] { "*" } } /// } /// /// public FileFilter[] Filters { get; set; } /// /// Create security scoped bookmarks when packaged for the Mac App Store. /// [SupportedOSPlatform("macos")] public bool SecurityScopedBookmarks { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/OpenDialogProperty.cs ================================================ namespace ElectronNET.API.Entities { using System.Runtime.Versioning; /// /// /// public enum OpenDialogProperty { /// /// The open file /// openFile, /// /// The open directory /// openDirectory, /// /// The multi selections /// multiSelections, /// /// The show hidden files /// showHiddenFiles, /// /// The create directory /// [SupportedOSPlatform("macos")] createDirectory, /// /// The prompt to create /// [SupportedOSPlatform("windows")] promptToCreate, /// /// The no resolve aliases /// [SupportedOSPlatform("macos")] noResolveAliases, /// /// The treat package as directory /// [SupportedOSPlatform("macos")] treatPackageAsDirectory, /// /// Do not add the item being opened to the recent documents list (Windows). /// [SupportedOSPlatform("windows")] dontAddToRecent } } ================================================ FILE: src/ElectronNET.API/API/Entities/OpenExternalOptions.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Controls the behavior of OpenExternal. /// /// Up-to-date with Electron API 39.2 public class OpenExternalOptions { /// /// Gets or sets whether to bring the opened application to the foreground. The default is . /// [SupportedOSPlatform("macos")] [DefaultValue(true)] public bool Activate { get; set; } = true; /// /// Gets or sets the working directory. /// [SupportedOSPlatform("windows")] public string WorkingDirectory { get; set; } /// /// Gets or sets a value indicating a user-initiated launch that enables tracking of frequently used programs and other behaviors. The default is . /// [SupportedOSPlatform("windows")] [DefaultValue(false)] public bool LogUsage { get; set; } = false; } } ================================================ FILE: src/ElectronNET.API/API/Entities/PageSize.cs ================================================ namespace ElectronNET.API.Entities; public class PageSize { private readonly string _value; /// /// Represents the page size for printing/PDF. /// Matches Electron semantics: either a named size (e.g. 'A4', 'Letter', 'Legal', 'Tabloid', 'Ledger', etc.) /// or a custom size specified by Height and Width in inches. /// /// Up-to-date with Electron API 39.2 public PageSize() { } private PageSize(string value) : this() => _value = value; /// /// Gets or sets the custom page height in inches (when using object form instead of a named size). /// public double Height { get; set; } /// /// Gets or sets the custom page width in inches (when using object form instead of a named size). /// public double Width { get; set; } /// /// Implicit conversion to string to represent named page sizes (e.g. 'A4', 'Letter'). /// public static implicit operator string(PageSize pageSize) => pageSize?._value; /// /// Implicit conversion from string to represent named page sizes (e.g. 'A4', 'Letter'). /// public static implicit operator PageSize(string value) => new(value); } ================================================ FILE: src/ElectronNET.API/API/Entities/PathName.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Names for app.getPath(name). Aligned with Electron docs. /// /// Up-to-date with Electron API 39.2 public enum PathName { /// /// User's home directory. /// Home, /// /// Per-user application data directory. /// AppData, /// /// The directory for storing your app's configuration files, which by default is the appData directory appended with your app's name. /// UserData, /// /// The directory for storing data generated by Session, such as localStorage, cookies, disk cache, downloaded dictionaries, network state, devtools files. /// By default this points to userData. /// SessionData, /// /// Temporary directory. /// Temp, /// /// The current executable file. /// Exe, /// /// The location of the Chromium module. By default this is synonymous with exe. /// Module, /// /// The current user's Desktop directory. /// Desktop, /// /// Directory for a user's "My Documents". /// Documents, /// /// Directory for a user's downloads. /// Downloads, /// /// Directory for a user's music. /// Music, /// /// Directory for a user's pictures. /// Pictures, /// /// Directory for a user's videos. /// Videos, /// /// Directory for the user's recent files. Windows only. /// [SupportedOSPlatform("windows")] Recent, /// /// Directory for your app's log folder. /// Logs, /// /// Directory where crash dumps are stored. /// CrashDumps, /// /// The directory where app assets such as resources.pak are stored. /// Available on Windows and Linux only. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("linux")] Assets } } ================================================ FILE: src/ElectronNET.API/API/Entities/Point.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 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; } /// /// Convert this to . /// /// The point. public static implicit operator System.Drawing.Point(Point point) { return new System.Drawing.Point(point.X, point.Y); } } } ================================================ FILE: src/ElectronNET.API/API/Entities/PrintOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// Print dpi /// /// Up-to-date with Electron API 39.2 public class PrintDpi { /// /// Gets or sets the horizontal DPI. /// public float Horizontal { get; set; } /// /// Gets or sets the vertical DPI. /// public float Vertical { get; set; } } /// /// The page range to print /// /// Up-to-date with Electron API 39.2 public class PrintPageRange { /// /// Gets or sets the starting page index (0-based). /// public int From { get; set; } /// /// Gets or sets the ending page index (inclusive, 0-based). /// public int To { get; set; } } /// /// Print options /// /// Up-to-date with Electron API 39.2 public class PrintOptions { /// /// Gets or sets a value indicating whether to suppress print settings prompts. /// public bool Silent { get; set; } /// /// Gets or sets a value indicating whether to print background graphics. /// public bool PrintBackground { get; set; } /// /// Gets or sets the printer device name to use. /// public string DeviceName { get; set; } /// /// Gets or sets a value indicating whether the page will be printed in color. /// public bool Color { get; set; } /// /// Gets or sets the margins for the print job. Use MarginType plus top/bottom/left/right for custom. /// Units for margins with webContents.print are pixels (per MCP); for webContents.printToPDF, inches. /// public Margins Margins { get; set; } /// /// Gets or sets a value indicating whether to print in landscape orientation. /// public bool Landscape { get; set; } /// /// Gets or sets the scale factor of the web page. /// public float ScaleFactor { get; set; } /// /// Gets or sets the number of pages to print per sheet. /// public int PagesPerSheet { get; set; } /// /// Gets or sets the number of copies to print. /// public int Copies { get; set; } /// /// Gets or sets a value indicating whether pages should be collated. /// public bool Collate { get; set; } /// /// Gets or sets the page range(s) to print. On macOS, only one range is honored. /// public PrintPageRange[] PageRanges { get; set; } /// /// Gets or sets the duplex mode of the printed web page. Can be simplex, shortEdge, or longEdge. /// public string DuplexMode { get; set; } /// /// Gets or sets the DPI settings for the print job. /// public PrintDpi Dpi { get; set; } /// /// Gets or sets the string to be printed as page header. /// public string Header { get; set; } /// /// Gets or sets the string to be printed as page footer. /// public string Footer { get; set; } /// /// Gets or sets the page size of the printed document. Can be A0–A6, Legal, Letter, Tabloid, /// or an object. For webContents.print, custom sizes use microns (Chromium validates width_microns/height_microns). /// public PageSize PageSize { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/PrintToPDFOptions.cs ================================================ using ElectronNET.Converter; using System.Text.Json.Serialization; namespace ElectronNET.API.Entities; /// /// /// /// Up-to-date with Electron API 39.2 public class PrintToPDFOptions { /// /// Gets or sets the paper orientation. `true` for landscape, `false` for portrait. Defaults to false. /// public bool Landscape { get; set; } = false; /// /// Gets or sets whether to display header and footer. Defaults to false. /// public bool DisplayHeaderFooter { get; set; } = false; /// /// Gets or sets whether to print background graphics. Defaults to false. /// public bool PrintBackground { get; set; } = false; /// /// Gets or sets the scale of the webpage rendering. Defaults to 1. /// public double Scale { get; set; } = 1; /// /// Gets or sets the page size of the generated PDF. Can be `A0`, `A1`, `A2`, `A3`, `A4`, /// `A5`, `A6`, `Legal`, `Letter`, `Tabloid`, `Ledger`, or an Object containing /// `height` and `width` in inches. Defaults to `Letter`. /// [JsonConverter(typeof(PageSizeConverter))] public PageSize PageSize { get; set; } = "Letter"; /// /// Gets or sets the paper ranges to print, e.g., '1-5, 8, 11-13'. Defaults to the empty string, /// which means print all pages. /// public string PageRanges { get; set; } = ""; /// /// Gets or sets the HTML template for the print header. Should be valid HTML markup with following /// classes used to inject printing values into them: `date` (formatted print date), /// `title` (document title), `url` (document location), `pageNumber` (current page /// number) and `totalPages` (total pages in the document). For example, `` /// would generate span containing the title. /// public string HeaderTemplate { get; set; } /// /// Gets or sets the HTML template for the print footer. Should use the same format as the /// `headerTemplate`. /// public string FooterTemplate { get; set; } /// /// Gets or sets whether to prefer page size as defined by css. Defaults to false, in /// which case the content will be scaled to fit the paper size. /// public bool PreferCSSPageSize { get; set; } = false; /// /// Gets or sets whether to generate a tagged (accessible) PDF. Defaults to false. /// Experimental per Electron docs; the generated PDF may not adhere fully to PDF/UA and WCAG standards. /// public bool GenerateTaggedPDF { get; set; } = false; /// /// Gets or sets whether to generate a PDF document outline from content headers. Defaults to false. /// Experimental per Electron docs. /// public bool GenerateDocumentOutline { get; set; } = false; public Margins Margins { get; set; } } ================================================ FILE: src/ElectronNET.API/API/Entities/PrinterInfo.cs ================================================ using System.Collections.Generic; namespace ElectronNET.API.Entities { /// /// PrinterInfo structure as returned by webContents.getPrintersAsync(). Fields backed by MCP: name, displayName, description, options. /// /// Up-to-date with Electron API 39.2 public class PrinterInfo { /// /// Gets or sets the name of the printer as understood by the OS. /// public string Name { get; set; } /// /// Gets or sets the name of the printer as shown in Print Preview. /// public string DisplayName { get; set; } /// /// Gets or sets a longer description of the printer's type. /// public string Description { get; set; } /// /// Gets or sets the status code reported by the OS. Semantics are platform-specific. /// Not MCP-backed: this field is not listed in Electron's PrinterInfo structure. /// public int Status { get; set; } /// /// Gets or sets a value indicating whether this printer is the system default. /// Not MCP-backed: this field is not listed in Electron's PrinterInfo structure. /// public bool IsDefault { get; set; } /// /// Gets or sets the platform-specific printer information as an object (keys/values vary by OS). /// public Dictionary Options { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ProcessMetric.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Process metrics information. /// /// Up-to-date with Electron API 39.2 public class ProcessMetric { /// /// Gets or sets the process id of the process. /// public int PId { get; set; } /// /// Gets or sets the process type. One of: Browser | Tab | Utility | Zygote | Sandbox helper | GPU | Pepper Plugin | Pepper Plugin Broker | Unknown. /// public string Type { get; set; } /// /// Gets or sets the CPU usage of the process. /// public CPUUsage Cpu { get; set; } /// /// Gets or sets the creation time for this process, represented as the number of milliseconds since the UNIX epoch. Since the pid can be reused after a process dies, use both pid and creationTime to uniquely identify a process. /// public double CreationTime { get; set; } /// /// Gets or sets the memory information for the process. /// public MemoryInfo Memory { get; set; } /// /// Gets or sets a value indicating whether the process is sandboxed on OS level. /// [SupportedOSPlatform("macos")] [SupportedOSPlatform("windows")] public bool Sandboxed { get; set; } /// /// Gets or sets the integrity level. One of: untrusted | low | medium | high | unknown. /// [SupportedOSPlatform("windows")] public string IntegrityLevel { get; set; } /// /// Gets or sets the name of the process. Examples for utility: Audio Service, Content Decryption Module Service, Network Service, Video Capture, etc. /// public string Name { get; set; } /// /// Gets or sets the non-localized name of the process. /// public string ServiceName { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ProcessVersions.cs ================================================ namespace ElectronNET.API.Entities { /// /// An object listing the version strings specific to Electron /// /// Project-specific: no matching Electron structure found in MCP docs (electronjs). /// Value representing Chrome's version string /// Value representing Electron's version string /// public record ProcessVersions(string Chrome, string Electron); } ================================================ FILE: src/ElectronNET.API/API/Entities/ProgressBarMode.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Mode for BrowserWindow/BaseWindow setProgressBar on Windows. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] public enum ProgressBarMode { /// /// The none /// none, /// /// The normal /// normal, /// /// The indeterminate /// indeterminate, /// /// The error /// error, /// /// The paused /// paused } } ================================================ FILE: src/ElectronNET.API/API/Entities/ProgressBarOptions.cs ================================================ using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Options for BrowserWindow.setProgressBar(progress, options). /// /// Up-to-date with Electron API 39.2 public class ProgressBarOptions { /// /// Mode for the progress bar on Windows. Can be 'none' | 'normal' | 'indeterminate' | 'error' | 'paused'. /// [SupportedOSPlatform("windows")] public ProgressBarMode Mode { get; set; } = ProgressBarMode.normal; } } ================================================ FILE: src/ElectronNET.API/API/Entities/ProgressInfo.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class ProgressInfo { /// Gets or sets the progress. public string Progress { get; set; } /// /// Gets or sets bytes processed per second. /// public long BytesPerSecond { get; set; } /// /// Gets or sets the percentage completed (0–100). /// public double Percent { get; set; } /// /// Gets or sets the total number of bytes to download. /// public long Total { get; set; } /// /// Gets or sets the number of bytes transferred so far. /// public long Transferred { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ProxyConfig.cs ================================================ namespace ElectronNET.API.Entities { /// /// Proxy configuration for app.setProxy / session.setProxy. Matches Electron's ProxyConfig structure. /// public class ProxyConfig { /// /// The proxy mode. One of: 'direct' | 'auto_detect' | 'pac_script' | 'fixed_servers' | 'system'. /// Defaults to 'pac_script' if 'PacScript' is specified, otherwise defaults to 'fixed_servers'. /// public string Mode { get; set; } /// /// The URL associated with the PAC file. /// public string PacScript { get; set; } /// /// Rules indicating which proxies to use. /// public string ProxyRules { get; set; } /// /// Rules indicating which URLs should bypass the proxy settings. /// public string ProxyBypassRules { get; set; } /// /// /// /// The URL associated with the PAC file. /// Rules indicating which proxies to use. /// Rules indicating which URLs should bypass the proxy settings. public ProxyConfig(string pacScript, string proxyRules, string proxyBypassRules) { PacScript = pacScript; ProxyRules = proxyRules; ProxyBypassRules = proxyBypassRules; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ReadBookmark.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Result of clipboard.readBookmark(): title and url. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] 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; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Rectangle.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 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; } /// /// Convert this to . /// /// The rectangle. public static implicit operator System.Drawing.Rectangle(Rectangle rectangle) { return new System.Drawing.Rectangle(rectangle.X, rectangle.Y, rectangle.Width, rectangle.Height); } } } ================================================ FILE: src/ElectronNET.API/API/Entities/RelaunchOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// Options for app.relaunch: optional args array and execPath. /// /// Up-to-date with Electron API 39.2 public class RelaunchOptions { /// /// Command-line arguments for the relaunched instance. /// public string[] Args { get; set; } /// /// Executable path to relaunch instead of the current app. /// public string ExecPath { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ReleaseNoteInfo.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class ReleaseNoteInfo { /// /// Gets or sets the version. /// public string Version { get; set; } /// /// Gets or sets the note text. /// public string Note { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/RemovePassword.cs ================================================ using System.Text.Json.Serialization; namespace ElectronNET.API.Entities { /// /// /// /// Undecidable from MCP: no typed structure for session.clearAuthCache parameters. public class RemovePassword { /// /// When provided, the authentication info related to the origin will only be /// removed otherwise the entire cache will be cleared. /// public string Origin { get; set; } /// /// Credentials of the authentication. Must be provided if removing by origin. /// public string Password { get; set; } /// /// Realm of the authentication. Must be provided if removing by origin. /// public string Realm { get; set; } /// /// Scheme of the authentication. Can be basic, digest, ntlm, negotiate. /// Must be provided if removing by origin. /// public Scheme Scheme { get; set; } /// /// password. /// public string Type { get; set; } /// /// Credentials of the authentication. Must be provided if removing by origin. /// public string Username { get; set; } /// /// /// /// password. public RemovePassword(string type) { Type = type; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ResizeOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// Options for NativeImage.resize: optional width/height and quality. /// /// Up-to-date with Electron API 39.2 public class ResizeOptions { /// /// Gets or sets the width /// public int? Width { get; set; } /// /// Gets or sets the height /// public int? Height { get; set; } /// /// 'good', 'better', or 'best'. Default is 'best'. /// public string Quality { get; set; } = "best"; } } ================================================ FILE: src/ElectronNET.API/API/Entities/SaveDialogOptions.cs ================================================ using ElectronNET.API.Entities; using System.Runtime.Versioning; namespace ElectronNET.API { /// /// Options for dialog.showSaveDialog / dialog.showSaveDialogSync. /// /// Up-to-date with Electron API 39.2 public class SaveDialogOptions { /// /// Gets or sets the title. /// /// /// The title. /// public string Title { get; set; } /// /// Absolute directory path, absolute file path, or file name to use by default. /// public string DefaultPath { get; set; } /// /// Gets or sets the custom label for the confirmation button; when left empty the default label will be used. /// public string ButtonLabel { get; set; } /// /// Properties for the save dialog. Supported values: /// showHiddenFiles | createDirectory (macOS) | treatPackageAsDirectory (macOS) | showOverwriteConfirmation (Linux) | dontAddToRecent (Windows) /// public SaveDialogProperty[] Properties { get; set; } /// /// Gets or sets the filters specifying an array of file types that can be displayed or /// selected when you want to limit the user to a specific type. For example: /// /// /// /// new FileFilter[] /// { /// new FileFiler { Name = "Images", Extensions = new string[] { "jpg", "png", "gif" } }, /// new FileFiler { Name = "Movies", Extensions = new string[] { "mkv", "avi", "mp4" } }, /// new FileFiler { Name = "Custom File Type", Extensions= new string[] {"as" } }, /// new FileFiler { Name = "All Files", Extensions= new string[] { "*" } } /// } /// /// public FileFilter[] Filters { get; set; } /// /// Gets or sets the message to display above text fields. /// [SupportedOSPlatform("macos")] public string Message { get; set; } /// /// Gets or sets the custom label for the text displayed in front of the filename text field. /// [SupportedOSPlatform("macos")] public string NameFieldLabel { get; set; } /// /// Gets or sets a value indicating whether to show the tags input box. Defaults to true. /// [SupportedOSPlatform("macos")] public bool ShowsTagField { get; set; } /// /// Gets or sets a value indicating whether to create a security scoped bookmark when packaged for the Mac App Store. If enabled and the file doesn't already exist a blank file will be created at the chosen path. /// [SupportedOSPlatform("macos")] public bool SecurityScopedBookmarks { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/SaveDialogProperty.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Properties supported by dialog.showSaveDialog / showSaveDialogSync. /// /// Up-to-date with Electron API 39.2 public enum SaveDialogProperty { /// /// Show hidden files in dialog. /// showHiddenFiles, /// /// Allow creating new directories from dialog (macOS). /// [SupportedOSPlatform("macos")] createDirectory, /// /// Treat packages, such as .app folders, as a directory instead of a file (macOS). /// [SupportedOSPlatform("macos")] treatPackageAsDirectory, /// /// Sets whether the user will be presented a confirmation dialog if the user types a file name that already exists (Linux). /// [SupportedOSPlatform("linux")] showOverwriteConfirmation, /// /// Do not add the item being saved to the recent documents list (Windows). /// [SupportedOSPlatform("windows")] dontAddToRecent } } ================================================ FILE: src/ElectronNET.API/API/Entities/Scheme.cs ================================================ namespace ElectronNET.API.Entities { /// /// Authentication scheme names used by webContents 'login' authInfo.scheme. /// /// Undecidable from MCP: no typed enum is defined in docs; kept as project enum to reflect commonly observed values. public enum Scheme { /// /// /// basic, /// /// /// digest, /// /// /// ntlm, /// /// /// negotiate } } ================================================ FILE: src/ElectronNET.API/API/Entities/SemVer.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Project-specific: no matching Electron structure found in MCP docs (electronjs). public class SemVer { /// /// /// public string Raw { get; set; } /// /// /// public bool Loose { get; set; } /// /// /// public SemVerOptions Options { get; set; } /// /// /// public int Major { get; set; } /// /// /// public int Minor { get; set; } /// /// /// public int Patch { get; set; } /// /// /// public string Version { get; set; } /// /// /// public string[] Build { get; set; } /// /// /// public string[] Prerelease { get; set; } } /// /// /// /// Project-specific: no matching Electron structure found in MCP docs (electronjs). public class SemVerOptions { /// /// /// public bool? Loose { get; set; } /// /// /// public bool? IncludePrerelease { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/SharingItem.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// SharingItem for MenuItem role 'shareMenu' (macOS). /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macos")] public class SharingItem { /// /// An array of text to share. /// public string[] Texts { get; set; } /// /// An array of files to share. /// public string[] FilePaths { get; set; } /// /// An array of URLs to share. /// public string[] Urls { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ShortcutDetails.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Structure of a shortcut. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public class ShortcutDetails { /// /// The Application User Model ID. Default is . /// public string AppUserModelId { get; set; } /// /// The arguments to be applied to when launching from this shortcut. Default is . /// public string Args { get; set; } /// /// The working directory. Default is . /// public string Cwd { get; set; } /// /// The description of the shortcut. Default is . /// public string Description { get; set; } /// /// The path to the icon, can be a DLL or EXE. and have to be set /// together. Default is , which uses the target's icon. /// public string Icon { get; set; } /// /// The resource ID of icon when is a DLL or EXE. Default is 0. /// public int IconIndex { get; set; } /// /// The Application Toast Activator CLSID. Needed for participating in Action Center. /// [SupportedOSPlatform("windows")] public string ToastActivatorClsid { get; set; } /// /// The target to launch from this shortcut. /// public string Target { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ShortcutLinkOperation.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Defines the ShortcutLinkOperation enumeration. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] public enum ShortcutLinkOperation { /// /// Creates a new shortcut, overwriting if necessary. /// Create, /// /// Updates specified properties only on an existing shortcut. /// Update, /// /// Overwrites an existing shortcut, fails if the shortcut doesn't exist. /// Replace } } ================================================ FILE: src/ElectronNET.API/API/Entities/Size.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 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; } /// /// Convert this to . /// /// The size. public static implicit operator System.Drawing.Size(Size size) { return new System.Drawing.Size(size.Width, size.Height); } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ThemeSourceMode.cs ================================================ using System.ComponentModel; namespace ElectronNET.API.Entities { /// /// Defines the ThemeSourceMode enumeration. /// /// Up-to-date with Electron API 39.2 public enum ThemeSourceMode { /// /// Operating system default. /// System, /// /// Light theme. /// Light, /// /// Dark theme. /// Dark } } ================================================ FILE: src/ElectronNET.API/API/Entities/ThumbarButton.cs ================================================ using System; using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Thumbnail toolbar button for Windows taskbar. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] 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; } /// /// Control specific states and behaviors of the button. By default, it is ["enabled"]. /// /// enabled - The button is active and available to the user. /// disabled - The button is disabled.It is present, but has a visual state indicating it will not respond to user action. /// dismissonclick - When the button is clicked, the thumbnail window closes immediately. /// nobackground - Do not draw a button border, use only the image. /// hidden - The button is not shown to the user. /// noninteractive - The button is enabled but not interactive; no pressed button state is drawn.This value is intended for instances where the button is used in a notification. /// public ThumbarButtonFlag[] Flags { get; set; } /// /// The icon showing in thumbnail toolbar. /// public string Icon { get; set; } /// /// The text of the button's tooltip. /// public string Tooltip { get; set; } /// /// Initializes a new instance of the class. /// /// The icon. public ThumbarButton(string icon) { Icon = icon; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/ThumbarButtonFlag.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Flags for Windows taskbar thumbnail toolbar buttons. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("windows")] public enum ThumbarButtonFlag { /// /// The button is active and available to the user. /// enabled, /// /// The button is disabled.It is present, but has a visual state indicating it will not respond to user action. /// disabled, /// /// When the button is clicked, the thumbnail window closes immediately. /// dismissonclick, /// /// Do not draw a button border, use only the image. /// nobackground, /// /// The button is not shown to the user. /// hidden, /// /// The button is enabled but not interactive; no pressed button state is drawn.This value is intended for instances where the button is used in a notification. /// noninteractive } } ================================================ FILE: src/ElectronNET.API/API/Entities/TitleBarOverlay.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities; /// /// Configures the window's title bar overlay when using a frameless window. /// /// Up-to-date with Electron API 39.2 public class TitleBarOverlay { private readonly bool? _value; public TitleBarOverlay() { } private TitleBarOverlay(bool value) : this() => _value = value; /// /// Gets or sets the CSS color of the Window Controls Overlay when enabled. /// OS-specific per MCP: available on Windows and Linux. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("linux")] public string Color { get; set; } /// /// Gets or sets the height of the title bar and Window Controls Overlay in pixels. Default is system height. /// public int Height { get; set; } /// /// Gets or sets the CSS color of the symbols on the Window Controls Overlay when enabled. /// OS-specific per MCP: available on Windows and Linux. /// [SupportedOSPlatform("windows")] [SupportedOSPlatform("linux")] public string SymbolColor { get; set; } /// /// Allows using a bare boolean for titleBarOverlay in options (true/false). /// public static implicit operator bool?(TitleBarOverlay titleBarOverlay) => titleBarOverlay?._value; /// /// Allows constructing from a bare boolean (true/false) for titleBarOverlay. /// public static implicit operator TitleBarOverlay(bool value) => new(value); } ================================================ FILE: src/ElectronNET.API/API/Entities/TitleBarStyle.cs ================================================ using System.Text.Json.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// public enum TitleBarStyle { /// /// The default style /// [JsonPropertyName("default")] defaultStyle, /// /// The hidden /// hidden, /// /// The hidden inset /// [SupportedOSPlatform("macos")] hiddenInset, /// /// The custom buttons on hover /// [SupportedOSPlatform("macos")] customButtonsOnHover } } ================================================ FILE: src/ElectronNET.API/API/Entities/ToBitmapOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// Options for nativeImage.toBitmap; supports optional scaleFactor (defaults to 1.0) per MCP. /// /// Up-to-date with Electron API 39.2 public class ToBitmapOptions { /// /// Gets or sets the image scale factor. Defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/ToDataUrlOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class ToDataUrlOptions { /// /// Gets or sets the image scale factor. Defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/ToPNGOptions.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class ToPNGOptions { /// /// Gets or sets the image scale factor. Defaults to 1.0. /// public float ScaleFactor { get; set; } = 1.0f; } } ================================================ FILE: src/ElectronNET.API/API/Entities/TrayClickEventArgs.cs ================================================ using ElectronNET.API.Entities; 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; } /// /// The bounds of tray icon. /// public Rectangle Bounds { get; set; } /// /// The position of the event. /// public Point Position { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UpdateCancellationToken.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class UpdateCancellationToken { /// /// Gets or sets a value indicating whether cancellation has been requested. /// public bool Cancelled { get; set; } /// /// Requests cancellation of the update process. /// public void Cancel() { } /// /// Disposes the underlying cancellation token (if applicable). /// public void Dispose() { } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UpdateCheckResult.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class UpdateCheckResult { /// /// Gets or sets the update information discovered by the check. /// public UpdateInfo UpdateInfo { get; set; } = new UpdateInfo(); /// /// Gets or sets the download artifacts (if provided by the updater). /// public string[] Download { get; set; } /// /// Gets or sets the cancellation token for the update process. /// public UpdateCancellationToken CancellationToken { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UpdateFileInfo.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class UpdateFileInfo : BlockMapDataHolder { /// /// Gets or sets the URL of the update file. /// public string Url { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UpdateInfo.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with electron-updater 6.7.2 public class UpdateInfo { /// /// Gets or sets the version. /// public string Version { get; set; } /// /// Gets or sets the files included in this update. /// public UpdateFileInfo[] Files { get; set; } = new UpdateFileInfo[0]; /// /// Gets or sets the release name. /// public string ReleaseName { get; set; } /// /// Gets or sets the release notes. /// public ReleaseNoteInfo[] ReleaseNotes { get; set; } = new ReleaseNoteInfo[0]; /// /// Gets or sets the release date. /// public string ReleaseDate { get; set; } /// /// Gets or sets the staged rollout percentage, 0-100. /// public double StagingPercentage { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UploadFile.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class UploadFile : IPostData { /// /// Gets the type discriminator; constant 'file'. /// public string Type { get; } = "file"; /// /// Gets or sets the path of the file to be uploaded. /// public string FilePath { get; set; } /// /// Gets or sets the offset from the beginning of the file being uploaded, in bytes. Defaults to 0. /// public long Offset { get; set; } = 0; /// /// Gets or sets the number of bytes to read from offset. Defaults to 0. /// public long Length { get; set; } = 0; /// /// Gets or sets the last modification time in number of seconds since the UNIX epoch. Defaults to 0. /// public double ModificationTime { get; set; } = 0; } } ================================================ FILE: src/ElectronNET.API/API/Entities/UploadRawData.cs ================================================ namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class UploadRawData : IPostData { /// /// Gets the type discriminator; constant 'rawData'. /// public string Type { get; } = "rawData"; /// /// Gets or sets the data to be uploaded as raw bytes (Electron Buffer). /// public byte[] Bytes { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/UserTask.cs ================================================ using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Windows Task item used by app.setUserTasks. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("Windows")] 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; } /// /// The working directory. Default is . /// public string WorkingDirectory { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Entities/Vibrancy.cs ================================================ using System.Runtime.Serialization; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// Vibrancy types for BrowserWindow on macOS. /// /// Up-to-date with Electron API 39.2 [SupportedOSPlatform("macos")] public enum Vibrancy { /// /// Appearance-based vibrancy. /// [EnumMember(Value = "appearance-based")] appearanceBased, /// /// Title bar area. /// titlebar, /// /// Selection highlight. /// selection, /// /// Menu background. /// menu, /// /// Popover background. /// popover, /// /// Sidebar background. /// sidebar, /// /// Header background. /// header, /// /// Sheet background. /// sheet, /// /// Window background. /// window, /// /// Heads-up display. /// hud, /// /// Fullscreen UI background. /// [EnumMember(Value = "fullscreen-ui")] fullscreenUi, /// /// Tooltip background. /// tooltip, /// /// Content background. /// content, /// /// Under-window background. /// [EnumMember(Value = "under-window")] underWindow, /// /// Under-page background. /// [EnumMember(Value = "under-page")] underPage } } ================================================ FILE: src/ElectronNET.API/API/Entities/WebPreferences.cs ================================================ using System.ComponentModel; using System.Runtime.Versioning; namespace ElectronNET.API.Entities { /// /// /// /// Up-to-date with Electron API 39.2 public class WebPreferences { /// /// Whether to enable DevTools. If it is set to false, can not use /// BrowserWindow.webContents.openDevTools() to open DevTools.Default is true. /// [DefaultValue(true)] public bool DevTools { get; set; } = true; /// /// Whether node integration is enabled. Required to enable IPC. Default is true. /// [DefaultValue(true)] public bool NodeIntegration { get; set; } = true; /// /// Whether node integration is enabled in web workers. Default is false. /// public bool NodeIntegrationInWorker { get; set; } /// /// Experimental option for enabling Node.js support in sub-frames such as iframes and child windows. /// public bool NodeIntegrationInSubFrames { get; set; } /// /// Specifies a script that will be loaded before other scripts run in the page. /// This script will always have access to node APIs no matter whether node /// integration is turned on or off.The value should be the absolute file path to /// the script. When node integration is turned off, the preload script can /// reintroduce Node global symbols back to the global scope. /// public string Preload { get; set; } /// /// If set, this will sandbox the renderer associated with the window, making it compatible with the Chromium OS-level sandbox and disabling the Node.js engine. This is not the same as the nodeIntegration option and the APIs available to the preload script are more limited. Default is true since Electron 20. The sandbox will automatically be disabled when nodeIntegration is set to true. /// public bool Sandbox { get; set; } /// /// Sets the session used by the page according to the session's partition string. /// If partition starts with persist:, the page will use a persistent session /// available to all pages in the app with the same partition.If there is no /// persist: prefix, the page will use an in-memory session. By assigning the same /// partition, multiple pages can share the same session.Default is the default /// session. /// public string Partition { get; set; } /// /// The default zoom factor of the page, 3.0 represents 300%. Default is 1.0. /// [DefaultValue(1.0)] public double ZoomFactor { get; set; } = 1.0; /// /// Enables JavaScript support. Default is true. /// [DefaultValue(true)] public bool Javascript { get; set; } = true; /// /// When false, it will disable the same-origin policy (usually using testing /// websites by people), and set allowRunningInsecureContent to true if this options /// has not been set by user. Default is true. /// [DefaultValue(true)] public bool WebSecurity { get; set; } = true; /// /// Allow an https page to run JavaScript, CSS or plugins from http URLs. Default is /// false. /// public bool AllowRunningInsecureContent { get; set; } /// /// Enables image support. Default is true. /// [DefaultValue(true)] public bool Images { get; set; } = true; /// /// Specifies how to run image animations (e.g. GIFs). Can be 'animate', 'animateOnce' or 'noAnimation'. Default is 'animate'. /// public string ImageAnimationPolicy { get; set; } /// /// Make TextArea elements resizable. Default is true. /// [DefaultValue(true)] public bool TextAreasAreResizable { get; set; } = true; /// /// Enables WebGL support. Default is true. /// [DefaultValue(true)] public bool Webgl { get; set; } = true; /// /// Enables WebAudio support. Default is true. /// [DefaultValue(true)] public bool Webaudio { get; set; } = true; /// /// Whether plugins should be enabled. Default is false. /// public bool Plugins { get; set; } /// /// Enables Chromium's experimental features. Default is false. /// public bool ExperimentalFeatures { get; set; } /// /// Enables Chromium's experimental canvas features. Default is false. /// /// Not documented by MCP electronjs web-preferences. public bool ExperimentalCanvasFeatures { get; set; } /// /// Enables scroll bounce (rubber banding) effect on macOS. Default is false. /// [SupportedOSPlatform("macos")] public bool ScrollBounce { get; set; } /// /// A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to /// enable.The full list of supported feature strings can be found in the file. /// public string EnableBlinkFeatures { get; set; } /// /// A list of feature strings separated by ,, like CSSVariables,KeyboardEventKey to /// disable.The full list of supported feature strings can be found in the file. /// public string DisableBlinkFeatures { get; set; } /// /// Sets the default font for the font-family. /// public DefaultFontFamily DefaultFontFamily { get; set; } /// /// Defaults to 16. /// public int DefaultFontSize { get; set; } = 16; /// /// Defaults to 13. /// [DefaultValue(13)] public int DefaultMonospaceFontSize { get; set; } = 13; /// /// Defaults to 0. /// [DefaultValue(0)] public int MinimumFontSize { get; set; } = 0; /// /// Defaults to ISO-8859-1. /// /// Not documented by MCP electronjs web-preferences. public string DefaultEncoding { get; set; } /// /// Whether to throttle animations and timers when the page becomes background. This /// also affects the[Page Visibility API][#page-visibility]. Defaults to true. /// [DefaultValue(true)] public bool BackgroundThrottling { get; set; } = true; /// /// Whether to enable offscreen rendering for the browser window. Defaults to false. /// public bool Offscreen { get; set; } /// /// Whether to run Electron APIs and the specified preload script in a separate /// JavaScript context. Defaults to false. The context that the preload script runs /// in will still have full access to the document and window globals but it will /// use its own set of JavaScript builtins (Array, Object, JSON, etc.) and will be /// isolated from any changes made to the global environment by the loaded page.The /// Electron API will only be available in the preload script and not the loaded /// page. This option should be used when loading potentially untrusted remote /// content to ensure the loaded content cannot tamper with the preload script and /// any Electron APIs being used. This option uses the same technique used by . You /// can access this context in the dev tools by selecting the 'Electron Isolated /// Context' entry in the combo box at the top of the Console tab. This option is /// currently experimental and may change or be removed in future Electron releases. /// [DefaultValue(false)] public bool ContextIsolation { get; set; } = false; /// /// Whether to use native window.open(). Defaults to false. This option is currently experimental. /// public bool NativeWindowOpen { get; set; } /// /// 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 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 Webview's initial settings. /// /// /// true if [webview tag]; otherwise, false. /// [DefaultValue(false)] public bool WebviewTag { get; set; } = false; /// /// Whether to enable the remote module. Defaults to false. /// [DefaultValue(false)] public bool EnableRemoteModule { get; set; } = false; /// /// Gets or sets a value indicating whether to enable preferred size mode. The preferred size is the minimum size needed to contain the layout of the document—without requiring scrolling. Enabling this will cause the 'preferred-size-changed' event to be emitted on the WebContents when the preferred size changes. Default is false. /// [DefaultValue(false)] public bool EnablePreferredSizeMode { get; set; } /// /// Gets or sets a value indicating whether to enable background transparency for the guest page. Default is true. /// Note: The guest page's text and background colors are derived from the color scheme of its root element. When transparency is enabled, the text color will still change accordingly but the background will remain transparent. /// [DefaultValue(true)] public bool Transparent { get; set; } = true; /// /// Gets or sets a value indicating whether to enable the 'paste' execCommand. Deprecated. Default is false. /// [DefaultValue(false)] [System.Obsolete("enableDeprecatedPaste is deprecated in Electron; avoid using.")] public bool EnableDeprecatedPaste { get; set; } } } ================================================ FILE: src/ElectronNET.API/API/Extensions/MenuItemExtensions.cs ================================================ using ElectronNET.API.Entities; using System; using System.Collections.Generic; using System.Linq; namespace ElectronNET.API.Extensions { internal static class MenuItemExtensions { public static MenuItem[] AddMenuItemsId(this MenuItem[] menuItems) { for (int index = 0; index < menuItems.Length; index++) { var menuItem = menuItems[index]; if (menuItem?.Submenu?.Length > 0) { AddMenuItemsId(menuItem.Submenu); } if (string.IsNullOrEmpty(menuItem.Id) && menuItem.Click != null) { menuItem.Id = Guid.NewGuid().ToString(); } } return menuItems; } public static MenuItem GetMenuItem(this List menuItems, string id) { MenuItem result = new MenuItem(); foreach (var item in menuItems) { if (item.Id == id) { result = item; } else if (item?.Submenu?.Length > 0) { var menuItem = GetMenuItem(item.Submenu.ToList(), id); if (menuItem.Id == id) { result = menuItem; } } } return result; } public static MenuItem[] AddSubmenuTypes(this MenuItem[] menuItems) { for (int index = 0; index < menuItems.Length; index++) { var menuItem = menuItems[index]; if (menuItem?.Submenu?.Length > 0) { if (menuItem.Type == MenuType.normal) { menuItem.Type = MenuType.submenu; } AddSubmenuTypes(menuItem.Submenu); } } return menuItems; } } } ================================================ FILE: src/ElectronNET.API/API/Extensions/ThumbarButtonExtensions.cs ================================================ using ElectronNET.API.Entities; using System; using System.Collections.Generic; namespace ElectronNET.API.Extensions { internal static class ThumbarButtonExtensions { public static ThumbarButton[] AddThumbarButtonsId(this ThumbarButton[] thumbarButtons) { for (int index = 0; index < thumbarButtons.Length; index++) { var thumbarButton = thumbarButtons[index]; if (string.IsNullOrEmpty(thumbarButton.Id)) { thumbarButton.Id = Guid.NewGuid().ToString(); } } return thumbarButtons; } public static ThumbarButton GetThumbarButton(this List thumbarButtons, string id) { ThumbarButton result = new ThumbarButton(""); foreach (var item in thumbarButtons) { if (item.Id == id) { result = item; } } return result; } } } ================================================ FILE: src/ElectronNET.API/API/GlobalShortcut.cs ================================================ using System; using System.Collections.Generic; using System.Text.Json; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Detect keyboard events when the application does not have keyboard focus. /// public sealed class GlobalShortcut { private static GlobalShortcut _globalShortcut; private static object _syncRoot = new object(); internal GlobalShortcut() { } internal static GlobalShortcut Instance { get { if (_globalShortcut == null) { lock (_syncRoot) { if (_globalShortcut == null) { _globalShortcut = new GlobalShortcut(); } } } return _globalShortcut; } } private Dictionary _shortcuts = new Dictionary(); /// /// Registers a global shortcut of accelerator. /// The callback is called when the registered shortcut is pressed by the user. /// /// When the accelerator is already taken by other applications, this call will /// silently fail.This behavior is intended by operating systems, since they don’t /// want applications to fight for global shortcuts. /// public void Register(string accelerator, Action function) { if (!_shortcuts.ContainsKey(accelerator)) { _shortcuts.Add(accelerator, function); BridgeConnector.Socket.Off("globalShortcut-pressed"); BridgeConnector.Socket.On("globalShortcut-pressed", (shortcut) => { if (_shortcuts.TryGetValue(shortcut, out var action)) { action(); } }); BridgeConnector.Socket.Emit("globalShortcut-register", accelerator); } } /// /// When the accelerator is already taken by other applications, /// this call will still return false. This behavior is intended by operating systems, /// since they don’t want applications to fight for global shortcuts. /// /// Whether this application has registered accelerator. public Task IsRegisteredAsync(string accelerator) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("globalShortcut-isRegisteredCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("globalShortcut-isRegistered", accelerator); return tcs.Task; } /// /// Unregisters the global shortcut of accelerator. /// public void Unregister(string accelerator) { _shortcuts.Remove(accelerator); BridgeConnector.Socket.Emit("globalShortcut-unregister", accelerator); } /// /// Unregisters all of the global shortcuts. /// public void UnregisterAll() { _shortcuts.Clear(); BridgeConnector.Socket.Emit("globalShortcut-unregisterAll"); } } } ================================================ FILE: src/ElectronNET.API/API/HostHook.cs ================================================ using ElectronNET.API.Serialization; using System; using System.Text.Json; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Allows you to execute native JavaScript/TypeScript code from the host process. /// /// It is only possible if the Electron.NET CLI has previously added an /// ElectronHostHook directory: /// electronize add HostHook /// public sealed class HostHook { private static HostHook _electronHostHook; private static object _syncRoot = new object(); private string oneCallguid = Guid.NewGuid().ToString(); internal HostHook() { } internal static HostHook Instance { get { if (_electronHostHook == null) { lock (_syncRoot) { if (_electronHostHook == null) { _electronHostHook = new HostHook(); } } } return _electronHostHook; } } /// /// Execute native JavaScript/TypeScript code. /// /// Socket name registered on the host. /// Optional parameters. public void Call(string socketEventName, params dynamic[] arguments) { BridgeConnector.Socket.Once(socketEventName + "Error" + oneCallguid, (result) => { Electron.Dialog.ShowErrorBox("Host Hook Exception", result); }); BridgeConnector.Socket.Emit(socketEventName, arguments, oneCallguid); } /// /// Execute native JavaScript/TypeScript code. /// /// Results from the executed host code. /// Socket name registered on the host. /// Optional parameters. /// public Task CallAsync(string socketEventName, params dynamic[] arguments) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once(socketEventName + "Error" + guid, (result) => { Electron.Dialog.ShowErrorBox("Host Hook Exception", result); tcs.SetException(new Exception($"Host Hook Exception {result}")); }); BridgeConnector.Socket.Once(socketEventName + "Complete" + guid, (result) => { BridgeConnector.Socket.Off(socketEventName + "Error" + guid); T data = default; try { data = result.Deserialize(ElectronJson.Options); } catch (Exception exception) { tcs.SetException(exception); } tcs.SetResult(data); }); BridgeConnector.Socket.Emit(socketEventName, arguments, guid); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/HybridSupport.cs ================================================ 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 { return ElectronNetRuntime.RuntimeController != null; } } } } ================================================ FILE: src/ElectronNET.API/API/IpcMain.cs ================================================ namespace ElectronNET.API { using System; using System.Diagnostics; using System.Linq; using System.Text.Json; using System.Text.Json.Serialization; using System.Threading.Tasks; using ElectronNET.Serialization; /// /// Communicate asynchronously from the main process to renderer processes. /// public sealed class IpcMain { private static IpcMain _ipcMain; private static object _syncRoot = new object(); private static readonly JsonSerializerOptions BoxedObjectSerializationOptions = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, WriteIndented = false, Converters = { new JsonStringEnumConverter(JsonNamingPolicy.CamelCase), new JsonToBoxedPrimitivesConverter(), } }; internal IpcMain() { } internal static IpcMain Instance { get { if (_ipcMain == null) { lock (_syncRoot) { if (_ipcMain == null) { _ipcMain = new IpcMain(); } } } return _ipcMain; } } /// /// Listens to channel, when a new message arrives listener would be called with /// listener(event, args...). /// /// Channelname. /// Callback Method. public async Task On(string channel, Action listener) { await BridgeConnector.Socket.Emit("registerIpcMainChannel", channel).ConfigureAwait(false); BridgeConnector.Socket.Off(channel); BridgeConnector.Socket.On(channel, (args) => { var arg = FormatArguments(args); listener(arg); }); } private static object FormatArguments(JsonElement args) { var objectArray = args.Deserialize(BoxedObjectSerializationOptions).ToList(); Debug.Assert(objectArray.Count <= 2); if (objectArray.Count == 2) { return objectArray[1]; } return null; } /// /// Send a message to the renderer process synchronously via channel, /// you can also send arbitrary arguments. /// /// Note: Sending a synchronous message will block the whole renderer process, /// unless you know what you are doing you should never use it. /// /// /// public void OnSync(string channel, Func listener) { BridgeConnector.Socket.Emit("registerSyncIpcMainChannel", channel); BridgeConnector.Socket.On(channel, (args) => { var arg = FormatArguments(args); var result = listener(arg); BridgeConnector.Socket.Emit(channel + "Sync", result); }); } /// /// Send a message to the renderer process synchronously via channel, /// you can also send arbitrary arguments. /// /// Note: Sending a synchronous message will block the whole renderer process, /// unless you know what you are doing you should never use it. /// /// /// public void OnSync(string channel, Func> listener) { BridgeConnector.Socket.Emit("registerSyncIpcMainChannel", channel); BridgeConnector.Socket.On(channel, (args) => { Task.Run(async () => { var arg = FormatArguments(args); var result = await listener(arg); BridgeConnector.Socket.Emit(channel + "Sync", result); }); }); } /// /// Adds a one time listener method for the event. This listener is invoked only /// the next time a message is sent to channel, after which it is removed. /// /// Channelname. /// Callback Method. public void Once(string channel, Action listener) { BridgeConnector.Socket.Emit("registerOnceIpcMainChannel", channel); BridgeConnector.Socket.Once(channel, (args) => { var arg = FormatArguments(args); listener(arg); }); } /// /// Removes listeners of the specified channel. /// /// Channelname. public void RemoveAllListeners(string channel) { BridgeConnector.Socket.Emit("removeAllListenersIpcMainChannel", channel); } /// /// Send a message to the renderer process asynchronously via channel, you can also send /// arbitrary arguments. Arguments will be serialized in JSON internally and hence /// no functions or prototype chain will be included. The renderer process handles it by /// listening for channel with ipcRenderer module. /// /// BrowserWindow with channel. /// Channelname. /// Arguments data. public void Send(BrowserWindow browserWindow, string channel, params object[] data) { BridgeConnector.Socket.Emit("sendToIpcRenderer", browserWindow, channel, data); } /// /// Send a message to the BrowserView renderer process asynchronously via channel, you can also send /// arbitrary arguments. Arguments will be serialized in JSON internally and hence /// no functions or prototype chain will be included. The renderer process handles it by /// listening for channel with ipcRenderer module. /// /// BrowserView with channel. /// Channelname. /// Arguments data. public void Send(BrowserView browserView, string channel, params object[] data) { BridgeConnector.Socket.Emit("sendToIpcRendererBrowserView", browserView.Id, channel, data); } /// /// Adds a handler for an invokeable IPC. This handler will be called /// whenever a renderer calls ipcRenderer.invoke(channel, ...args). /// /// Channelname. /// Callback Method. public void Handle(string channel, Func listener) { BridgeConnector.Socket.Emit("registerHandleIpcMainChannel", channel); BridgeConnector.Socket.On(channel, (args) => { var arg = FormatArguments(args); var result = listener(arg); BridgeConnector.Socket.Emit(channel + "Handle", result); }); } /// /// Adds a handler for an invokeable IPC. This handler will be called /// whenever a renderer calls ipcRenderer.invoke(channel, ...args). /// /// Channelname. /// Callback Method. public void Handle(string channel, Func> listener) { BridgeConnector.Socket.Emit("registerHandleIpcMainChannel", channel); BridgeConnector.Socket.On(channel, (args) => { Task.Run(async () => { var arg = FormatArguments(args); var result = await listener(arg); BridgeConnector.Socket.Emit(channel + "Handle", result); }); }); } /// /// Handles a single invokeable IPC message, then removes the listener. /// See ipcMain.handle(channel, listener). /// /// Channelname. /// Callback Method. public void HandleOnce(string channel, Func listener) { BridgeConnector.Socket.Emit("registerHandleOnceIpcMainChannel", channel); BridgeConnector.Socket.Once(channel, (args) => { var arg = FormatArguments(args); var result = listener(arg); BridgeConnector.Socket.Emit(channel + "HandleOnce", result); }); } /// /// Handles a single invokeable IPC message, then removes the listener. /// See ipcMain.handle(channel, listener). /// /// Channelname. /// Callback Method. public void HandleOnce(string channel, Func> listener) { BridgeConnector.Socket.Emit("registerHandleOnceIpcMainChannel", channel); BridgeConnector.Socket.Once(channel, (args) => { Task.Run(async () => { var arg = FormatArguments(args); var result = await listener(arg); BridgeConnector.Socket.Emit(channel + "HandleOnce", result); }); }); } /// /// Removes any handler for channel, if present. /// /// Channelname. public void RemoveHandler(string channel) { BridgeConnector.Socket.Emit("removeHandlerIpcMainChannel", channel); } } } ================================================ FILE: src/ElectronNET.API/API/Menu.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Extensions; using ElectronNET.API.Serialization; using System.Collections.Generic; using System.Collections.ObjectModel; using System.Linq; using System.Text.Json; namespace ElectronNET.API { /// /// Create native application menus and context menus. /// public sealed class Menu { private static Menu _menu; private static object _syncRoot = new object(); internal Menu() { } internal static Menu Instance { get { if (_menu == null) { lock (_syncRoot) { if (_menu == null) { _menu = new Menu(); } } } return _menu; } } /// /// 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(); menuItems.AddMenuItemsId(); menuItems.AddSubmenuTypes(); BridgeConnector.Socket.Emit("menu-setApplicationMenu", new[] { menuItems }); _menuItems.AddRange(menuItems); BridgeConnector.Socket.Off("menuItemClicked"); BridgeConnector.Socket.On("menuItemClicked", (id) => { MenuItem menuItem = _menuItems.GetMenuItem(id); menuItem.Click?.Invoke(); }); } /// /// 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) { menuItems.AddMenuItemsId(); menuItems.AddSubmenuTypes(); BridgeConnector.Socket.Emit("menu-setContextMenu", browserWindow.Id, menuItems); if (!_contextMenuItems.ContainsKey(browserWindow.Id)) { _contextMenuItems.Add(browserWindow.Id, menuItems.ToList()); var x = _contextMenuItems.ToDictionary(kv => kv.Key, kv => kv.Value.AsReadOnly()); ContextMenuItems = new ReadOnlyDictionary>(x); } BridgeConnector.Socket.Off("contextMenuItemClicked"); BridgeConnector.Socket.On("contextMenuItemClicked", (results) => { var arr = results.EnumerateArray(); var e = arr.GetEnumerator(); e.MoveNext(); var id = e.Current.GetString(); e.MoveNext(); var browserWindowId = e.Current.GetInt32(); MenuItem menuItem = _contextMenuItems[browserWindowId].GetMenuItem(id); menuItem.Click?.Invoke(); }); } /// /// Contexts the menu popup. /// /// The browser window. public void ContextMenuPopup(BrowserWindow browserWindow) { BridgeConnector.Socket.Emit("menu-contextMenuPopup", browserWindow.Id); } } } ================================================ FILE: src/ElectronNET.API/API/NativeTheme.cs ================================================ using System; using System.Runtime.Versioning; using System.Threading.Tasks; using ElectronNET.API.Entities; using ElectronNET.API.Extensions; namespace ElectronNET.API { /// /// Read and respond to changes in Chromium's native color theme. /// public sealed class NativeTheme : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; private static NativeTheme _nativeTheme; private static object _syncRoot = new object(); internal NativeTheme() { } internal static NativeTheme Instance { get { if (_nativeTheme == null) { lock (_syncRoot) { if (_nativeTheme == null) { _nativeTheme = new NativeTheme(); } } } return _nativeTheme; } } /// /// Setting this property to will remove the override and everything will be reset to the OS default. By default 'ThemeSource' is . /// /// Settings this property to will have the following effects: /// /// /// will be when accessed /// /// /// Any UI Electron renders on Linux and Windows including context menus, devtools, etc. will use the dark UI. /// /// /// Any UI the OS renders on macOS including menus, window frames, etc. will use the dark UI. /// /// /// The 'prefers-color-scheme' CSS query will match 'dark' mode. /// /// /// The 'updated' event will be emitted /// /// /// /// Settings this property to will have the following effects: /// /// /// will be when accessed /// /// /// Any UI Electron renders on Linux and Windows including context menus, devtools, etc. will use the light UI. /// /// /// Any UI the OS renders on macOS including menus, window frames, etc. will use the light UI. /// /// /// The 'prefers-color-scheme' CSS query will match 'light' mode. /// /// /// The 'updated' event will be emitted /// /// /// The usage of this property should align with a classic "dark mode" state machine in your application where the user has three options. /// /// /// /// Follow OS: SetThemeSource(ThemeSourceMode.System); /// /// /// Dark Mode: SetThemeSource(ThemeSourceMode.Dark); /// /// /// Light Mode: SetThemeSource(ThemeSourceMode.Light); /// /// /// Your application should then always use to determine what CSS to apply. /// /// The new ThemeSource. public void SetThemeSource(ThemeSourceMode themeSourceMode) { var themeSource = themeSourceMode; BridgeConnector.Socket.Emit("nativeTheme-themeSource", themeSource); } /// /// A property that can be , or . It is used to override () and /// supercede the value that Chromium has chosen to use internally. /// public Task GetThemeSourceAsync() => this.InvokeAsync(); /// /// A for if the OS / Chromium currently has a dark mode enabled or is /// being instructed to show a dark-style UI. If you want to modify this value you /// should use . /// public Task ShouldUseDarkColorsAsync() => this.InvokeAsync(); /// /// A for if the OS / Chromium currently has high-contrast mode enabled or is /// being instructed to show a high-contrast UI. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task ShouldUseHighContrastColorsAsync() => this.InvokeAsync(); /// /// A for if the OS / Chromium currently has an inverted color scheme or is /// being instructed to use an inverted color scheme. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public Task ShouldUseInvertedColorSchemeAsync() => this.InvokeAsync(); /// /// Emitted when something in the underlying NativeTheme has changed. This normally means that either the value of , /// or has changed. You will have to check them to determine which one has changed. /// public event Action Updated { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } } } ================================================ FILE: src/ElectronNET.API/API/Notification.cs ================================================ using ElectronNET.API.Entities; using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Create OS desktop notifications /// public sealed class Notification : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.NoDashUpperFirst; private static Notification _notification; private static object _syncRoot = new object(); internal Notification() { } internal static Notification Instance { get { if (_notification == null) { lock (_syncRoot) { if (_notification == null) { _notification = new Notification(); } } } return _notification; } } private static List _notificationOptions = new List(); /// /// Create OS desktop notifications /// /// public void Show(NotificationOptions notificationOptions) { GenerateIDsForDefinedActions(notificationOptions); BridgeConnector.Socket.Emit("createNotification", notificationOptions); } private static void GenerateIDsForDefinedActions(NotificationOptions notificationOptions) { bool isActionDefined = false; if (notificationOptions.OnShow != null) { notificationOptions.ShowID = Guid.NewGuid().ToString(); isActionDefined = true; BridgeConnector.Socket.Off("NotificationEventShow"); BridgeConnector.Socket.On("NotificationEventShow", (id) => { _notificationOptions.Single(x => x.ShowID == id).OnShow(); }); } if (notificationOptions.OnClick != null) { notificationOptions.ClickID = Guid.NewGuid().ToString(); isActionDefined = true; BridgeConnector.Socket.Off("NotificationEventClick"); BridgeConnector.Socket.On("NotificationEventClick", (id) => { _notificationOptions.Single(x => x.ClickID == id).OnClick(); }); } if (notificationOptions.OnClose != null) { notificationOptions.CloseID = Guid.NewGuid().ToString(); isActionDefined = true; BridgeConnector.Socket.Off("NotificationEventClose"); BridgeConnector.Socket.On("NotificationEventClose", (id) => { _notificationOptions.Single(x => x.CloseID == id).OnClose(); }); } if (notificationOptions.OnReply != null) { notificationOptions.ReplyID = Guid.NewGuid().ToString(); isActionDefined = true; BridgeConnector.Socket.Off("NotificationEventReply"); BridgeConnector.Socket.On("NotificationEventReply", (args) => { _notificationOptions.Single(x => x.ReplyID == args[0]).OnReply(args[1]); }); } if (notificationOptions.OnAction != null) { notificationOptions.ActionID = Guid.NewGuid().ToString(); isActionDefined = true; BridgeConnector.Socket.Off("NotificationEventAction"); BridgeConnector.Socket.On("NotificationEventAction", (args) => { var opt = _notificationOptions.Single(x => x.ActionID == args[0]); if (int.TryParse(args[1], out var index)) { opt.OnAction(index); } }); } if (isActionDefined) { _notificationOptions.Add(notificationOptions); } } /// /// Whether or not desktop notifications are supported on the current system. /// /// public Task IsSupportedAsync() => this.InvokeAsync(); } } ================================================ FILE: src/ElectronNET.API/API/PowerMonitor.cs ================================================ using System; using System.Runtime.Versioning; // ReSharper disable InconsistentNaming namespace ElectronNET.API { /// /// Monitor power state changes.. /// public sealed class PowerMonitor : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Emitted when the system is about to lock the screen. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnLockScreen { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when the system is about to unlock the screen. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnUnLockScreen { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when the system is suspending. /// public event Action OnSuspend { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when system is resuming. /// public event Action OnResume { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when the system changes to AC power. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnAC { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when system changes to battery power. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnBattery { add => AddEvent(value); remove => RemoveEvent(value); } /// /// Emitted when the system is about to reboot or shut down. If the event handler /// invokes `e.preventDefault()`, Electron will attempt to delay system shutdown in /// order for the app to exit cleanly.If `e.preventDefault()` is called, the app /// should exit as soon as possible by calling something like `app.quit()`. /// [SupportedOSPlatform("Linux")] [SupportedOSPlatform("macOS")] public event Action OnShutdown { add => AddEvent(value); remove => RemoveEvent(value); } private static PowerMonitor _powerMonitor; private static object _syncRoot = new object(); internal PowerMonitor() { } internal static PowerMonitor Instance { get { if (_powerMonitor == null) { lock (_syncRoot) { if (_powerMonitor == null) { _powerMonitor = new PowerMonitor(); } } } return _powerMonitor; } } } } ================================================ FILE: src/ElectronNET.API/API/Process.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System.Text.Json; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Electron's process object is extended from the Node.js process object. It adds the /// events, properties, and methods. /// public sealed class Process : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; internal Process() { } internal static Process Instance { get { if (_process == null) { lock (_syncRoot) { if (_process == null) { _process = new Process(); } } } return _process; } } private static Process _process; private static readonly object _syncRoot = new(); /// /// The process.execPath property returns the absolute pathname of the executable that /// started the Node.js process. Symbolic links, if any, are resolved. /// public Task ExecPathAsync => this.InvokeAsync(); /// /// The process.argv property returns an array containing the command-line arguments passed /// when the Node.js process was launched. The first element will be process.execPath. See /// process.argv0 if access to the original value of argv[0] is needed. The second element /// will be the path to the JavaScript file being executed. The remaining elements will be /// any additional command-line arguments /// public Task ArgvAsync => this.InvokeAsync(); /// /// The process.execPath property returns the absolute pathname of the executable that /// started the Node.js process. Symbolic links, if any, are resolved. /// public Task TypeAsync => this.InvokeAsync(); /// /// The process.versions property returns an object listing the version strings of /// chrome and electron. /// public Task VersionsAsync => this.InvokeAsync(); /// /// A Boolean. When app is started by being passed as parameter to the default app, this /// property is true in the main process, otherwise it is false. /// public Task DefaultAppAsync => this.InvokeAsync(); /// /// A Boolean, true when the current renderer context is the "main" renderer frame. If you /// want the ID of the current frame you should use webFrame.routingId /// public Task IsMainFrameAsync => this.InvokeAsync(); /// /// A String representing the path to the resources directory. /// public Task ResourcesPathAsync => this.InvokeAsync(); /// /// The number of seconds the current Node.js process has been running. The return value /// includes fractions of a second. Use Math.floor() to get whole seconds. /// public Task UpTimeAsync => this.InvokeAsync(); /// /// The PID of the electron process /// public Task PidAsync => this.InvokeAsync(); /// /// The operating system CPU architecture for which the Node.js binary was compiled /// public Task ArchAsync => this.InvokeAsync(); /// /// A string identifying the operating system platform on which the Node.js process is running /// public Task PlatformAsync => this.InvokeAsync(); } } ================================================ FILE: src/ElectronNET.API/API/QuitEventArgs.cs ================================================ namespace ElectronNET.API { /// /// Event arguments for the / event. /// public sealed class QuitEventArgs { /// /// Will prevent the default behaviour, which is terminating the application. /// public void PreventDefault() { Electron.App.PreventQuit(); } } } ================================================ FILE: src/ElectronNET.API/API/Screen.cs ================================================ using ElectronNET.API.Entities; using System; using System.Linq; using System.Runtime.Versioning; using System.Text.Json; using System.Threading.Tasks; using ElectronNET.API.Serialization; namespace ElectronNET.API { /// /// Retrieve information about screen size, displays, cursor position, etc. /// public sealed class Screen : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Emitted when an new Display has been added. /// public event Action OnDisplayAdded { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when oldDisplay has been removed. /// public event Action OnDisplayRemoved { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Emitted when one or more metrics change in a display. /// The changedMetrics is an array of strings that describe the changes. /// Possible changes are bounds, workArea, scaleFactor and rotation. /// public event Action OnDisplayMetricsChanged { add { if (_onDisplayMetricsChanged == null) { BridgeConnector.Socket.On("screen-display-metrics-changed" + GetHashCode(), (args) => { var arr = args.EnumerateArray().ToArray(); var display = arr[0].Deserialize(ElectronJsonContext.Default.Display); var metrics = arr[1].Deserialize(ElectronJson.Options); _onDisplayMetricsChanged(display, metrics); }); BridgeConnector.Socket.Emit("register-screen-display-metrics-changed", GetHashCode()); } _onDisplayMetricsChanged += value; } remove { _onDisplayMetricsChanged -= value; if (_onDisplayMetricsChanged == null) { BridgeConnector.Socket.Off("screen-display-metrics-changed" + GetHashCode()); } } } private event Action _onDisplayMetricsChanged; private static Screen _screen; private static object _syncRoot = new object(); internal Screen() { } internal static Screen Instance { get { if (_screen == null) { lock (_syncRoot) { if (_screen == null) { _screen = new Screen(); } } } return _screen; } } /// /// The current absolute position of the mouse pointer. /// /// public Task GetCursorScreenPointAsync() => this.InvokeAsync(); /// /// macOS: The height of the menu bar in pixels. /// /// The height of the menu bar in pixels. [SupportedOSPlatform("macOS")] public Task GetMenuBarWorkAreaAsync() => this.InvokeAsync(); /// /// The primary display. /// /// public Task GetPrimaryDisplayAsync() => this.InvokeAsync(); /// /// An array of displays that are currently available. /// /// An array of displays that are currently available. public Task GetAllDisplaysAsync() => this.InvokeAsync(); /// /// An array of displays that are currently available. /// /// The invocation timeout. /// /// An array of displays that are currently available. /// public Task GetAllDisplaysAsync(TimeSpan invocationTimeout) => this.InvokeAsyncWithTimeout(invocationTimeout); /// /// The display nearest the specified point. /// /// The display nearest the specified point. public Task GetDisplayNearestPointAsync(Point point) => this.InvokeAsync(point); /// /// The display that most closely intersects the provided bounds. /// /// /// The display that most closely intersects the provided bounds. public Task GetDisplayMatchingAsync(Rectangle rectangle) => this.InvokeAsync(rectangle); } } ================================================ FILE: src/ElectronNET.API/API/Session.cs ================================================ using ElectronNET.API.Entities; using System; using System.Threading.Tasks; namespace ElectronNET.API { /// /// Manage browser sessions, cookies, cache, proxy settings, etc. /// public class Session { /// /// Gets the identifier. /// /// /// The identifier. /// public int Id { get; private set; } /// /// Query and modify a session's cookies. /// public Cookies Cookies { get; } public WebRequest WebRequest { get; private set; } internal Session(int id) { Id = id; Cookies = new Cookies(id); WebRequest = new WebRequest(id); } /// /// Dynamically sets whether to always send credentials for HTTP NTLM or Negotiate authentication. /// /// A comma-separated list of servers for which integrated authentication is enabled. public void AllowNTLMCredentialsForDomains(string domains) { BridgeConnector.Socket.Emit("webContents-session-allowNTLMCredentialsForDomains", Id, domains); } /// /// Clears the session’s HTTP authentication cache. /// /// /// public Task ClearAuthCacheAsync(RemovePassword options) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearAuthCache-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearAuthCache", Id, options, guid); return tcs.Task; } /// /// Clears the session’s HTTP authentication cache. /// public Task ClearAuthCacheAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearAuthCache-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearAuthCache", Id, guid); return tcs.Task; } /// /// Clears the session’s HTTP cache. /// /// public Task ClearCacheAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearCache-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearCache", Id, guid); return tcs.Task; } /// /// Clears the host resolver cache. /// /// public Task ClearHostResolverCacheAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearHostResolverCache-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearHostResolverCache", Id, guid); return tcs.Task; } /// /// Clears the data of web storages. /// /// public Task ClearStorageDataAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearStorageData-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearStorageData", Id, guid); return tcs.Task; } /// /// Clears the data of web storages. /// /// /// public Task ClearStorageDataAsync(ClearStorageDataOptions options) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-clearStorageData-options-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-clearStorageData-options", Id, options, guid); return tcs.Task; } /// /// Allows resuming cancelled or interrupted downloads from previous Session. The /// API will generate a DownloadItem that can be accessed with the will-download /// event. The DownloadItem will not have any WebContents associated with it and the /// initial state will be interrupted. The download will start only when the resume /// API is called on the DownloadItem. /// /// public void CreateInterruptedDownload(CreateInterruptedDownloadOptions options) { BridgeConnector.Socket.Emit("webContents-session-createInterruptedDownload", Id, options); } /// /// Disables any network emulation already active for the session. Resets to the /// original network configuration. /// public void DisableNetworkEmulation() { BridgeConnector.Socket.Emit("webContents-session-disableNetworkEmulation", Id); } /// /// Emulates network with the given configuration for the session. /// /// public void EnableNetworkEmulation(EnableNetworkEmulationOptions options) { BridgeConnector.Socket.Emit("webContents-session-enableNetworkEmulation", Id, options); } /// /// Writes any unwritten DOMStorage data to disk. /// public void FlushStorageData() { BridgeConnector.Socket.Emit("webContents-session-flushStorageData", Id); } /// /// /// /// /// public Task GetBlobDataAsync(string identifier) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-getBlobData-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-getBlobData", Id, identifier, guid); return tcs.Task; } /// /// Get session's current cache size. /// /// Callback is invoked with the session's current cache size. public Task GetCacheSizeAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-getCacheSize-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-getCacheSize", Id, guid); return tcs.Task; } /// /// /// /// public Task GetPreloadsAsync() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-getPreloads-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-getPreloads", Id, guid); return tcs.Task; } /// /// /// /// public Task GetUserAgent() { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-getUserAgent-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-getUserAgent", Id, guid); return tcs.Task; } /// /// Resolves the proxy information for url. The callback will be called with /// callback(proxy) when the request is performed. /// /// /// public Task ResolveProxyAsync(string url) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-resolveProxy-completed" + guid, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-resolveProxy", Id, url, guid); return tcs.Task; } /// /// Sets download saving directory. By default, the download directory will be the /// Downloads under the respective app folder. /// /// public void SetDownloadPath(string path) { BridgeConnector.Socket.Emit("webContents-session-setDownloadPath", Id, path); } /// /// Adds scripts that will be executed on ALL web contents that are associated with /// this session just before normal preload scripts run. /// /// public void SetPreloads(string[] preloads) { BridgeConnector.Socket.Emit("webContents-session-setPreloads", Id, preloads); } /// /// Sets the proxy settings. When pacScript and proxyRules are provided together, /// the proxyRules option is ignored and pacScript configuration is applied. /// /// /// public Task SetProxyAsync(ProxyConfig config) { var tcs = new TaskCompletionSource(); string guid = Guid.NewGuid().ToString(); BridgeConnector.Socket.Once("webContents-session-setProxy-completed" + guid, () => tcs.SetResult()); BridgeConnector.Socket.Emit("webContents-session-setProxy", Id, config, guid); return tcs.Task; } /// /// Overrides the userAgent for this session. This doesn't affect existing WebContents, and /// each WebContents can use webContents.setUserAgent to override the session-wide /// user agent. /// /// public void SetUserAgent(string userAgent) { BridgeConnector.Socket.Emit("webContents-session-setUserAgent", Id, userAgent); } /// /// Overrides the userAgent and acceptLanguages for this session. The /// acceptLanguages must a comma separated ordered list of language codes, for /// example "en-US,fr,de,ko,zh-CN,ja". This doesn't affect existing WebContents, and /// each WebContents can use webContents.setUserAgent to override the session-wide /// user agent. /// /// /// The /// acceptLanguages must a comma separated ordered list of language codes, for /// example "en-US,fr,de,ko,zh-CN,ja". public void SetUserAgent(string userAgent, string acceptLanguages) { BridgeConnector.Socket.Emit("webContents-session-setUserAgent", Id, userAgent, acceptLanguages); } /// /// The keys are the extension names and each value is an object containing name and version properties. /// Note: This API cannot be called before the ready event of the app module is emitted. /// /// public Task GetAllExtensionsAsync() { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-session-getAllExtensions-completed", tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-getAllExtensions", Id); return tcs.Task; } /// /// Remove Chrome extension with the specified name. /// Note: This API cannot be called before the ready event of the app module is emitted. /// /// Name of the Chrome extension to remove public void RemoveExtension(string name) { BridgeConnector.Socket.Emit("webContents-session-removeExtension", Id, name); } /// /// resolves when the extension is loaded. /// /// This method will raise an exception if the extension could not be loaded.If /// there are warnings when installing the extension (e.g. if the extension requests /// an API that Electron does not support) then they will be logged to the console. /// /// Note that Electron does not support the full range of Chrome extensions APIs. /// See Supported Extensions APIs for more details on what is supported. /// /// Note that in previous versions of Electron, extensions that were loaded would be /// remembered for future runs of the application.This is no longer the case: /// `loadExtension` must be called on every boot of your app if you want the /// extension to be loaded. /// /// This API does not support loading packed (.crx) extensions. /// ///** Note:** This API cannot be called before the `ready` event of the `app` module /// is emitted. /// ///** Note:** Loading extensions into in-memory(non-persistent) sessions is not supported and will throw an error. /// /// Path to the Chrome extension /// Whether to allow the extension to read local files over `file://` protocol and /// inject content scripts into `file://` pages. This is required e.g. for loading /// devtools extensions on `file://` URLs. Defaults to false. /// public Task LoadExtensionAsync(string path, bool allowFileAccess = false) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-session-loadExtension-completed", tcs.SetResult); BridgeConnector.Socket.Emit("webContents-session-loadExtension", Id, path, allowFileAccess); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/Shell.cs ================================================ using System.Runtime.Versioning; using System.Threading.Tasks; using ElectronNET.API.Entities; using ElectronNET.API.Extensions; namespace ElectronNET.API { /// /// Manage files and URLs using their default applications. /// public sealed class Shell { private static Shell _shell; private static object _syncRoot = new object(); internal Shell() { } internal static Shell Instance { get { if (_shell == null) { lock (_syncRoot) { if (_shell == null) { _shell = new Shell(); } } } return _shell; } } /// /// Show the given file in a file manager. If possible, select the file. /// /// The full path to the directory / file. public Task ShowItemInFolderAsync(string fullPath) { BridgeConnector.Socket.Emit("shell-showItemInFolder", fullPath); return Task.CompletedTask; } /// /// Open the given file in the desktop's default manner. /// /// The path to the directory / file. /// The error message corresponding to the failure if a failure occurred, otherwise . public Task OpenPathAsync(string path) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("shell-openPathCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("shell-openPath", path); return tcs.Task; } /// /// Open the given external protocol URL in the desktop’s default manner. /// (For example, mailto: URLs in the user’s default mail agent). /// /// Max 2081 characters on windows. /// The error message corresponding to the failure if a failure occurred, otherwise . public Task OpenExternalAsync(string url) { return OpenExternalAsync(url, null); } /// /// Open the given external protocol URL in the desktop’s default manner. /// (For example, mailto: URLs in the user’s default mail agent). /// /// Max 2081 characters on windows. /// Controls the behavior of OpenExternal. /// The error message corresponding to the failure if a failure occurred, otherwise . public Task OpenExternalAsync(string url, OpenExternalOptions options) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("shell-openExternalCompleted", tcs.SetResult); if (options == null) { BridgeConnector.Socket.Emit("shell-openExternal", url); } else { BridgeConnector.Socket.Emit("shell-openExternal", url, options); } return tcs.Task; } /// /// Move the given file to trash and returns a status for the operation. /// /// The full path to the directory / file. /// Whether the item was successfully moved to the trash. public Task TrashItemAsync(string fullPath) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("shell-trashItem-completed", tcs.SetResult); BridgeConnector.Socket.Emit("shell-trashItem", fullPath); return tcs.Task; } /// /// Play the beep sound. /// public void Beep() { BridgeConnector.Socket.Emit("shell-beep"); } /// /// Creates or updates a shortcut link at shortcutPath. /// /// The path to the shortcut. /// Default is /// Structure of a shortcut. /// Whether the shortcut was created successfully. [SupportedOSPlatform("Windows")] public Task WriteShortcutLinkAsync(string shortcutPath, ShortcutLinkOperation operation, ShortcutDetails options) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("shell-writeShortcutLinkCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("shell-writeShortcutLink", shortcutPath, operation, options); return tcs.Task; } /// /// Resolves the shortcut link at shortcutPath. /// An exception will be thrown when any error happens. /// /// The path tot the shortcut. /// of the shortcut. [SupportedOSPlatform("Windows")] public Task ReadShortcutLinkAsync(string shortcutPath) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("shell-readShortcutLinkCompleted", tcs.SetResult); BridgeConnector.Socket.Emit("shell-readShortcutLink", shortcutPath); return tcs.Task; } } } ================================================ FILE: src/ElectronNET.API/API/Tray.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Extensions; using System; using System.Collections.Generic; using System.Linq; using System.Runtime.Versioning; using System.Text.Json; using System.Threading.Tasks; using ElectronNET.API.Serialization; // ReSharper disable InconsistentNaming namespace ElectronNET.API { /// /// Add icons and context menus to the system's notification area. /// public sealed class Tray : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.DashedLower; /// /// Emitted when the tray icon is clicked. /// public event Action OnClick { add { if (_click == null) { BridgeConnector.Socket.On("tray-click" + GetHashCode(), (result) => { var array = result.EnumerateArray().ToArray(); var trayClickEventArgs = array[0].Deserialize(ElectronJsonContext.Default.TrayClickEventArgs); var bounds = array[1].Deserialize(ElectronJsonContext.Default.Rectangle); _click(trayClickEventArgs, bounds); }); BridgeConnector.Socket.Emit("register-tray-click", GetHashCode()); } _click += value; } remove { _click -= value; if (_click == null) { BridgeConnector.Socket.Off("tray-click" + GetHashCode()); } } } private event Action _click; /// /// macOS, Windows: Emitted when the tray icon is right clicked. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnRightClick { add { if (_rightClick == null) { BridgeConnector.Socket.On("tray-right-click" + GetHashCode(), (result) => { var array = result.EnumerateArray().ToArray(); var trayClickEventArgs = array[0].Deserialize(ElectronJsonContext.Default.TrayClickEventArgs); var bounds = array[1].Deserialize(ElectronJsonContext.Default.Rectangle); _rightClick(trayClickEventArgs, bounds); }); BridgeConnector.Socket.Emit("register-tray-right-click", GetHashCode()); } _rightClick += value; } remove { _rightClick -= value; if (_rightClick == null) { BridgeConnector.Socket.Off("tray-right-click" + GetHashCode()); } } } private event Action _rightClick; /// /// macOS, Windows: Emitted when the tray icon is double clicked. /// [SupportedOSPlatform("macOS")] [SupportedOSPlatform("Windows")] public event Action OnDoubleClick { add { if (_doubleClick == null) { BridgeConnector.Socket.On("tray-double-click" + GetHashCode(), (result) => { var array = result.EnumerateArray().ToArray(); var trayClickEventArgs = array[0].Deserialize(ElectronJsonContext.Default.TrayClickEventArgs); var bounds = array[1].Deserialize(ElectronJsonContext.Default.Rectangle); _doubleClick(trayClickEventArgs, bounds); }); BridgeConnector.Socket.Emit("register-tray-double-click", GetHashCode()); } _doubleClick += value; } remove { _doubleClick -= value; if (_doubleClick == null) { BridgeConnector.Socket.Off("tray-double-click" + GetHashCode()); } } } private event Action _doubleClick; /// /// Windows: Emitted when the tray balloon shows. /// [SupportedOSPlatform("Windows")] public event Action OnBalloonShow { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Windows: Emitted when the tray balloon is clicked. /// [SupportedOSPlatform("Windows")] public event Action OnBalloonClick { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } /// /// Windows: Emitted when the tray balloon is closed /// because of timeout or user manually closes it. /// [SupportedOSPlatform("Windows")] public event Action OnBalloonClosed { add => AddEvent(value, GetHashCode()); remove => RemoveEvent(value, GetHashCode()); } // TODO: Implement macOS Events private static Tray _tray; private static readonly object _syncRoot = new(); internal Tray() { } internal static Tray Instance { get { if (_tray == null) { lock (_syncRoot) { if (_tray == null) { _tray = new Tray(); } } } return _tray; } } /// /// Gets the menu items. /// /// /// The menu items. /// public IReadOnlyCollection MenuItems => _items.AsReadOnly(); private readonly List _items = new(); /// /// Shows the Traybar. /// /// The image. /// The menu item. public async Task Show(string image, MenuItem menuItem) { await this.Show(image, new MenuItem[] { menuItem }).ConfigureAwait(false); } /// /// Shows the Traybar. /// /// The image. /// The menu items. public async Task Show(string image, MenuItem[] menuItems) { menuItems.AddMenuItemsId(); await BridgeConnector.Socket.Emit("create-tray", image, menuItems).ConfigureAwait(false); _items.Clear(); _items.AddRange(menuItems); RegisterMenuItemClickedHandler(); } /// /// Sets the tray menu items. /// /// Calling this method updates the context menu with the specified items. Any previously /// set menu items will be replaced. /// An array of objects representing the menu items to display in the tray menu. /// Cannot be null. public async Task SetMenuItems(MenuItem[] menuItems) { menuItems.AddMenuItemsId(); await BridgeConnector.Socket.Emit("set-contextMenu", new object[] { menuItems }).ConfigureAwait(false); _items.Clear(); _items.AddRange(menuItems); RegisterMenuItemClickedHandler(); } private void RegisterMenuItemClickedHandler() { BridgeConnector.Socket.Off("trayMenuItemClicked"); BridgeConnector.Socket.On("trayMenuItemClicked", (id) => { MenuItem menuItem = _items.GetMenuItem(id); menuItem?.Click?.Invoke(); }); } /// /// Shows the Traybar (empty). /// /// The image. public async Task Show(string image) { await BridgeConnector.Socket.Emit("create-tray", image).ConfigureAwait(false); } /// /// Destroys the tray icon immediately. /// public async Task Destroy() { await BridgeConnector.Socket.Emit("tray-destroy").ConfigureAwait(false); _items.Clear(); } /// /// Sets the image associated with this tray icon. /// /// public async Task SetImage(string image) { await BridgeConnector.Socket.Emit("tray-setImage", image).ConfigureAwait(false); } /// /// Sets the image associated with this tray icon when pressed on macOS. /// /// [SupportedOSPlatform("macOS")] public async Task SetPressedImage(string image) { await BridgeConnector.Socket.Emit("tray-setPressedImage", image).ConfigureAwait(false); } /// /// Sets the hover text for this tray icon. /// /// public async Task SetToolTip(string toolTip) { await BridgeConnector.Socket.Emit("tray-setToolTip", toolTip).ConfigureAwait(false); } /// /// macOS: Sets the title displayed aside of the tray icon in the status bar. /// /// [SupportedOSPlatform("macOS")] public async Task SetTitle(string title) { await BridgeConnector.Socket.Emit("tray-setTitle", title).ConfigureAwait(false); } /// /// Windows: Displays a tray balloon. /// /// [SupportedOSPlatform("Windows")] public async Task DisplayBalloon(DisplayBalloonOptions options) { await BridgeConnector.Socket.Emit("tray-displayBalloon", options).ConfigureAwait(false); } /// /// Whether the tray icon is destroyed. /// /// public async Task IsDestroyedAsync() { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("tray-isDestroyedCompleted", tcs.SetResult); await BridgeConnector.Socket.Emit("tray-isDestroyed").ConfigureAwait(false); return await tcs.Task.ConfigureAwait(false); } private const string ModuleName = "tray"; /// /// Subscribe to an unmapped event on the module. /// /// The event name /// The handler public void On(string eventName, Action action) => Events.Instance.On(ModuleName, eventName, action); /// /// Subscribe to an unmapped event on the module. /// /// The event name /// The handler public async Task On(string eventName, Action action) => await Events.Instance.On(ModuleName, eventName, action).ConfigureAwait(false); /// /// Subscribe to an unmapped event on the module once. /// /// The event name /// The handler public void Once(string eventName, Action action) => Events.Instance.Once(ModuleName, eventName, action); /// /// Subscribe to an unmapped event on the module once. /// /// The event name /// The handler public async Task Once(string eventName, Action action) => await Events.Instance.Once(ModuleName, eventName, action).ConfigureAwait(false); } } ================================================ FILE: src/ElectronNET.API/API/WebContents.cs ================================================ using System; using System.Threading.Tasks; using ElectronNET.API.Entities; using ElectronNET.Common; // ReSharper disable InconsistentNaming namespace ElectronNET.API; /// /// Render and control web pages. /// public class WebContents : ApiBase { protected override SocketTaskEventNameTypes SocketTaskEventNameType => SocketTaskEventNameTypes.DashesLowerFirst; protected override SocketTaskMessageNameTypes SocketTaskMessageNameType => SocketTaskMessageNameTypes.DashesLowerFirst; protected override SocketEventNameTypes SocketEventNameType => SocketEventNameTypes.CamelCase; /// /// Gets the identifier. /// /// /// The identifier. /// public override int Id { get; protected set; } /// /// Manage browser sessions, cookies, cache, proxy settings, etc. /// public Session Session { get; internal set; } /// /// Emitted when the renderer process crashes or is killed. /// public event Action OnCrashed { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the navigation is done, i.e. the spinner of the tab has /// stopped spinning, and the onload event was dispatched. /// public event Action OnDidFinishLoad { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when any frame (including main) starts navigating. /// public event Action OnDidStartNavigation { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when a main frame navigation is done. /// This event is not emitted for in-page navigations, such as clicking anchor links or updating the window.location.hash. Use did-navigate-in-page event for this purpose. /// public event Action OnDidNavigate { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when a server side redirect occurs during navigation. For example a 302 redirect. /// This event will be emitted after OnDidStartNavigation and always before the OnDidRedirectNavigation event for the same navigation. /// public event Action OnWillRedirect { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted after a server side redirect occurs during navigation. For example a 302 redirect. /// public event Action OnDidRedirectNavigation { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// This event is like OnDidFinishLoad but emitted when the load failed. /// public event Action OnDidFailLoad { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when an input event is sent to the WebContents. /// public event Action InputEvent { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } /// /// Emitted when the document in the top-level frame is loaded. /// public event Action OnDomReady { add => AddEvent(value, Id); remove => RemoveEvent(value, Id); } internal WebContents(int id) { Id = id; Session = new Session(id); } /// /// Opens the devtools. /// public void OpenDevTools() { BridgeConnector.Socket.Emit("webContents-openDevTools", Id); } /// /// Opens the devtools. /// /// public void OpenDevTools(OpenDevToolsOptions openDevToolsOptions) { BridgeConnector.Socket.Emit("webContents-openDevTools", Id, openDevToolsOptions); } /// /// Toggles the devtools. /// public void ToggleDevTools() { BridgeConnector.Socket.Emit("webContents-toggleDevTools", Id); } /// /// Closes the devtools. /// public void CloseDevTools() { BridgeConnector.Socket.Emit("webContents-closeDevTools", Id); } /// /// Returns boolean - Whether the devtools is opened. /// /// public bool IsDevToolsOpened() { return Task.Run(() => InvokeAsync()).Result; } /// /// Returns boolean - Whether the devtools view is focused. /// /// public bool IsDevToolsFocused() { return Task.Run(() => InvokeAsync()).Result; } /// /// Get system printers. /// /// printers public Task GetPrintersAsync() => this.InvokeAsyncWithTimeout(8.seconds()); /// /// Prints window's web page. /// /// /// success public Task PrintAsync(PrintOptions options) => this.InvokeAsync(options); /// /// Prints window's web page. /// /// success public Task PrintAsync() => this.InvokeAsync(string.Empty); /// /// Prints window's web page as PDF with Chromium's preview printing custom /// settings.The landscape will be ignored if @page CSS at-rule is used in the web page. /// By default, an empty options will be regarded as: Use page-break-before: always; /// CSS style to force to print to a new page. /// /// /// /// success public Task PrintToPDFAsync(string path, PrintToPDFOptions options = null) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-printToPDF-completed", tcs.SetResult); if (options == null) { BridgeConnector.Socket.Emit("webContents-printToPDF", Id, "", path); } else { BridgeConnector.Socket.Emit("webContents-printToPDF", Id, options, path); } return tcs.Task; } /// /// Evaluates script code in page. /// /// The code to execute. /// if set to true simulate a user gesture. /// The result of the executed code. /// /// /// In the browser window some HTML APIs like `requestFullScreen` can only be /// invoked by a gesture from the user. Setting `userGesture` to `true` will remove /// this limitation. /// /// /// Code execution will be suspended until web page stop loading. /// /// public Task ExecuteJavaScriptAsync(string code, bool userGesture = false) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-executeJavaScript-completed", tcs.SetResult); BridgeConnector.Socket.Emit("webContents-executeJavaScript", Id, code, userGesture); return tcs.Task; } /// /// Is used to get the Url of the loaded page. /// It's usefull if a web-server redirects you and you need to know where it redirects. For instance, It's useful in case of Implicit Authorization. /// /// URL of the loaded page public Task GetUrl() { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-getUrl" + Id, tcs.SetResult); BridgeConnector.Socket.Emit("webContents-getUrl", Id); return tcs.Task; } /// /// The async method will resolve when the page has finished loading, /// and rejects if the page fails to load. /// /// A noop rejection handler is already attached, which avoids unhandled rejection /// errors. /// /// Loads the `url` in the window. The `url` must contain the protocol prefix, e.g. /// the `http://` or `file://`. If the load should bypass http cache then use the /// `pragma` header to achieve it. /// /// public Task LoadURLAsync(string url) { return LoadURLAsync(url, new LoadURLOptions()); } /// /// The async method will resolve when the page has finished loading, /// and rejects if the page fails to load. /// /// A noop rejection handler is already attached, which avoids unhandled rejection /// errors. /// /// Loads the `url` in the window. The `url` must contain the protocol prefix, e.g. /// the `http://` or `file://`. If the load should bypass http cache then use the /// `pragma` header to achieve it. /// /// /// public Task LoadURLAsync(string url, LoadURLOptions options) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-loadURL-complete" + Id, () => { BridgeConnector.Socket.Off("webContents-loadURL-error" + Id); tcs.SetResult(); }); BridgeConnector.Socket.Once("webContents-loadURL-error" + Id, (error) => { tcs.SetException(new InvalidOperationException(error)); }); BridgeConnector.Socket.Emit("webContents-loadURL", Id, url, options); return tcs.Task; } /// /// Inserts CSS into the web page. /// See: https://www.electronjs.org/docs/api/web-contents#contentsinsertcsscss-options /// Works for both BrowserWindows and BrowserViews. /// /// Whether the webContents belong to a BrowserWindow or not (the other option is a BrowserView) /// Absolute path to the CSS file location public void InsertCSS(bool isBrowserWindow, string path) { BridgeConnector.Socket.Emit("webContents-insertCSS", Id, isBrowserWindow, path); } /// /// Returns number - The current zoom factor. /// /// public Task GetZoomFactorAsync() => InvokeAsync(); /// /// Changes the zoom factor to the specified factor. /// Zoom factor is zoom percent divided by 100, so 300% = 3.0. /// The factor must be greater than 0.0. /// /// public void SetZoomFactor(double factor) { BridgeConnector.Socket.Emit("webContents-setZoomFactor", Id, factor); } /// /// Returns number - The current zoom level. /// /// public Task GetZoomLevelAsync() => InvokeAsync(); /// /// Changes the zoom level to the specified level. /// The original size is 0 and each increment above or below represents zooming 20% larger or smaller to default limits of 300% and 50% of original size, respectively. /// /// public void SetZoomLevel(int level) { BridgeConnector.Socket.Emit("webContents-setZoomLevel", Id, level); } /// /// Sets the maximum and minimum pinch-to-zoom level. /// /// /// public Task SetVisualZoomLevelLimitsAsync(int minimumLevel, int maximumLevel) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("webContents-setVisualZoomLevelLimits-completed", tcs.SetResult); BridgeConnector.Socket.Emit("webContents-setVisualZoomLevelLimits", Id, minimumLevel, maximumLevel); return tcs.Task; } /// /// Returns boolean - Whether this page has been muted. /// /// public Task IsAudioMutedAsync() => InvokeAsync(); /// /// Returns boolean - Whether audio is currently playing. /// /// public Task IsCurrentlyAudibleAsync() => InvokeAsync(); /// /// Mute the audio on the current web page. /// /// public void SetAudioMuted(bool muted) { BridgeConnector.Socket.Emit("webContents-setAudioMuted", Id, muted); } /// /// Returns string - The user agent for this web page. /// /// public Task GetUserAgentAsync() => InvokeAsyncWithTimeout(3.seconds()); /// /// Overrides the user agent for this web page. /// /// public void SetUserAgent(string userAgent) { BridgeConnector.Socket.Emit("webContents-setUserAgent", Id, userAgent); } } ================================================ FILE: src/ElectronNET.API/API/WebRequest.cs ================================================ using ElectronNET.API.Serialization; using System; using System.Text.Json; namespace ElectronNET.API.Entities { public class OnBeforeRequestDetails { public int Id { get; set; } public string Url { get; set; } public string Method { get; set; } public int? WebContentsId { get; set; } // Ensure all necessary properties are included as per Electron documentation } public class WebRequestFilter { public string[] Urls { get; set; } } public class WebRequest { public int Id { get; private set; } internal WebRequest(int id) { Id = id; } private event Action> _onBeforeRequest; public void OnBeforeRequest(WebRequestFilter filter, Action> listener) { if (_onBeforeRequest == null) { BridgeConnector.Socket.On($"webContents-session-webRequest-onBeforeRequest{Id}", (args) => { //// var details0 = args[0].Deserialize(ElectronNET.ElectronJson.Options); var details = args.Deserialize(ElectronJson.Options); var callback = (Action)((response) => { BridgeConnector.Socket.Emit($"webContents-session-webRequest-onBeforeRequest-response{Id}", response); }); _onBeforeRequest?.Invoke(details, callback); }); BridgeConnector.Socket.Emit("register-webContents-session-webRequest-onBeforeRequest", Id, filter); } _onBeforeRequest += listener; } public void RemoveListener(Action> listener) { _onBeforeRequest -= listener; if (_onBeforeRequest == null) { BridgeConnector.Socket.Off($"webContents-session-webRequest-onBeforeRequest{Id}"); } } } } ================================================ FILE: src/ElectronNET.API/API/WindowManager.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System; using System.Collections.Generic; using System.Linq; using System.Runtime.InteropServices; using System.Text.Json; using System.Threading.Tasks; namespace ElectronNET.API { /// /// /// public sealed class WindowManager { private static WindowManager _windowManager; private static readonly object SyncRoot = new(); internal WindowManager() { } internal static WindowManager Instance { get { if (_windowManager == null) { lock (SyncRoot) { if (_windowManager == null) { _windowManager = new WindowManager(); } } } return _windowManager; } } /// /// Quit when all windows are closed. (Default is true) /// /// /// true if [quit window all closed]; otherwise, false. /// public bool IsQuitOnWindowAllClosed { get => _isQuitOnWindowAllClosed; set { BridgeConnector.Socket.Emit("quit-app-window-all-closed", value); _isQuitOnWindowAllClosed = value; } } private bool _isQuitOnWindowAllClosed = true; /// /// Gets the browser windows. /// /// /// The browser windows. /// public IReadOnlyCollection BrowserWindows => _browserWindows.AsReadOnly(); private readonly List _browserWindows = new(); /// /// Gets the browser views. /// /// /// The browser view. /// public IReadOnlyCollection BrowserViews => _browserViews.AsReadOnly(); private readonly List _browserViews = new(); /// /// Creates the window asynchronous. /// /// The load URL. /// public async Task CreateWindowAsync(string loadUrl = "http://localhost") { return await this.CreateWindowAsync(new BrowserWindowOptions(), loadUrl).ConfigureAwait(false); } /// /// Creates the window asynchronous. /// /// The options. /// The load URL. /// public async Task CreateWindowAsync(BrowserWindowOptions options, string loadUrl = "http://localhost") { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("BrowserWindowCreated", (id) => { var browserWindow = new BrowserWindow(id); _browserWindows.Add(browserWindow); tcs.SetResult(browserWindow); }); BridgeConnector.Socket.Once("BrowserWindowClosed", (ids) => { for (int index = 0; index < _browserWindows.Count; index++) { if (!ids.Contains(_browserWindows[index].Id)) { _browserWindows.RemoveAt(index); } } }); if (loadUrl.Equals("http://localhost", StringComparison.OrdinalIgnoreCase) && ElectronNetRuntime.AspNetWebPort.HasValue) { loadUrl = $"{loadUrl}:{ElectronNetRuntime.AspNetWebPort}"; } // Workaround Windows 10 / Electron Bug // https://github.com/electron/electron/issues/4045 if (IsWindows10()) { options.Width += 14; options.Height += 7; } if (!options.X.HasValue && !options.Y.HasValue) { await BridgeConnector.Socket.Emit("createBrowserWindow", options, loadUrl).ConfigureAwait(false); } else { // Workaround Windows 10 / Electron Bug // https://github.com/electron/electron/issues/4045 if (IsWindows10()) { options.X -= 7; } await BridgeConnector.Socket.Emit("createBrowserWindow", options, loadUrl).ConfigureAwait(false); } return await tcs.Task.ConfigureAwait(false); } private bool IsWindows10() { return RuntimeInformation.OSDescription.Contains("Windows 10"); } /// /// A BrowserView can be used to embed additional web content into a BrowserWindow. /// It is like a child window, except that it is positioned relative to its owning window. /// It is meant to be an alternative to the webview tag. /// /// public Task CreateBrowserViewAsync() { return CreateBrowserViewAsync(new BrowserViewConstructorOptions()); } /// /// A BrowserView can be used to embed additional web content into a BrowserWindow. /// It is like a child window, except that it is positioned relative to its owning window. /// It is meant to be an alternative to the webview tag. /// /// /// public async Task CreateBrowserViewAsync(BrowserViewConstructorOptions options) { var tcs = new TaskCompletionSource(); BridgeConnector.Socket.Once("BrowserViewCreated", (id) => { BrowserView browserView = new(id); _browserViews.Add(browserView); tcs.SetResult(browserView); }); await BridgeConnector.Socket.Emit("createBrowserView", options).ConfigureAwait(false); return await tcs.Task.ConfigureAwait(false); } } } ================================================ FILE: src/ElectronNET.API/API/web-request.md ================================================ ## Class: WebRequest > Intercept and modify the contents of a request at various stages of its lifetime. Process: [Main](../glossary.md#main-process)
_This class is not exported from the `'electron'` module. It is only available as a return value of other methods in the Electron API._ Instances of the `WebRequest` class are accessed by using the `webRequest` property of a `Session`. The methods of `WebRequest` accept an optional `filter` and a `listener`. The `listener` will be called with `listener(details)` when the API's event has happened. The `details` object describes the request. ⚠️ Only the last attached `listener` will be used. Passing `null` as `listener` will unsubscribe from the event. The `filter` object has a `urls` property which is an Array of URL patterns that will be used to filter out the requests that do not match the URL patterns. If the `filter` is omitted then all requests will be matched. For certain events the `listener` is passed with a `callback`, which should be called with a `response` object when `listener` has done its work. An example of adding `User-Agent` header for requests: ```js const { session } = require('electron') // Modify the user agent for all requests to the following urls. const filter = { urls: ['https://*.github.com/*', '*://electron.github.io/*'] } session.defaultSession.webRequest.onBeforeSendHeaders(filter, (details, callback) => { details.requestHeaders['User-Agent'] = 'MyAgent' callback({ requestHeaders: details.requestHeaders }) }) ``` ### Instance Methods The following methods are available on instances of `WebRequest`: #### `webRequest.onBeforeRequest([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `uploadData` [UploadData[]](structures/upload-data.md) * `callback` Function * `response` Object * `cancel` boolean (optional) * `redirectURL` string (optional) - The original request is prevented from being sent or completed and is instead redirected to the given URL. The `listener` will be called with `listener(details, callback)` when a request is about to occur. The `uploadData` is an array of `UploadData` objects. The `callback` has to be called with an `response` object. Some examples of valid `urls`: ```js 'http://foo:1234/' 'http://foo.com/' 'http://foo:1234/bar' '*://*/*' '*://example.com/*' '*://example.com/foo/*' 'http://*.foo:1234/' 'file://foo:1234/bar' 'http://foo:*/' '*://www.foo.com/' ``` #### `webRequest.onBeforeSendHeaders([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `uploadData` [UploadData[]](structures/upload-data.md) (optional) * `requestHeaders` Record * `callback` Function * `beforeSendResponse` Object * `cancel` boolean (optional) * `requestHeaders` Record (optional) - When provided, request will be made with these headers. The `listener` will be called with `listener(details, callback)` before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any http data is sent. The `callback` has to be called with a `response` object. #### `webRequest.onSendHeaders([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `requestHeaders` Record The `listener` will be called with `listener(details)` just before a request is going to be sent to the server, modifications of previous `onBeforeSendHeaders` response are visible by the time this listener is fired. #### `webRequest.onHeadersReceived([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `statusLine` string * `statusCode` Integer * `responseHeaders` Record (optional) * `callback` Function * `headersReceivedResponse` Object * `cancel` boolean (optional) * `responseHeaders` Record (optional) - When provided, the server is assumed to have responded with these headers. * `statusLine` string (optional) - Should be provided when overriding `responseHeaders` to change header status otherwise original response header's status will be used. The `listener` will be called with `listener(details, callback)` when HTTP response headers of a request have been received. The `callback` has to be called with a `response` object. #### `webRequest.onResponseStarted([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `responseHeaders` Record (optional) * `fromCache` boolean - Indicates whether the response was fetched from disk cache. * `statusCode` Integer * `statusLine` string The `listener` will be called with `listener(details)` when first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available. #### `webRequest.onBeforeRedirect([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `redirectURL` string * `statusCode` Integer * `statusLine` string * `ip` string (optional) - The server IP address that the request was actually sent to. * `fromCache` boolean * `responseHeaders` Record (optional) The `listener` will be called with `listener(details)` when a server initiated redirect is about to occur. #### `webRequest.onCompleted([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `responseHeaders` Record (optional) * `fromCache` boolean * `statusCode` Integer * `statusLine` string * `error` string The `listener` will be called with `listener(details)` when a request is completed. #### `webRequest.onErrorOccurred([filter, ]listener)` * `filter` [WebRequestFilter](structures/web-request-filter.md) (optional) * `listener` Function | null * `details` Object * `id` Integer * `url` string * `method` string * `webContentsId` Integer (optional) * `webContents` WebContents (optional) * `frame` WebFrameMain (optional) * `resourceType` string - Can be `mainFrame`, `subFrame`, `stylesheet`, `script`, `image`, `font`, `object`, `xhr`, `ping`, `cspReport`, `media`, `webSocket` or `other`. * `referrer` string * `timestamp` Double * `fromCache` boolean * `error` string - The error description. The `listener` will be called with `listener(details)` when an error occurs. ================================================ FILE: src/ElectronNET.API/Bridge/BridgeConnector.cs ================================================ #pragma warning disable IDE0130 // Namespace does not match folder structure // ReSharper disable once CheckNamespace namespace ElectronNET.API { internal static class BridgeConnector { public static SocketIoFacade Socket { get { return ElectronNetRuntime.GetSocket(); } } } } ================================================ FILE: src/ElectronNET.API/Bridge/Events.cs ================================================ #pragma warning disable IDE0130 // Namespace does not match folder structure // ReSharper disable once CheckNamespace namespace ElectronNET.API { using System; using System.Globalization; using System.Threading.Tasks; /// /// Generic Event Consumers for Electron Modules /// internal class Events { private static Events _events; private static readonly object SyncRoot = new(); private readonly TextInfo _textInfo = new CultureInfo("en-US", false).TextInfo; private Events() { } public static Events Instance { get { if (_events == null) { lock (SyncRoot) { if (_events == null) { _events = new Events(); } } } return _events; } } /// /// Subscribe to an unmapped electron event. /// /// The name of the module, e.g. app, dock, etc... /// The name of the event /// The event handler public async Task On(string moduleName, string eventName, Action action) { var listener = $"{moduleName}{_textInfo.ToTitleCase(eventName)}Completed"; var subscriber = $"register-{moduleName}-on-event"; BridgeConnector.Socket.On(listener, action); await BridgeConnector.Socket.Emit(subscriber, eventName, listener).ConfigureAwait(false); } /// /// Subscribe to an unmapped electron event. /// /// The name of the module, e.g. app, dock, etc... /// The name of the event /// The event handler public async Task On(string moduleName, string eventName, Action action) { var listener = $"{moduleName}{_textInfo.ToTitleCase(eventName)}Completed"; var subscriber = $"register-{moduleName}-on-event"; BridgeConnector.Socket.On(listener, action); await BridgeConnector.Socket.Emit(subscriber, eventName, listener).ConfigureAwait(false); } /// Subscribe to an unmapped electron event. /// The name of the module, e.g. app, dock, etc... /// The name of the event /// The action. public async Task Once(string moduleName, string eventName, Action action) { var listener = $"{moduleName}{_textInfo.ToTitleCase(eventName)}Completed"; var subscriber = $"register-{moduleName}-once-event"; BridgeConnector.Socket.Once(listener, action); await BridgeConnector.Socket.Emit(subscriber, eventName, listener).ConfigureAwait(false); } /// /// Subscribe to an unmapped electron event. /// /// The name of the module, e.g. app, dock, etc... /// The name of the event /// The event handler public async Task Once(string moduleName, string eventName, Action action) { var listener = $"{moduleName}{_textInfo.ToTitleCase(eventName)}Completed"; var subscriber = $"register-{moduleName}-once-event"; BridgeConnector.Socket.Once(listener, action); await BridgeConnector.Socket.Emit(subscriber, eventName, listener).ConfigureAwait(false); } } } ================================================ FILE: src/ElectronNET.API/Bridge/SocketIOFacade.cs ================================================ #pragma warning disable IDE0130 // Namespace does not match folder structure // ReSharper disable once CheckNamespace namespace ElectronNET.API; using System; using System.Threading.Tasks; using ElectronNET.API.Serialization; using SocketIO.Serializer.SystemTextJson; using SocketIO = SocketIOClient.SocketIO; internal class SocketIoFacade : IDisposable { private readonly SocketIO _socket; private readonly object _lockObj = new object(); private bool _isDisposed; public SocketIoFacade(string uri) { _socket = new SocketIO(uri); _socket.Serializer = new SystemTextJsonSerializer(ElectronJson.Options); // Use default System.Text.Json serializer from SocketIOClient. // Outgoing args are normalized to camelCase via SerializeArg in Emit. } public event EventHandler BridgeDisconnected; public event EventHandler BridgeConnected; public void Connect() { this.CheckDisposed(); _socket.OnError += (sender, e) => { Console.WriteLine($"BridgeConnector Error: {sender} {e}"); }; _socket.OnConnected += (_, _) => { Console.WriteLine("BridgeConnector connected!"); this.BridgeConnected?.Invoke(this, EventArgs.Empty); }; _socket.OnDisconnected += (_, _) => { Console.WriteLine("BridgeConnector disconnected!"); this.BridgeDisconnected?.Invoke(this, EventArgs.Empty); }; _socket.ConnectAsync().GetAwaiter().GetResult(); } public void On(string eventName, Action action) { this.CheckDisposed(); lock (_lockObj) { _socket.On(eventName, _ => { Task.Run(action); }); } } public void On(string eventName, Action action) { this.CheckDisposed(); lock (_lockObj) { _socket.On(eventName, response => { var value = response.GetValue(); Task.Run(() => action(value)); }); } } public void Once(string eventName, Action action) { this.CheckDisposed(); lock (_lockObj) { _socket.On(eventName, _ => { this.Off(eventName); Task.Run(action); }); } } public void Once(string eventName, Action action) { this.CheckDisposed(); lock (_lockObj) { _socket.On(eventName, (socketIoResponse) => { this.Off(eventName); Task.Run(() => action(socketIoResponse.GetValue())); }); } } public void Off(string eventName) { if (_isDisposed) { return; } lock (_lockObj) { _socket.Off(eventName); } } public async Task Emit(string eventName, params object[] args) { if (!_isDisposed) { await _socket.EmitAsync(eventName, args).ConfigureAwait(false); } } /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. public void Dispose() { Dispose(true); GC.SuppressFinalize(this); } protected virtual void Dispose(bool disposing) { if (disposing) { _isDisposed = true; _socket.Dispose(); } } private void CheckDisposed() { if (this._isDisposed) { throw new ObjectDisposedException(nameof(SocketIoFacade)); } } } ================================================ FILE: src/ElectronNET.API/Common/Extensions.cs ================================================ using System.Globalization; using System.Text.RegularExpressions; using System; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Services; namespace ElectronNET.Common { internal static class Extensions { public static bool IsUnpackaged(this StartupMethod method) { switch (method) { case StartupMethod.UnpackedElectronFirst: case StartupMethod.UnpackedDotnetFirst: return true; default: return false; } } public static string LowerFirst(this string str) { if (string.IsNullOrWhiteSpace(str)) { return str; } if (str.Length == 1) { return str.ToLower(); } return char.ToLower(str[0]) + str.Substring(1); } public static string StripAsync(this string str) { if (string.IsNullOrWhiteSpace(str)) { return str; } var pos = str.LastIndexOf("Async", StringComparison.Ordinal); if (pos > 0) { return str.Substring(0, pos); } return str; } public static string StripOn(this string str) { if (string.IsNullOrWhiteSpace(str) || !str.StartsWith("On", StringComparison.Ordinal)) { return str; } return str.Substring(2); } public static string ToDashedEventName(this string str) { return string.Join("-", Regex.Split(str.StripOn(), "(? /// Class encapsulating out-of-process execution of console applications. /// /// /// Why this class? /// Probably everybody who has tried to use System.Diagnotics.Process cross-platform and with reading /// stderr and stdout will know that it is a pretty quirky API. /// The code below may look weird, even non-sensical, but it works 100% reliable with all .net frameworks /// and .net versions and on every platform where .net runs. This is just the innermost core, that's why /// there are many dead ends, but it has all the crucial parts. /// /// [SuppressMessage("ReSharper", "SuspiciousLockOverSynchronizationPrimitive")] public class ProcessRunner : IDisposable { private volatile Process process; private readonly StringBuilder stdOut = new StringBuilder(4 * 1024); private readonly StringBuilder stdErr = new StringBuilder(4 * 1024); private volatile ManualResetEvent stdOutEvent; private volatile ManualResetEvent stdErrEvent; private volatile Stopwatch stopwatch; /// Initializes a new instance of the class. /// A name identifying the process to execute. public ProcessRunner(string name) { this.Name = name; } public event EventHandler ProcessExited; public bool IsDisposed { get; private set; } private Process Process { get { return this.process; } } public bool IsRunning { get { var proc = this.process; if (proc != null) { try { return !proc.HasExited; } catch { return false; } } return false; } } /// Gets the name identifying the process. /// The name. public string Name { get; } public string CommandLine { get; private set; } public string ExecutableFileName { get; private set; } public string WorkingFolder { get; private set; } public bool RecordStandardOutput { get; set; } public bool RecordStandardError { get; set; } public string StandardOutput { get { lock (this.stdOut) { return this.stdOut.ToString(); } } } public string StandardError { get { lock (this.stdErr) { return this.stdErr.ToString(); } } } public int? LastExitCode { get; private set; } public bool Run(string exeFileName, string commandLineArgs, string workingDirectory) { this.CommandLine = commandLineArgs; this.WorkingFolder = workingDirectory; this.ExecutableFileName = exeFileName; var startInfo = new RunnerParams(exeFileName) { Arguments = commandLineArgs, UseShellExecute = false, RedirectStandardOutput = true, RedirectStandardError = true, RedirectStandardInput = true, ErrorDialog = false, CreateNoWindow = true, WorkingDirectory = workingDirectory }; return this.Run(startInfo); } protected bool Run(RunnerParams runnerParams) { if (this.IsDisposed) { throw new ObjectDisposedException(this.GetType().ToString()); } this.Close(); this.LastExitCode = null; lock (this.stdOut) { this.stdOut.Clear(); } lock (this.stdErr) { this.stdErr.Clear(); } this.stdOutEvent = new ManualResetEvent(false); this.stdErrEvent = new ManualResetEvent(false); if (!this.OnBeforeStartProcessCore(runnerParams)) { return false; } var startInfo = new ProcessStartInfo(runnerParams.FileName) { Arguments = runnerParams.Arguments, UseShellExecute = runnerParams.UseShellExecute, RedirectStandardOutput = runnerParams.RedirectStandardOutput, RedirectStandardError = runnerParams.RedirectStandardError, RedirectStandardInput = runnerParams.RedirectStandardInput, ErrorDialog = runnerParams.ErrorDialog, CreateNoWindow = runnerParams.CreateNoWindow, WorkingDirectory = runnerParams.WorkingDirectory }; foreach (var variableSetting in runnerParams.EnvironmentVariables) { startInfo.EnvironmentVariables[variableSetting.Key] = variableSetting.Value; } var proc = new Process { StartInfo = startInfo }; proc.EnableRaisingEvents = true; this.RegisterProcessEvents(proc); this.process = proc; try { this.process.Start(); this.stopwatch = Stopwatch.StartNew(); this.process.BeginOutputReadLine(); this.process.BeginErrorReadLine(); this.process.Refresh(); this.OnProcessStartedCore(); } catch (Exception ex) { this.OnProcessErrorCore(ex); this.Close(); throw; } return true; } public async Task WriteAsync(string data) { var proc = this.Process; if (proc != null && !proc.HasExited) { try { await proc.StandardInput.WriteAsync(data).ConfigureAwait(false); return true; } catch (Exception ex) { Console.WriteLine("{0}.{1}: {2}", ex, nameof(ProcessRunner), nameof(this.WriteAsync)); } } return false; } public bool WaitForExit() { var proc = this.process; if (proc == null) { return true; } try { // Wait for process and all I/O to finish. proc.WaitForExit(); return true; } catch (Exception ex) { this.OnProcessErrorCore(ex); return false; } } /// Sychronously waits for the specified amount and ends the process afterwards. /// The timeout ms. /// This method allows for a clean exit, since it also waits until the StandardOutput and /// StandardError pipes are processed to the end. /// true, if the process has exited gracefully; false otherwise. public bool WaitAndKill(int timeoutMs) { var proc = this.process; if (proc == null) { return true; } try { if (timeoutMs <= 0) { throw new ArgumentException("Argument must be greater then 0", nameof(timeoutMs)); } // Timed waiting. We need to wait for I/O ourselves. if (!proc.WaitForExit(timeoutMs)) { this.Cancel(); } // Wait for the I/O to finish. var waitMs = (int)(timeoutMs - this.stopwatch.ElapsedMilliseconds); waitMs = Math.Max(waitMs, 10); this.stdOutEvent?.WaitOne(waitMs); waitMs = (int)(timeoutMs - this.stopwatch.ElapsedMilliseconds); waitMs = Math.Max(waitMs, 10); return this.stdErrEvent?.WaitOne(waitMs) ?? false; } finally { // Cleanup. this.Cancel(); } } /// Asynchronously waits for the specified amount and ends the process afterwards. /// The timeout ms. /// Tjhis method performs the wait operation on a threadpool thread. /// Only recommended for short timeouts and situations where a synchronous call is undesired. /// true, if the process has exited gracefully; false otherwise. public Task WaitAndKillAsync(int timeoutMs) { var task = Task.Run(() => this.WaitAndKill(timeoutMs)); return task; } /// Waits asynchronously for the process to exit. /// The timeout ms. /// The cancellation token. /// true, if the process has exited, false if the process is still running. /// /// This methods waits until the process has existed or the /// has elapsed. /// This method does not end the process itself. /// public Task WaitForExitAsync(int timeoutMs, CancellationToken cancellationToken = default) { timeoutMs = Math.Max(0, timeoutMs); var timeoutSource = new CancellationTokenSource(timeoutMs); var linkedSource = CancellationTokenSource.CreateLinkedTokenSource(timeoutSource.Token, cancellationToken); return this.WaitForExitAsync(linkedSource.Token); } /// Waits asynchronously for the process to exit. /// The cancellation token. /// This methods waits until the process has existed or the /// has been triggered. /// This method does not end the process itself. /// true, if the process has exited, false if the process is still running. public async Task WaitForExitAsync(CancellationToken cancellationToken = default) { var proc = this.process; if (proc == null) { return true; } var tcs = new TaskCompletionSource(); // Use local function instead of a lambda to allow proper deregistration of the event void ProcessExited(object sender, EventArgs e) { tcs.TrySetResult(true); } try { proc.EnableRaisingEvents = true; proc.Exited += ProcessExited; if (proc.HasExited) { return true; } using (cancellationToken.Register(() => tcs.TrySetResult(false))) { return await tcs.Task.ConfigureAwait(false); } } finally { proc.Exited -= ProcessExited; } } public void Cancel() { var proc = this.process; if (proc != null) { try { // Invalidate cached data to requery. proc.Refresh(); // We need to do this in case of a non-UI proc // or one to be forced to cancel. if (!proc.HasExited) { // Cancel all pending IO ops. proc.CancelErrorRead(); proc.CancelOutputRead(); } if (!proc.HasExited) { proc.Kill(); } } catch { // Kill will throw when/if the process has already exited. } } var outEvent = this.stdOutEvent; this.stdOutEvent = null; if (outEvent != null) { lock (outEvent) { outEvent.Close(); outEvent.Dispose(); } } var errEvent = this.stdErrEvent; this.stdErrEvent = null; if (errEvent != null) { lock (errEvent) { errEvent.Close(); errEvent.Dispose(); } } } private void Close() { this.Cancel(); var proc = this.process; this.process = null; if (proc != null) { try { this.UnRegisterProcessEvents(proc); // Dispose in all cases. proc.Close(); proc.Dispose(); } catch (Exception ex) { this.OnProcessErrorCore(ex); } } } protected virtual void OnDispose() { } void IDisposable.Dispose() { this.IsDisposed = true; this.Close(); this.OnDispose(); } public override string ToString() { return string.Format("{0}: {1} {2}", this.GetType().Name, this.Name, this.process); } protected virtual bool OnBeforeStartProcessCore(RunnerParams processRunnerInfo) { return true; } protected virtual void OnProcessStartedCore() { } protected virtual void OnProcessErrorCore(Exception processException) { } protected virtual void OnProcessExitCore(int exitCode) { } private void RegisterProcessEvents(Process proc) { proc.ErrorDataReceived += this.Process_ErrorDataReceived; proc.OutputDataReceived += this.Process_OutputDataReceived; proc.Exited += this.Process_Exited; } private void UnRegisterProcessEvents(Process proc) { proc.ErrorDataReceived -= this.Process_ErrorDataReceived; proc.OutputDataReceived -= this.Process_OutputDataReceived; proc.Exited -= this.Process_Exited; } private void Process_Exited(object sender, EventArgs e) { this.WaitForExitAfterExited(); this.SetExitCode(); this.OnProcessExitCore(this.LastExitCode ?? -9998); this.ProcessExited?.Invoke(this, new EventArgs()); } private void WaitForExitAfterExited() { try { // This shouldn't throw here, but the mono process implementation doesn't always behave as it should. this.process.WaitForExit(); } catch (Exception ex) { Console.WriteLine("Error when calling WaitForExit after exited event has fired: {0}.{1}: {2}", ex, nameof(ProcessRunner), nameof(this.WaitForExitAfterExited)); } } private void SetExitCode() { int exitCode = -9999; try { if (this.Process != null) { exitCode = this.Process.ExitCode; } } catch { // Ignore error. } this.LastExitCode = exitCode; } private void Process_ErrorDataReceived(object sender, DataReceivedEventArgs e) { if (this.RecordStandardError) { lock (this.stdErr) { this.stdErr.AppendLine(e.Data); } } if (e.Data != null) { Console.WriteLine("|| " + e.Data); } else { var evt = this.stdErrEvent; if (evt != null) { lock (evt) { try { evt.Set(); } catch { // Ignore error. } } } } } private void Process_OutputDataReceived(object sender, DataReceivedEventArgs e) { if (this.RecordStandardOutput) { lock (this.stdOut) { this.stdOut.AppendLine(e.Data); } } if (e.Data != null) { Console.WriteLine("|| " + e.Data); } else { var evt = this.stdOutEvent; if (evt != null) { lock (evt) { try { evt.Set(); } catch { // Ignore error. } } } } } } } ================================================ FILE: src/ElectronNET.API/Common/RunnerParams.cs ================================================ namespace ElectronNET.Common { using System; using System.Collections.Generic; using System.ComponentModel; using System.Diagnostics; using System.Text; public sealed class RunnerParams { private string fileName; private string arguments; private string directory; private string userName; private string verb; private ProcessWindowStyle windowStyle; /// /// Default constructor. At least the /// property must be set before starting the process. /// public RunnerParams() { } /// /// Specifies the name of the application or document that is to be started. /// public RunnerParams(string fileName) { this.fileName = fileName; } /// /// Specifies the name of the application that is to be started, as well as a set /// of command line arguments to pass to the application. /// public RunnerParams(string fileName, string arguments) { this.fileName = fileName; this.arguments = arguments; } /// /// Specifies the set of command line arguments to use when starting the application. /// public string Arguments { get { return this.arguments ?? string.Empty; } set { this.arguments = value; } } public bool CreateNoWindow { get; set; } public Dictionary EnvironmentVariables { get; set; } = new Dictionary(); public bool RedirectStandardInput { get; set; } public bool RedirectStandardOutput { get; set; } public bool RedirectStandardError { get; set; } public Encoding StandardInputEncoding { get; set; } public Encoding StandardErrorEncoding { get; set; } public Encoding StandardOutputEncoding { get; set; } /// /// /// Returns or sets the application, document, or URL that is to be launched. /// /// public string FileName { get { return this.fileName ?? string.Empty; } set { this.fileName = value; } } /// /// Returns or sets the initial directory for the process that is started. /// Specify "" to if the default is desired. /// public string WorkingDirectory { get { return this.directory ?? string.Empty; } set { this.directory = value; } } public bool ErrorDialog { get; set; } public IntPtr ErrorDialogParentHandle { get; set; } public string UserName { get { return this.userName ?? string.Empty; } set { this.userName = value; } } [DefaultValue("")] public string Verb { get { return this.verb ?? string.Empty; } set { this.verb = value; } } [DefaultValue(ProcessWindowStyle.Normal)] public ProcessWindowStyle WindowStyle { get { return this.windowStyle; } set { if (!Enum.IsDefined(typeof(ProcessWindowStyle), value)) { throw new InvalidEnumArgumentException(nameof(value), (int)value, typeof(ProcessWindowStyle)); } this.windowStyle = value; } } public bool UseShellExecute { get; set; } } } ================================================ FILE: src/ElectronNET.API/Common/TimeSpanExtensions.cs ================================================ // // Copyright © Emby LLC. All rights reserved. // namespace ElectronNET.Common { using System; using System.Diagnostics.CodeAnalysis; /// /// The TimeSpanExtensions class. /// [SuppressMessage("StyleCop.CSharp.NamingRules", "SA1300:Element should begin with upper-case letter", Justification = "OK")] [SuppressMessage("StyleCop.CSharp.DocumentationRules", "SA1600:Elements should be documented", Justification = "OK")] [SuppressMessage("ReSharper", "StyleCop.SA1300", Justification = "OK")] [SuppressMessage("ReSharper", "InconsistentNaming", Justification = "OK")] internal static class TimeSpanExtensions { public static TimeSpan ms(this int value) { return TimeSpan.FromMilliseconds(value); } public static TimeSpan ms(this long value) { return TimeSpan.FromMilliseconds(value); } public static TimeSpan seconds(this int value) { return TimeSpan.FromSeconds(value); } public static TimeSpan minutes(this int value) { return TimeSpan.FromMinutes(value); } public static TimeSpan hours(this int value) { return TimeSpan.FromHours(value); } public static TimeSpan days(this int value) { return TimeSpan.FromDays(value); } public static TimeSpan ms(this double value) { return TimeSpan.FromMilliseconds(value); } public static TimeSpan seconds(this double value) { return TimeSpan.FromSeconds(value); } public static TimeSpan minutes(this double value) { return TimeSpan.FromMinutes(value); } public static TimeSpan hours(this double value) { return TimeSpan.FromHours(value); } public static TimeSpan days(this double value) { return TimeSpan.FromDays(value); } } } ================================================ FILE: src/ElectronNET.API/Converter/ModifierTypeListConverter.cs ================================================ namespace ElectronNET.Converter; using ElectronNET.API.Entities; using System; using System.Collections.Generic; using System.Text.Json; using System.Text.Json.Serialization; /// /// /// public class ModifierTypeListConverter : JsonConverter> { public override List Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.Null) { return null; } var list = new List(); if (reader.TokenType != JsonTokenType.StartArray) { throw new JsonException("Expected array for ModifierType list"); } while (reader.Read()) { if (reader.TokenType == JsonTokenType.EndArray) break; if (reader.TokenType != JsonTokenType.String) throw new JsonException("Expected string enum value"); var s = reader.GetString(); list.Add((ModifierType)Enum.Parse(typeof(ModifierType), s, ignoreCase: true)); } return list; } public override void Write(Utf8JsonWriter writer, List value, JsonSerializerOptions options) { writer.WriteStartArray(); foreach (var modifier in value) { writer.WriteStringValue(modifier.ToString().ToLowerInvariant()); } writer.WriteEndArray(); } } ================================================ FILE: src/ElectronNET.API/Converter/PageSizeConverter.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System; using System.Text.Json; using System.Text.Json.Serialization; namespace ElectronNET.Converter; public class PageSizeConverter : JsonConverter { public override PageSize Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.String) { return reader.GetString(); } else if (reader.TokenType == JsonTokenType.StartObject) { return JsonSerializer.Deserialize(ref reader, ElectronJson.Options); } else { throw new JsonException("Invalid value for PageSize. Expected string or an object."); } } public override void Write(Utf8JsonWriter writer, PageSize value, JsonSerializerOptions options) { if (value is null) { return; } var str = (string)value; if (str is not null) { writer.WriteStringValue(str); } else { JsonSerializer.Serialize(writer, value, ElectronJson.Options); } } } ================================================ FILE: src/ElectronNET.API/Converter/TitleBarOverlayConverter.cs ================================================ using ElectronNET.API.Entities; using ElectronNET.API.Serialization; using System; using System.Text.Json; using System.Text.Json.Serialization; namespace ElectronNET.Converter; public class TitleBarOverlayConverter : JsonConverter { public override TitleBarOverlay Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { if (reader.TokenType == JsonTokenType.True || reader.TokenType == JsonTokenType.False) { return (bool)reader.GetBoolean(); } else if (reader.TokenType == JsonTokenType.StartObject) { using var doc = JsonDocument.ParseValue(ref reader); return doc.RootElement.Deserialize(ElectronJson.Options); } else { throw new JsonException("Invalid value for TitleBarOverlay. Expected boolean or an object."); } } public override void Write(Utf8JsonWriter writer, TitleBarOverlay value, JsonSerializerOptions options) { if (value is null) { return; } var @bool = (bool?)value; if (@bool.HasValue) { writer.WriteBooleanValue(@bool.Value); } else { JsonSerializer.Serialize(writer, value, ElectronJson.Options); } } } ================================================ FILE: src/ElectronNET.API/ElectronNET.API.csproj ================================================  net6.0;net8.0;net10.0 ..\..\artifacts $(PackageNamePrefix).API $(PackageId) true True snupkg disable $(DescriptionFirstPart) This package contains the API to access the "native" electron API. ElectronNET 1701;1702;4014;CS4014;CA1416;CS1591 all runtime; build; native; contentfiles; analyzers ================================================ FILE: src/ElectronNET.API/ElectronNET.API.csproj.DotSettings ================================================  Library True ================================================ FILE: src/ElectronNET.API/ElectronNetRuntime.cs ================================================ namespace ElectronNET { using ElectronNET.API; using ElectronNET.Runtime; using ElectronNET.Runtime.Controllers; using ElectronNET.Runtime.Data; using System; using System.Collections.Immutable; using System.Threading.Tasks; public static class ElectronNetRuntime { internal static StartupManager StartupManager; internal const int DefaultSocketPort = 8000; internal const int DefaultWebPort = 8001; internal const string ElectronPortArgumentName = "electronPort"; internal const string ElectronPidArgumentName = "electronPID"; /// Initializes the class. static ElectronNetRuntime() { StartupManager = new StartupManager(); StartupManager.Initialize(); } public static string ElectronExtraArguments { get; set; } public static int? ElectronSocketPort { get; internal set; } public static int? AspNetWebPort { get; internal set; } public static StartupMethod StartupMethod { get; internal set; } public static DotnetAppType DotnetAppType { get; internal set; } public static string ElectronExecutable { get; internal set; } public static ImmutableList ProcessArguments { get; internal set; } public static BuildInfo BuildInfo { get; internal set; } public static IElectronNetRuntimeController RuntimeController => RuntimeControllerCore; // The below properties are non-public internal static RuntimeControllerBase RuntimeControllerCore { get; set; } internal static int? ElectronProcessId { get; set; } internal static Func OnAppReadyCallback { get; set; } internal static SocketIoFacade GetSocket() { return RuntimeControllerCore?.Socket; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Controllers/RuntimeControllerBase.cs ================================================ namespace ElectronNET.Runtime.Controllers { using ElectronNET.API; using ElectronNET.Runtime.Services; using ElectronNET.Runtime.Services.ElectronProcess; using ElectronNET.Runtime.Services.SocketBridge; using System.Threading.Tasks; internal abstract class RuntimeControllerBase : LifetimeServiceBase, IElectronNetRuntimeController { protected RuntimeControllerBase() { } internal abstract SocketIoFacade Socket { get; } internal abstract ElectronProcessBase ElectronProcess { get; } internal abstract SocketBridgeService SocketBridge { get; } protected override Task StartCore() { return Task.CompletedTask; } protected override Task StopCore() { return Task.CompletedTask; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Controllers/RuntimeControllerDotNetFirst.cs ================================================ namespace ElectronNET.Runtime.Controllers { using ElectronNET.API; using ElectronNET.Common; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Helpers; using ElectronNET.Runtime.Services.ElectronProcess; using ElectronNET.Runtime.Services.SocketBridge; using System; using System.Threading.Tasks; internal class RuntimeControllerDotNetFirst : RuntimeControllerBase { private ElectronProcessBase electronProcess; private SocketBridgeService socketBridge; private int? port; public RuntimeControllerDotNetFirst() { } internal override SocketIoFacade Socket { get { if (this.State == LifetimeState.Ready) { return this.socketBridge.Socket; } throw new Exception("Cannot access socket bridge. Runtime is not in 'Ready' state"); } } internal override ElectronProcessBase ElectronProcess => this.electronProcess; internal override SocketBridgeService SocketBridge => this.socketBridge; protected override Task StartCore() { var isUnPacked = ElectronNetRuntime.StartupMethod.IsUnpackaged(); var electronBinaryName = ElectronNetRuntime.ElectronExecutable; var args = string.Format("{0} {1}", ElectronNetRuntime.ElectronExtraArguments, Environment.CommandLine).Trim(); this.port = ElectronNetRuntime.ElectronSocketPort; if (!this.port.HasValue) { this.port = PortHelper.GetFreePort(ElectronNetRuntime.DefaultSocketPort); ElectronNetRuntime.ElectronSocketPort = this.port; } Console.Error.WriteLine("[StartCore]: isUnPacked: {0}", isUnPacked); Console.Error.WriteLine("[StartCore]: electronBinaryName: {0}", electronBinaryName); Console.Error.WriteLine("[StartCore]: args: {0}", args); this.electronProcess = new ElectronProcessActive(isUnPacked, electronBinaryName, args, this.port.Value); this.electronProcess.Ready += this.ElectronProcess_Ready; this.electronProcess.Stopped += this.ElectronProcess_Stopped; Console.Error.WriteLine("[StartCore]: Before Start"); return this.electronProcess.Start(); } private void ElectronProcess_Ready(object sender, EventArgs e) { this.TransitionState(LifetimeState.Started); this.socketBridge = new SocketBridgeService(this.port!.Value); this.socketBridge.Ready += this.SocketBridge_Ready; this.socketBridge.Stopped += this.SocketBridge_Stopped; this.socketBridge.Start(); } private void SocketBridge_Ready(object sender, EventArgs e) { this.TransitionState(LifetimeState.Ready); } private void SocketBridge_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void ElectronProcess_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void HandleStopped() { if (this.socketBridge != null && this.socketBridge.State != LifetimeState.Stopped) { this.socketBridge.Stop(); } else if (this.electronProcess != null && this.electronProcess.State != LifetimeState.Stopped) { this.electronProcess.Stop(); } else { this.TransitionState(LifetimeState.Stopped); } } protected override Task StopCore() { this.electronProcess.Stop(); return Task.CompletedTask; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Controllers/RuntimeControllerElectronFirst.cs ================================================ namespace ElectronNET.Runtime.Controllers { using ElectronNET.API; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Services.ElectronProcess; using ElectronNET.Runtime.Services.SocketBridge; using System; using System.Threading.Tasks; internal class RuntimeControllerElectronFirst : RuntimeControllerBase { private ElectronProcessBase electronProcess; private SocketBridgeService socketBridge; private int? port; public RuntimeControllerElectronFirst() { } internal override SocketIoFacade Socket { get { if (this.State == LifetimeState.Ready) { return this.socketBridge.Socket; } throw new Exception("Cannot access socket bridge. Runtime is not in 'Ready' state"); } } internal override ElectronProcessBase ElectronProcess => this.electronProcess; internal override SocketBridgeService SocketBridge => this.socketBridge; protected override Task StartCore() { this.port = ElectronNetRuntime.ElectronSocketPort; if (!this.port.HasValue) { throw new Exception("No port has been specified by Electron!"); } if (!ElectronNetRuntime.ElectronProcessId.HasValue) { throw new Exception("No electronPID has been specified by Electron!"); } this.TransitionState(LifetimeState.Starting); this.socketBridge = new SocketBridgeService(this.port!.Value); this.socketBridge.Ready += this.SocketBridge_Ready; this.socketBridge.Stopped += this.SocketBridge_Stopped; this.socketBridge.Start(); this.electronProcess = new ElectronProcessPassive(ElectronNetRuntime.ElectronProcessId.Value); this.electronProcess.Ready += this.ElectronProcess_Ready; this.electronProcess.Stopped += this.ElectronProcess_Stopped; this.electronProcess.Start(); return Task.CompletedTask; } private void ElectronProcess_Ready(object sender, EventArgs e) { } private void SocketBridge_Ready(object sender, EventArgs e) { this.TransitionState(LifetimeState.Ready); } private void SocketBridge_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void ElectronProcess_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void HandleStopped() { if (this.socketBridge.State != LifetimeState.Stopped) { this.socketBridge.Stop(); } else if (this.electronProcess.State != LifetimeState.Stopped) { this.electronProcess.Stop(); } else { this.TransitionState(LifetimeState.Stopped); } } protected override Task StopCore() { this.socketBridge.Stop(); return Task.CompletedTask; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Data/BuildInfo.cs ================================================ namespace ElectronNET.Runtime.Data { public class BuildInfo { public string ElectronExecutable { get; internal set; } public string ElectronVersion { get; internal set; } public string RuntimeIdentifier { get; internal set; } public bool ElectronSingleInstance { get; internal set; } public string Title { get; internal set; } public string Version { get; internal set; } public string BuildConfiguration { get; internal set; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Data/DotnetAppType.cs ================================================ namespace ElectronNET.Runtime.Data { public enum DotnetAppType { /// A plain DotNet cross-platform console app. ConsoleApp, /// ASP.NET Core cross-platform app. AspNetCoreApp, } } ================================================ FILE: src/ElectronNET.API/Runtime/Data/LifetimeState.cs ================================================ namespace ElectronNET.Runtime.Data { public enum LifetimeState { Uninitialized, Starting, Started, Ready, Stopping, Stopped, } } ================================================ FILE: src/ElectronNET.API/Runtime/Data/StartupMethod.cs ================================================ namespace ElectronNET.Runtime.Data { public enum StartupMethod { /// Packaged Electron app where Electron launches the DotNet app. /// /// This is the classic way of ElectrronNET startup. /// PackagedElectronFirst, /// Packaged Electron app where DotNet launches the Electron prozess. /// /// Provides better ways for managing the overall app lifecycle. /// On the command lines, this is "dotnetpacked" /// PackagedDotnetFirst, /// Unpackacked execution for debugging the Electron process and NodeJS. /// /// Similar to the legacy ElectronNET debugging but without packaging (=fast) and allows selection of /// the debug adapter. It's rarely useful, unless it's about debugging NodeJS. /// Note: 'Unpackaged' means that it's run directly from the compilation output folders (./bin/*). /// On the command lines, this is "unpackedelectron" /// UnpackedElectronFirst, /// Unpackacked execution for debugging the DotNet process. /// /// This is the new way of super-fast startup for debugging in-place with Hot Reload /// (edit and continue), even on WSL - all from within Visual Studio. /// Note: 'Unpackaged' means that it's run directly from the compilation output folders (./bin/*). /// On the command lines, this is "unpackeddotnet" /// UnpackedDotnetFirst, } } ================================================ FILE: src/ElectronNET.API/Runtime/Helpers/LaunchOrderDetector.cs ================================================ namespace ElectronNET.Runtime.Helpers { using System; using System.Collections.Generic; using System.Diagnostics; using System.Linq; internal class LaunchOrderDetector { public static bool CheckIsLaunchedByDotNet() { var tests = new List>(); tests.Add(CheckIsDotNetStartup1); tests.Add(CheckIsDotNetStartup2); tests.Add(CheckIsDotNetStartup3); int scoreDotNet = 0, scoreElectron = 0; foreach (var test in tests) { var res = test(); if (res == true) { scoreDotNet++; } if (res == false) { scoreElectron++; } } Console.WriteLine("Probe scored for launch origin: DotNet {0} vs. {1} Electron", scoreDotNet, scoreElectron); return scoreDotNet > scoreElectron; } private static bool? CheckIsDotNetStartup1() { var hasPortArg = ElectronNetRuntime.ProcessArguments.Any(e => e.Contains(ElectronNetRuntime.ElectronPortArgumentName, StringComparison.OrdinalIgnoreCase)); if (hasPortArg) { return false; } return true; } private static bool? CheckIsDotNetStartup2() { var hasPidArg = ElectronNetRuntime.ProcessArguments.Any(e => e.Contains(ElectronNetRuntime.ElectronPidArgumentName, StringComparison.OrdinalIgnoreCase)); if (hasPidArg) { return false; } return true; } private static bool? CheckIsDotNetStartup3() { if (Debugger.IsAttached) { return true; } return null; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Helpers/PortHelper.cs ================================================ namespace ElectronNET.Runtime.Helpers { using System.Linq; using System.Net.NetworkInformation; internal static class PortHelper { public static int GetFreePort(int? defaultPost) { var listeners = IPGlobalProperties.GetIPGlobalProperties().GetActiveTcpListeners().Select(e => e.Port).ToList(); int port = defaultPost ?? 8000; while (true) { if (!listeners.Contains(port)) { return port; } port += 2; } } } } ================================================ FILE: src/ElectronNET.API/Runtime/Helpers/UnpackagedDetector.cs ================================================ namespace ElectronNET.Runtime.Helpers { using System; using System.Collections.Generic; using System.Diagnostics; using System.IO; using System.Linq; internal class UnpackagedDetector { public static bool CheckIsUnpackaged() { var tests = new List>(); tests.Add(CheckUnpackaged1); // We let this one account twice tests.Add(CheckUnpackaged2); tests.Add(CheckUnpackaged2); tests.Add(CheckUnpackaged3); tests.Add(CheckUnpackaged4); int scoreUnpackaged = 0, scorePackaged = 0; foreach (var test in tests) { var res = test(); if (res == true) { scoreUnpackaged++; } if (res == false) { scorePackaged++; } } Console.WriteLine("Probe scored for package mode: Unpackaged {0} vs. {1} Packaged", scoreUnpackaged, scorePackaged); return scoreUnpackaged > scorePackaged; } private static bool? CheckUnpackaged1() { var cfg = ElectronNetRuntime.BuildInfo.BuildConfiguration; if (cfg != null) { if (cfg.Equals("Debug", StringComparison.OrdinalIgnoreCase)) { return true; } if (cfg.Equals("Release", StringComparison.OrdinalIgnoreCase)) { return false; } } return null; } private static bool? CheckUnpackaged2() { var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory); if (dir.Name == "bin" && dir.Parent?.Name == "resources") { return false; } if (dir.GetDirectories().Any(e => e.Name == ".electron")) { return true; } return null; } private static bool? CheckUnpackaged3() { if (Debugger.IsAttached) { return true; } return null; } private static bool? CheckUnpackaged4() { var isUnpackaged = ElectronNetRuntime.ProcessArguments.Any(e => e.Contains("unpacked", StringComparison.OrdinalIgnoreCase)); if (isUnpackaged) { return true; } var isPackaged = ElectronNetRuntime.ProcessArguments.Any(e => e.Contains("dotnetpacked", StringComparison.OrdinalIgnoreCase)); if (isPackaged) { return false; } return null; } } } ================================================ FILE: src/ElectronNET.API/Runtime/IElectronNetRuntimeController.cs ================================================ namespace ElectronNET.Runtime { using ElectronNET.Runtime.Data; using System; using System.Threading.Tasks; public interface IElectronNetRuntimeController { LifetimeState State { get; } Task WaitStartedTask { get; } Task WaitReadyTask { get; } Task WaitStoppingTask { get; } Task WaitStoppedTask { get; } event EventHandler Starting; event EventHandler Started; event EventHandler Ready; event EventHandler Stopping; event EventHandler Stopped; Task Start(); Task Stop(); } } ================================================ FILE: src/ElectronNET.API/Runtime/Services/ElectronProcess/ElectronProcessActive.cs ================================================ namespace ElectronNET.Runtime.Services.ElectronProcess { using System; using System.ComponentModel; using System.IO; using System.Linq; using System.Runtime.InteropServices; using System.Threading.Tasks; using ElectronNET.Common; using ElectronNET.Runtime.Data; /// /// Launches and manages the Electron app process. /// [Localizable(false)] internal class ElectronProcessActive : ElectronProcessBase { private readonly bool isUnpackaged; private readonly string electronBinaryName; private readonly string extraArguments; private readonly int socketPort; private ProcessRunner process; /// Initializes a new instance of the class. /// The is debug. /// Name of the electron. /// The extraArguments. /// The socket port. public ElectronProcessActive(bool isUnpackaged, string electronBinaryName, string extraArguments, int socketPort) { this.isUnpackaged = isUnpackaged; this.electronBinaryName = electronBinaryName; this.extraArguments = extraArguments; this.socketPort = socketPort; } protected override async Task StartCore() { var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory); string startCmd, args, workingDir; if (this.isUnpackaged) { this.CheckRuntimeIdentifier(); var electrondir = Path.Combine(dir.FullName, ".electron"); ProcessRunner chmodRunner = null; try { if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { var distFolder = Path.Combine(electrondir, "node_modules", "electron", "dist"); chmodRunner = new ProcessRunner("ElectronRunner-Chmod"); chmodRunner.Run("chmod", "-R +x " + distFolder, electrondir); await chmodRunner.WaitForExitAsync().ConfigureAwait(true); if (chmodRunner.LastExitCode != 0) { throw new Exception("Failed to set executable permissions on Electron dist folder."); } } } catch (Exception ex) { Console.Error.WriteLine("[StartCore]: Exception: " + chmodRunner?.StandardError); Console.Error.WriteLine("[StartCore]: Exception: " + chmodRunner?.StandardOutput); Console.Error.WriteLine("[StartCore]: Exception: " + ex); } startCmd = Path.Combine(electrondir, "node_modules", "electron", "dist", "electron"); if (RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { startCmd = Path.Combine(electrondir, "node_modules", "electron", "dist", "Electron.app", "Contents", "MacOS", "Electron"); } args = $"main.js -unpackeddotnet --trace-warnings -electronforcedport={this.socketPort:D} " + this.extraArguments; workingDir = electrondir; } else { dir = dir.Parent!.Parent!; startCmd = Path.Combine(dir.FullName, this.electronBinaryName); args = $"-dotnetpacked -electronforcedport={this.socketPort:D} " + this.extraArguments; workingDir = dir.FullName; } // We don't await this in order to let the state transition to "Starting" Task.Run(async () => await this.StartInternal(startCmd, args, workingDir).ConfigureAwait(false)); } private void CheckRuntimeIdentifier() { var buildInfoRid = ElectronNetRuntime.BuildInfo.RuntimeIdentifier; if (string.IsNullOrEmpty(buildInfoRid)) { return; } var osPart = buildInfoRid.Split('-').First(); var mismatch = false; switch (osPart) { case "win": if (!RuntimeInformation.IsOSPlatform(OSPlatform.Windows)) { mismatch = true; } break; case "linux": if (!RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) { mismatch = true; } break; case "osx": if (!RuntimeInformation.IsOSPlatform(OSPlatform.OSX)) { mismatch = true; } break; case "freebsd": if (!RuntimeInformation.IsOSPlatform(OSPlatform.FreeBSD)) { mismatch = true; } break; } if (mismatch) { throw new PlatformNotSupportedException($"This Electron.NET application was built for '{buildInfoRid}'. It cannot run on this platform."); } } protected override Task StopCore() { this.process.Cancel(); return Task.CompletedTask; } private async Task StartInternal(string startCmd, string args, string directoriy) { try { await Task.Delay(10.ms()).ConfigureAwait(false); Console.Error.WriteLine("[StartInternal]: startCmd: {0}", startCmd); Console.Error.WriteLine("[StartInternal]: args: {0}", args); this.process = new ProcessRunner("ElectronRunner"); this.process.ProcessExited += this.Process_Exited; this.process.Run(startCmd, args, directoriy); await Task.Delay(500.ms()).ConfigureAwait(false); Console.Error.WriteLine("[StartInternal]: after run:"); if (!this.process.IsRunning) { Console.Error.WriteLine("[StartInternal]: Process is not running: " + this.process.StandardError); Console.Error.WriteLine("[StartInternal]: Process is not running: " + this.process.StandardOutput); Task.Run(() => this.TransitionState(LifetimeState.Stopped)); throw new Exception("Failed to launch the Electron process."); } this.TransitionState(LifetimeState.Ready); } catch (Exception ex) { Console.Error.WriteLine("[StartInternal]: Exception: " + this.process?.StandardError); Console.Error.WriteLine("[StartInternal]: Exception: " + this.process?.StandardOutput); Console.Error.WriteLine("[StartInternal]: Exception: " + ex); throw; } } private void Process_Exited(object sender, EventArgs e) { this.TransitionState(LifetimeState.Stopped); } } } ================================================ FILE: src/ElectronNET.API/Runtime/Services/ElectronProcess/ElectronProcessBase.cs ================================================ namespace ElectronNET.Runtime.Services.ElectronProcess { using System.ComponentModel; /// /// Manages the Electron app process. /// [Localizable(false)] internal abstract class ElectronProcessBase : LifetimeServiceBase { protected ElectronProcessBase() { } } } ================================================ FILE: src/ElectronNET.API/Runtime/Services/ElectronProcess/ElectronProcessPassive.cs ================================================ namespace ElectronNET.Runtime.Services.ElectronProcess { using ElectronNET.Runtime.Data; using System; using System.ComponentModel; using System.Diagnostics; using System.Threading.Tasks; /// /// Launches and manages the Electron app process. /// [Localizable(false)] internal class ElectronProcessPassive : ElectronProcessBase { private readonly int pid; private Process process; /// Initializes a new instance of the class. /// public ElectronProcessPassive(int pid) { this.pid = pid; } protected override Task StartCore() { this.process = Process.GetProcessById(this.pid); if (this.process == null) { throw new ArgumentException($"Unable to find process with ID {this.pid}"); } this.process.Exited += this.Process_Exited1; Task.Run(() => this.TransitionState(LifetimeState.Ready)); return Task.CompletedTask; } private void Process_Exited1(object sender, EventArgs e) { this.TransitionState(LifetimeState.Stopped); } protected override Task StopCore() { // Not sure about this: ////this.process.Kill(true); return Task.CompletedTask; } } } ================================================ FILE: src/ElectronNET.API/Runtime/Services/LifetimeServiceBase.cs ================================================ namespace ElectronNET.Runtime.Services { using ElectronNET.Runtime.Data; using System; using System.Runtime.CompilerServices; using System.Threading.Tasks; public abstract class LifetimeServiceBase { private readonly TaskCompletionSource tcsStarted = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); private readonly TaskCompletionSource tcsReady = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); private readonly TaskCompletionSource tcsStopping = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); private readonly TaskCompletionSource tcsStopped = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); private LifetimeState state = LifetimeState.Uninitialized; protected LifetimeServiceBase() { } public event EventHandler Starting; public event EventHandler Started; public event EventHandler Ready; public event EventHandler Stopping; public event EventHandler Stopped; public LifetimeState State => this.state; public Task WaitStartedTask => this.tcsStarted.Task; public Task WaitReadyTask => this.tcsReady.Task; public Task WaitStoppingTask => this.tcsStopping.Task; public Task WaitStoppedTask => this.tcsStopped.Task; public virtual async Task Start() { this.ValidateMaxState(LifetimeState.Uninitialized); await this.StartCore().ConfigureAwait(false); this.TransitionState(LifetimeState.Starting); } public virtual async Task Stop() { this.ValidateMaxState(LifetimeState.Ready); await this.StopCore().ConfigureAwait(false); this.TransitionState(LifetimeState.Stopping); } protected virtual Task StopCore() { return Task.CompletedTask; } protected virtual Task StartCore() { return Task.CompletedTask; } private void ValidateMaxState(LifetimeState evalState, [CallerMemberName] string callerMemberName = null) { if (this.state > evalState) { throw new Exception($"Invalid state! Cannot execute {callerMemberName} in state {this.state}"); } } protected void TransitionState(LifetimeState newState) { if (newState == this.state) { return; } if (newState < this.state) { throw new Exception($"Invalid state transition from {this.state} to {newState}: " + this.GetType().Name); } var oldState = this.state; this.state = newState; switch (this.state) { case LifetimeState.Starting: this.Starting?.Invoke(this, EventArgs.Empty); break; case LifetimeState.Started: this.Started?.Invoke(this, EventArgs.Empty); break; case LifetimeState.Ready: this.Ready?.Invoke(this, EventArgs.Empty); break; case LifetimeState.Stopping: this.Stopping?.Invoke(this, EventArgs.Empty); break; case LifetimeState.Stopped: this.Stopped?.Invoke(this, EventArgs.Empty); break; default: throw new ArgumentOutOfRangeException(); } if (oldState < LifetimeState.Started && newState >= LifetimeState.Started) { this.tcsStarted.TrySetResult(); } if (oldState < LifetimeState.Ready && newState >= LifetimeState.Ready) { this.tcsReady.TrySetResult(); } if (oldState < LifetimeState.Stopping && newState >= LifetimeState.Stopping) { this.tcsStopping.TrySetResult(); } if (oldState < LifetimeState.Stopped && newState >= LifetimeState.Stopped) { this.tcsStopped.TrySetResult(); } } } } ================================================ FILE: src/ElectronNET.API/Runtime/Services/SocketBridge/SocketBridgeService.cs ================================================ namespace ElectronNET.Runtime.Services.SocketBridge { using ElectronNET.API; using ElectronNET.Runtime.Data; using System; using System.Threading.Tasks; internal class SocketBridgeService : LifetimeServiceBase { private readonly int socketPort; private readonly string socketUrl; private SocketIoFacade socket; public SocketBridgeService(int socketPort) { this.socketPort = socketPort; this.socketUrl = $"http://localhost:{this.socketPort}"; } public int SocketPort => this.socketPort; internal SocketIoFacade Socket => this.socket; protected override Task StartCore() { this.socket = new SocketIoFacade(this.socketUrl); this.socket.BridgeConnected += this.Socket_BridgeConnected; this.socket.BridgeDisconnected += this.Socket_BridgeDisconnected; Task.Run(this.Connect); return Task.CompletedTask; } protected override Task StopCore() { this.socket.Dispose(); return Task.CompletedTask; } private void Connect() { this.socket.Connect(); if (this.State < LifetimeState.Started) { this.TransitionState(LifetimeState.Started); } } private void Socket_BridgeDisconnected(object sender, EventArgs e) { this.TransitionState(LifetimeState.Stopped); } private void Socket_BridgeConnected(object sender, EventArgs e) { this.TransitionState(LifetimeState.Ready); } } } ================================================ FILE: src/ElectronNET.API/Runtime/StartupManager.cs ================================================ namespace ElectronNET.Runtime { using System; using System.Collections.Immutable; using System.Globalization; using System.Linq; using System.Reflection; using ElectronNET.Runtime.Controllers; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Helpers; internal class StartupManager { public void Initialize() { try { ElectronNetRuntime.BuildInfo = this.GatherBuildInfo(); } catch (Exception ex) { Console.WriteLine(ex); } this.CollectProcessData(); this.SetElectronExecutable(); ElectronNetRuntime.StartupMethod = this.DetectAppTypeAndStartup(); Console.WriteLine((string)("Evaluated StartupMethod: " + ElectronNetRuntime.StartupMethod)); if (ElectronNetRuntime.DotnetAppType != DotnetAppType.AspNetCoreApp) { ElectronNetRuntime.RuntimeControllerCore = this.CreateRuntimeController(); } } private RuntimeControllerBase CreateRuntimeController() { switch (ElectronNetRuntime.StartupMethod) { case StartupMethod.PackagedDotnetFirst: case StartupMethod.UnpackedDotnetFirst: return new RuntimeControllerDotNetFirst(); case StartupMethod.PackagedElectronFirst: case StartupMethod.UnpackedElectronFirst: return new RuntimeControllerElectronFirst(); default: throw new ArgumentOutOfRangeException(); } } private StartupMethod DetectAppTypeAndStartup() { var isLaunchedByDotNet = LaunchOrderDetector.CheckIsLaunchedByDotNet(); var isUnPackaged = UnpackagedDetector.CheckIsUnpackaged(); if (isLaunchedByDotNet) { if (isUnPackaged) { return StartupMethod.UnpackedDotnetFirst; } return StartupMethod.PackagedDotnetFirst; } else { if (isUnPackaged) { return StartupMethod.UnpackedElectronFirst; } return StartupMethod.PackagedElectronFirst; } } private void CollectProcessData() { var argsList = Environment.GetCommandLineArgs().ToImmutableList(); ElectronNetRuntime.ProcessArguments = argsList; var portArg = argsList.FirstOrDefault(e => e.Contains(ElectronNetRuntime.ElectronPortArgumentName, StringComparison.OrdinalIgnoreCase)); if (portArg != null) { var parts = portArg.Split('=', StringSplitOptions.TrimEntries); if (parts.Length > 1 && int.TryParse(parts[1], NumberStyles.Integer, NumberFormatInfo.InvariantInfo, out var result)) { ElectronNetRuntime.ElectronSocketPort = result; Console.WriteLine("Use Electron Port: " + result); } } var pidArg = argsList.FirstOrDefault(e => e.Contains(ElectronNetRuntime.ElectronPidArgumentName, StringComparison.OrdinalIgnoreCase)); if (pidArg != null) { var parts = pidArg.Split('=', StringSplitOptions.TrimEntries); if (parts.Length > 1 && int.TryParse(parts[1], NumberStyles.Integer, NumberFormatInfo.InvariantInfo, out var result)) { ElectronNetRuntime.ElectronProcessId = result; Console.WriteLine("Electron Process ID: " + result); } } } private void SetElectronExecutable() { string executable = ElectronNetRuntime.BuildInfo.ElectronExecutable; if (string.IsNullOrEmpty(executable)) { throw new Exception("AssemblyMetadataAttribute 'ElectronExecutable' could not be found!"); } if (Environment.OSVersion.Platform == PlatformID.Win32NT) { executable += ".exe"; } ElectronNetRuntime.ElectronExecutable = executable; } private BuildInfo GatherBuildInfo() { var buildInfo = new BuildInfo(); var electronAssembly = Assembly.GetEntryAssembly(); if (electronAssembly == null) { Console.WriteLine("GatherBuildInfo: Early exit"); return buildInfo; } if (electronAssembly.GetName().Name == "testhost" || electronAssembly.GetName().Name == "ReSharperTestRunner") { Console.WriteLine("GatherBuildInfo: Detected testhost"); electronAssembly = AppDomain.CurrentDomain.GetData("ElectronTestAssembly") as Assembly ?? electronAssembly; } else { Console.WriteLine("GatherBuildInfo: No testhost detected: " + electronAssembly.GetName().Name); } var attributes = electronAssembly.GetCustomAttributes().ToList(); if (attributes.Count > 0) { buildInfo.ElectronExecutable = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.ElectronExecutable))?.Value; buildInfo.ElectronVersion = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.ElectronVersion))?.Value; buildInfo.RuntimeIdentifier = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.RuntimeIdentifier))?.Value; buildInfo.Title = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.Title))?.Value; buildInfo.Version = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.Version))?.Value; buildInfo.BuildConfiguration = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.BuildConfiguration))?.Value; var isAspNet = attributes.FirstOrDefault(e => e.Key == "IsAspNet")?.Value; var isSingleInstance = attributes.FirstOrDefault(e => e.Key == nameof(buildInfo.ElectronSingleInstance))?.Value; var httpPort = attributes.FirstOrDefault(e => e.Key == "AspNetHttpPort")?.Value; if (isAspNet?.Length > 0 && bool.TryParse(isAspNet, out var isAspNetActive) && isAspNetActive) { ElectronNetRuntime.DotnetAppType = DotnetAppType.AspNetCoreApp; } if (bool.TryParse(isSingleInstance, out var parsedBool)) { buildInfo.ElectronSingleInstance = parsedBool; } if (httpPort?.Length > 0 && int.TryParse(httpPort, out var port)) { ElectronNetRuntime.AspNetWebPort = port; } } return buildInfo; } } } ================================================ FILE: src/ElectronNET.API/Serialization/ElectronJson.cs ================================================ using ElectronNET.API.Entities; using System.Text.Json; using System.Text.Json.Serialization; namespace ElectronNET.API.Serialization { internal static class ElectronJson { public static readonly JsonSerializerOptions Options = new JsonSerializerOptions { PropertyNamingPolicy = JsonNamingPolicy.CamelCase, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull, WriteIndented = false, Converters = { new JsonStringEnumConverter(JsonNamingPolicy.CamelCase) } }; } // Use source generation where feasible for hot paths [JsonSourceGenerationOptions(WriteIndented = false, PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase, DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] [JsonSerializable(typeof(TrayClickEventArgs))] [JsonSerializable(typeof(Rectangle))] [JsonSerializable(typeof(Display))] [JsonSerializable(typeof(UpdateInfo))] [JsonSerializable(typeof(ProgressInfo))] [JsonSerializable(typeof(UpdateCheckResult))] [JsonSerializable(typeof(SemVer))] internal partial class ElectronJsonContext : JsonSerializerContext { } } ================================================ FILE: src/ElectronNET.API/Serialization/JsonToBoxedPrimitivesConverter.cs ================================================ namespace ElectronNET.Serialization { using System; using System.Collections.Generic; using System.Text.Json; using System.Text.Json.Serialization; public sealed class JsonToBoxedPrimitivesConverter : JsonConverter { public override object Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) { return ReadValue(ref reader); } private static object ReadValue(ref Utf8JsonReader r) { switch (r.TokenType) { case JsonTokenType.StartObject: var obj = new Dictionary(); while (r.Read()) { if (r.TokenType == JsonTokenType.EndObject) { return obj; } if (r.TokenType != JsonTokenType.PropertyName) { throw new JsonException("Expected property name."); } string name = r.GetString()!; if (!r.Read()) { throw new JsonException("Unexpected end while reading property value."); } obj[name] = ReadValue(ref r); } throw new JsonException("Unexpected end while reading object."); case JsonTokenType.StartArray: var list = new List(); while (r.Read()) { if (r.TokenType == JsonTokenType.EndArray) { return list; } list.Add(ReadValue(ref r)); } throw new JsonException("Unexpected end while reading array."); case JsonTokenType.True: return true; case JsonTokenType.False: return false; case JsonTokenType.Null: return null; case JsonTokenType.Number: if (r.TryGetInt32(out int i)) { return i; } if (r.TryGetInt64(out long l)) { return l; } if (r.TryGetDouble(out double d)) { return d; } return r.GetDecimal(); case JsonTokenType.String: string s = r.GetString()!; if (DateTimeOffset.TryParse(s, out var dto)) { return dto; } if (DateTime.TryParse(s, out var dt)) { return dt; } if (TimeSpan.TryParse(s, out var ts)) { return ts; } if (Guid.TryParse(s, out var g)) { return g; } return s; default: throw new JsonException($"Unsupported token {r.TokenType}"); } } public override void Write(Utf8JsonWriter writer, object value, JsonSerializerOptions options) { if (value is null) { writer.WriteNullValue(); return; } writer.WriteStartObject(); writer.WriteEndObject(); } } } ================================================ FILE: src/ElectronNET.AspNet/API/ServiceCollectionExtensions.cs ================================================ namespace ElectronNET.API { using Microsoft.Extensions.DependencyInjection; /// /// /// public static class ServiceCollectionExtensions { /// /// Adds the Members to the Service Collection /// public static IServiceCollection AddElectron(this IServiceCollection services) => services // adding in this manner to ensure late binding. .AddSingleton(_ => IpcMain.Instance) .AddSingleton(_ => App.Instance) .AddSingleton(_ => AutoUpdater.Instance) .AddSingleton(_ => WindowManager.Instance) .AddSingleton(_ => Menu.Instance) .AddSingleton(_ => Dialog.Instance) .AddSingleton(_ => Notification.Instance) .AddSingleton(_ => Tray.Instance) .AddSingleton(_ => GlobalShortcut.Instance) .AddSingleton(_ => Shell.Instance) .AddSingleton(_ => Screen.Instance) .AddSingleton(_ => Clipboard.Instance) .AddSingleton(_ => HostHook.Instance) .AddSingleton(_ => PowerMonitor.Instance) .AddSingleton(_ => NativeTheme.Instance) .AddSingleton(_ => Dock.Instance); } } ================================================ FILE: src/ElectronNET.AspNet/API/WebApplicationBuilderExtensions.cs ================================================ namespace ElectronNET.API { using System; using System.Threading.Tasks; using Microsoft.AspNetCore.Builder; /// /// Provides extension methods for to enable Electron.NET /// integration in ASP.NET Core applications (including Razor Pages) using the minimal hosting model. /// /// /// Call this extension during host configuration (for example, in Program.cs) to wire up Electron /// with any command-line arguments and an optional application-ready callback. /// public static class WebApplicationBuilderExtensions { /// /// Adds Electron.NET support to the current ASP.NET Core application and registers an application-ready callback. /// /// The to extend. /// The command-line arguments passed to the process, forwarded to Electron. /// /// An asynchronous callback invoked when the Electron app is ready. Use this to create windows or perform initialization. /// /// /// The same instance to enable fluent configuration. /// /// /// /// var builder = WebApplication.CreateBuilder(args) /// .UseElectron(args, async () => /// { /// // Create the main browser window or perform other startup tasks. /// }); /// /// var app = builder.Build(); /// app.MapRazorPages(); /// app.Run(); /// /// public static WebApplicationBuilder UseElectron(this WebApplicationBuilder builder, string[] args, Func onAppReadyCallback) { builder.WebHost.UseElectron(args, onAppReadyCallback); return builder; } } } ================================================ FILE: src/ElectronNET.AspNet/API/WebHostBuilderExtensions.cs ================================================ namespace ElectronNET.API { using System; using System.IO; using System.Threading.Tasks; using ElectronNET.AspNet; using ElectronNET.AspNet.Runtime; using ElectronNET.Runtime; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Helpers; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.DependencyInjection; /// /// Provides extension methods for to enable Electron.NET /// integration in ASP.NET Core applications (including Razor Pages) using the WebHost-based hosting model. /// /// /// Call this extension during web host configuration (for example, inside ConfigureWebHostDefaults in Program.cs) /// to wire up Electron with any command-line arguments and an optional application-ready callback. /// public static class WebHostBuilderExtensions { /// /// Adds Electron.NET support to the current ASP.NET Core web host and registers an application-ready callback. /// /// The to extend. /// The command-line arguments passed to the process. /// /// An asynchronous callback invoked when the Electron app is ready. Use this to create windows or perform initialization. /// /// /// The same instance to enable fluent configuration. /// /// /// /// using Microsoft.AspNetCore.Hosting; /// using Microsoft.Extensions.Hosting; /// using ElectronNET.API; /// /// public class Program /// { /// public static void Main(string[] args) /// { /// Host.CreateDefaultBuilder(args) /// .ConfigureWebHostDefaults(webBuilder => /// { /// webBuilder.UseStartup<Startup>(); /// webBuilder.UseElectron(args, async () => /// { /// // Create the main browser window or perform other startup tasks. /// }); /// }) /// .Build() /// .Run(); /// } /// } /// /// public static IWebHostBuilder UseElectron(this IWebHostBuilder builder, string[] args, Func onAppReadyCallback) { ElectronNetRuntime.OnAppReadyCallback = onAppReadyCallback; // no matter how this is set - let's unset to prevent Electron not starting as expected // e.g., VS Code sets this env variable, but this will cause `require("electron")` to not // work as expected, see issue #952 Environment.SetEnvironmentVariable("ELECTRON_RUN_AS_NODE", null); var webPort = PortHelper.GetFreePort(ElectronNetRuntime.AspNetWebPort ?? ElectronNetRuntime.DefaultWebPort); ElectronNetRuntime.AspNetWebPort = webPort; // check for the content folder if its exists in base director otherwise no need to include // It was used before because we are publishing the project which copies everything to bin folder and contentroot wwwroot was folder there. // now we have implemented the live reload if app is run using /watch then we need to use the default project path. if (Directory.Exists($"{AppDomain.CurrentDomain.BaseDirectory}\\wwwroot")) { builder = builder.UseContentRoot(AppDomain.CurrentDomain.BaseDirectory) .UseUrls("http://localhost:" + webPort); } else { builder = builder.UseUrls("http://localhost:" + webPort); } builder = builder.ConfigureServices(services => { services.AddTransient(); services.AddSingleton(); switch (ElectronNetRuntime.StartupMethod) { case StartupMethod.PackagedElectronFirst: case StartupMethod.UnpackedElectronFirst: services.AddSingleton(); break; case StartupMethod.PackagedDotnetFirst: case StartupMethod.UnpackedDotnetFirst: services.AddSingleton(); break; default: throw new ArgumentOutOfRangeException(); } }); return builder; } } } ================================================ FILE: src/ElectronNET.AspNet/ElectronNET.AspNet.csproj ================================================  net6.0;net8.0;net10.0 ..\..\artifacts $(PackageNamePrefix).AspNet $(PackageId) $(DescriptionFirstPart) This package contains the ASP.Net Core integration. true True snupkg disable ElectronNET 1701;1702;4014;CS4014;CA1416;CS1591 1701;1702;4014;CS4014;CA1416;CS1591 1701;1702;4014;CS4014;CA1416;CS1591 1701;1702;4014;CS4014;CA1416;CS1591 1701;1702;4014;CS4014;CA1416;CS1591 1701;1702;4014;CS4014;CA1416;CS1591 all runtime; build; native; contentfiles; analyzers ================================================ FILE: src/ElectronNET.AspNet/Runtime/Controllers/RuntimeControllerAspNetBase.cs ================================================ namespace ElectronNET.AspNet.Runtime { using System; using System.Threading.Tasks; using ElectronNET.API; using ElectronNET.Common; using ElectronNET.Runtime.Controllers; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Services.SocketBridge; internal abstract class RuntimeControllerAspNetBase : RuntimeControllerBase { private readonly AspNetLifetimeAdapter aspNetLifetimeAdapter; private SocketBridgeService socketBridge; protected RuntimeControllerAspNetBase(AspNetLifetimeAdapter aspNetLifetimeAdapter) { this.aspNetLifetimeAdapter = aspNetLifetimeAdapter; this.aspNetLifetimeAdapter.Ready += this.AspNetLifetimeAdapter_Ready; this.aspNetLifetimeAdapter.Stopping += this.AspNetLifetimeAdapter_Stopping; this.aspNetLifetimeAdapter.Stopped += this.AspNetLifetimeAdapter_Stopped; ElectronNetRuntime.RuntimeControllerCore = this; } internal override SocketBridgeService SocketBridge => this.socketBridge; internal override SocketIoFacade Socket { get { if (this.State == LifetimeState.Ready) { return this.socketBridge.Socket; } throw new Exception("Cannot access socket bridge. Runtime is not in 'Ready' state"); } } protected void CreateSocketBridge(int port) { this.socketBridge = new SocketBridgeService(port); this.socketBridge.Ready += this.SocketBridge_Ready; this.socketBridge.Stopped += this.SocketBridge_Stopped; this.socketBridge.Start(); } protected void HandleReady() { if (this.SocketBridge.IsReady() && this.ElectronProcess.IsReady() && this.aspNetLifetimeAdapter.IsReady()) { this.TransitionState(LifetimeState.Ready); Task.Run(this.RunReadyCallback); } } protected void HandleStopped() { this.TransitionState(LifetimeState.Stopping); if (this.SocketBridge.IsNotStopped()) { this.SocketBridge.Stop(); } if (this.ElectronProcess.IsNotStopped()) { this.ElectronProcess.Stop(); } if (this.aspNetLifetimeAdapter.IsNotStopped()) { this.aspNetLifetimeAdapter.Stop(); } if ((this.SocketBridge.IsNullOrStopped()) && (this.ElectronProcess.IsNullOrStopped()) && (this.aspNetLifetimeAdapter.IsNullOrStopped())) { this.TransitionState(LifetimeState.Stopped); } } protected abstract override Task StopCore(); private void SocketBridge_Ready(object sender, EventArgs e) { this.HandleReady(); } private void AspNetLifetimeAdapter_Ready(object sender, EventArgs e) { this.HandleReady(); } private void SocketBridge_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void AspNetLifetimeAdapter_Stopped(object sender, EventArgs e) { this.HandleStopped(); } private void AspNetLifetimeAdapter_Stopping(object sender, EventArgs e) { } private async Task RunReadyCallback() { if (ElectronNetRuntime.OnAppReadyCallback == null) { Console.WriteLine("Warning: Non OnReadyCallback provided in UseElectron() setup."); return; } try { await ElectronNetRuntime.OnAppReadyCallback().ConfigureAwait(false); } catch (Exception ex) { Console.WriteLine("Exception while executing OnAppReadyCallback. Stopping...\n" + ex); this.Stop(); } } } } ================================================ FILE: src/ElectronNET.AspNet/Runtime/Controllers/RuntimeControllerAspNetDotnetFirst.cs ================================================ namespace ElectronNET.AspNet.Runtime { using System; using System.Threading.Tasks; using ElectronNET.Common; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Helpers; using ElectronNET.Runtime.Services.ElectronProcess; internal class RuntimeControllerAspNetDotnetFirst : RuntimeControllerAspNetBase { private ElectronProcessBase electronProcess; private int? port; public RuntimeControllerAspNetDotnetFirst(AspNetLifetimeAdapter aspNetLifetimeAdapter) : base(aspNetLifetimeAdapter) { } internal override ElectronProcessBase ElectronProcess => this.electronProcess; protected override Task StartCore() { var isUnPacked = ElectronNetRuntime.StartupMethod.IsUnpackaged(); var electronBinaryName = ElectronNetRuntime.ElectronExecutable; var args = Environment.CommandLine; this.port = ElectronNetRuntime.ElectronSocketPort; if (!this.port.HasValue) { this.port = PortHelper.GetFreePort(ElectronNetRuntime.DefaultSocketPort); ElectronNetRuntime.ElectronSocketPort = this.port; } this.electronProcess = new ElectronProcessActive(isUnPacked, electronBinaryName, args, this.port.Value); this.electronProcess.Ready += this.ElectronProcess_Ready; this.electronProcess.Stopped += this.ElectronProcess_Stopped; return this.electronProcess.Start(); } protected override Task StopCore() { this.electronProcess.Stop(); return Task.CompletedTask; } private void ElectronProcess_Ready(object sender, EventArgs e) { this.TransitionState(LifetimeState.Started); this.CreateSocketBridge(this.port!.Value); } private void ElectronProcess_Stopped(object sender, EventArgs e) { this.HandleStopped(); } } } ================================================ FILE: src/ElectronNET.AspNet/Runtime/Controllers/RuntimeControllerAspNetElectronFirst.cs ================================================ namespace ElectronNET.AspNet.Runtime { using System; using System.Threading.Tasks; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Services.ElectronProcess; internal class RuntimeControllerAspNetElectronFirst : RuntimeControllerAspNetBase { private ElectronProcessBase electronProcess; private int? port; public RuntimeControllerAspNetElectronFirst(AspNetLifetimeAdapter aspNetLifetimeAdapter) : base(aspNetLifetimeAdapter) { } internal override ElectronProcessBase ElectronProcess => this.electronProcess; protected override Task StartCore() { this.port = ElectronNetRuntime.ElectronSocketPort; if (!this.port.HasValue) { throw new Exception("No port has been specified by Electron!"); } if (!ElectronNetRuntime.ElectronProcessId.HasValue) { throw new Exception("No electronPID has been specified by Electron!"); } this.CreateSocketBridge(this.port!.Value); this.electronProcess = new ElectronProcessPassive(ElectronNetRuntime.ElectronProcessId.Value); this.electronProcess.Stopped += this.ElectronProcess_Stopped; this.electronProcess.Start(); Task.Run(() => this.TransitionState(LifetimeState.Started)); return Task.CompletedTask; } protected override Task StopCore() { this.electronProcess.Stop(); return Task.CompletedTask; } private void ElectronProcess_Stopped(object sender, EventArgs e) { this.HandleStopped(); } } } ================================================ FILE: src/ElectronNET.AspNet/Runtime/Helpers/ServerReadyStartupFilter.cs ================================================ namespace ElectronNET.AspNet { using System; using ElectronNET.AspNet.Runtime; using ElectronNET.Runtime; using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.DependencyInjection; internal sealed class ServerReadyStartupFilter : IStartupFilter { /// /// Extends the provided and returns an of the same type. /// /// The Configure method to extend. /// A modified . public Action Configure(Action next) { return app => { _ = app.ApplicationServices.GetService(); var runtimeController = app.ApplicationServices.GetService(); runtimeController.Start(); next(app); }; } } } ================================================ FILE: src/ElectronNET.AspNet/Runtime/Services/AspNetLifetimeAdapter.cs ================================================ namespace ElectronNET.AspNet.Runtime { using System.Threading.Tasks; using ElectronNET.Runtime.Data; using ElectronNET.Runtime.Services; using Microsoft.Extensions.Hosting; internal class AspNetLifetimeAdapter : LifetimeServiceBase { private readonly IHostApplicationLifetime lifetimeService; public AspNetLifetimeAdapter(IHostApplicationLifetime lifetimeService) { this.lifetimeService = lifetimeService; this.lifetimeService.ApplicationStarted.Register(() => this.TransitionState(LifetimeState.Ready)); this.lifetimeService.ApplicationStopping.Register(() => this.TransitionState(LifetimeState.Stopping)); this.lifetimeService.ApplicationStopped.Register(() => this.TransitionState(LifetimeState.Stopped)); } protected override Task StopCore() { this.lifetimeService.StopApplication(); return Task.CompletedTask; } } } ================================================ FILE: src/ElectronNET.Build/ElectronNET.Build.csproj ================================================  netstandard2.0 False <_DllTargetPath>$(MSBuildThisFileDirectory)\..\ElectronNET\build ================================================ FILE: src/ElectronNET.Build/ElectronNET.Build.csproj.DotSettings ================================================  Library ================================================ FILE: src/ElectronNET.Build/PrintItemMetadata.cs ================================================ namespace ElectronNET.Build { using System; using Microsoft.Build.Framework; using Microsoft.Build.Utilities; public class DumpItemMetadataTask : Task { // The item group whose metadata will be dumped. [Required] public ITaskItem[] Items { get; set; } public override bool Execute() { try { foreach (var item in this.Items) { // Log the item's identity (the Include attribute) this.Log.LogMessage(MessageImportance.High, $"Item: {item.ItemSpec}"); // Iterate through each metadata field of the item. foreach (string metadataName in item.MetadataNames) { string metadataValue = item.GetMetadata(metadataName); this.Log.LogMessage(MessageImportance.High, $" {metadataName}: {metadataValue}"); } } return true; } catch (Exception ex) { this.Log.LogErrorFromException(ex); return false; } } } } ================================================ FILE: src/ElectronNET.Build/RemoveEnvironmentVariables.cs ================================================ namespace ElectronNET.Build { using System; using System.Collections.Generic; using System.IO; using System.Linq; using System.Text.RegularExpressions; using Microsoft.Build.Framework; using Microsoft.Build.Utilities; public class RemoveEnvironmentVariables : Task { [Required] public string Variables { get; set; } public override bool Execute() { try { if (string.IsNullOrEmpty(this.Variables)) { this.Log.LogError("The Variables property is not set"); return false; } var items = this.Variables.Split(new[] { ':', ';', ',' }, StringSplitOptions.RemoveEmptyEntries); foreach (var item in items) { Environment.SetEnvironmentVariable(item.Trim(), null); this.Log.LogMessage("Unset environment variable: {0}", item); } return true; } catch (Exception ex) { this.Log.LogErrorFromException(ex); return false; } } } } ================================================ FILE: src/ElectronNET.Build/ReplaceMsBuildPropertiesTask.cs ================================================ namespace ElectronNET.Build { using System; using System.Collections.Generic; using System.IO; using System.Text.RegularExpressions; using Microsoft.Build.Framework; using Microsoft.Build.Utilities; public class ReplaceTemplateTask : Task { [Required] public string TemplateFile { get; set; } [Required] public string OutputFile { get; set; } [Required] public ITaskItem[] TemplateProperties { get; set; } public override bool Execute() { try { ////var props = this.BuildEngine9.GetGlobalProperties(); ////var globalProperties = props //// .Select(e => string.Format("{0}: {1}", e.Key, e.Value)); ////this.Log.LogMessage(MessageImportance.High, "Global Properties: \r\n" + string.Join(Environment.NewLine, globalProperties)); ////var envVariables = Environment.GetEnvironmentVariables(); ////var envList = new List(); ////foreach (var v in envVariables.Keys) ////{ //// envList.Add(string.Format("{0}: {1}", v, envVariables[v])); ////} ////this.Log.LogMessage(MessageImportance.High, "Environment Variables: \r\n" + string.Join(Environment.NewLine, envList)); string content = File.ReadAllText(this.TemplateFile); // Build a dictionary of property names and values. var dict = new Dictionary(StringComparer.OrdinalIgnoreCase); foreach (var item in this.TemplateProperties) { dict[item.ItemSpec] = item.GetMetadata("Value").Replace("\\", "\\\\"); } // Regex pattern to match placeholders like $(PropertyName) string pattern = @"\$\((?\w+)\)"; content = Regex.Replace(content, pattern, match => { string propName = match.Groups["prop"].Value; return dict.TryGetValue(propName, out var value) ? value : match.Value; }); // Check if the output file exists and read its content if (File.Exists(this.OutputFile)) { string existingContent = File.ReadAllText(this.OutputFile); // Only write the file if the content has changed if (existingContent != content) { File.WriteAllText(this.OutputFile, content); } } else { // Write the transformed content to the output file if it doesn't exist File.WriteAllText(this.OutputFile, content); } return true; } catch (Exception ex) { this.Log.LogErrorFromException(ex); return false; } } } } ================================================ FILE: src/ElectronNET.ConsoleApp/ElectronNET.ConsoleApp.csproj ================================================ true net10.0 exe false false False false disable 128.png app.ico true app.ico ElectronNET API Demo1 1.0.2 com.electronnet-apisamples.app Electron.NET Demo Application Electron.Net Copyright © 2025, Electron.NET Electron;.NET;ASP;NET;Sample;App 30.4.0 MIT commonjs false linux-x64 PreserveNewest PreserveNewest ================================================ FILE: src/ElectronNET.ConsoleApp/Program.cs ================================================ using ElectronNET.API; namespace ElectronNET.WebApp { using System; using System.Threading.Tasks; using ElectronNET.API.Entities; public class Program { public static async Task Main(string[] args) { var runtimeController = ElectronNetRuntime.RuntimeController; try { await runtimeController.Start(); await runtimeController.WaitReadyTask; await ElectronBootstrap(); await runtimeController.WaitStoppedTask; } catch (Exception ex) { Console.WriteLine(ex); await runtimeController.Stop().ConfigureAwait(false); await runtimeController.WaitStoppedTask.WaitAsync(TimeSpan.FromSeconds(2)).ConfigureAwait(false); } } public static async Task ElectronBootstrap() { //AddDevelopmentTests(); var browserWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Width = 1152, Height = 940, Show = false, }, "https://github.com/ElectronNET/Electron.NET"); await browserWindow.WebContents.Session.ClearCacheAsync(); browserWindow.OnReadyToShow += () => browserWindow.Show(); } } } ================================================ FILE: src/ElectronNET.ConsoleApp/Properties/PublishProfiles/linux-x64.pubxml ================================================  Release Any CPU publish\Release\net8.0\linux-x64 FileSystem <_TargetId>Folder net10.0 linux-x64 false false ================================================ FILE: src/ElectronNET.ConsoleApp/Properties/PublishProfiles/publish-win-x64.pubxml ================================================  true false Release Any CPU FileSystem publish\Release\net8.0\win-x64\ FileSystem <_TargetId>Folder net10.0 win-x64 true ================================================ FILE: src/ElectronNET.ConsoleApp/Properties/PublishProfiles/win-x64.pubxml ================================================  Release Any CPU publish\Release\net8.0\win-x64 FileSystem <_TargetId>Folder net10.0 win-x64 false false false ================================================ FILE: src/ElectronNET.ConsoleApp/Properties/electron-builder.json ================================================ { "$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json", "compression": "maximum", //"afterPack": "bin/Assets/afterPack.js", //"beforePack": "bin/Assets/beforePack.js", "buildNumber": "", "linux": { "target": [ "tar.xz" //"AppImage", //"rpm", //"deb", //"pacman" ], "executableArgs": [ "--no-sandbox" ], "icon": "bin/Assets/icon.png", "artifactName": "${name}-${arch}-${version}.${ext}" }, "win": { "target": [ { "target": "portable", "arch": "x64" } ], "icon": "bin/Assets/icon.ico" }, "mac": { "icon": "bin/Assets/icon.icns" } } ================================================ FILE: src/ElectronNET.ConsoleApp/Properties/launchSettings.json ================================================ { "profiles": { "DotNet (unpackaged)": { "commandName": "Project", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "Electron (unpackaged)": { "commandName": "Executable", "executablePath": "node", "commandLineArgs": "node_modules/electron/cli.js main.js -unpackedelectron", "workingDirectory": "$(TargetDir).electron", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "WSL": { "commandName": "WSL2", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development", "ASPNETCORE_URLS": "http://localhost:8001/" }, "distributionName": "" }, "Profile 1": { "commandName": "Project" } } } ================================================ FILE: src/ElectronNET.Host/.gitignore ================================================ node_modules bin ================================================ FILE: src/ElectronNET.Host/.vscode/launch.json ================================================ { // Use IntelliSense to learn about possible attributes. // Hover to view descriptions of existing attributes. // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 "version": "0.2.0", "configurations": [ { "type": "node", "request": "launch", "name": "Launch Electron App", "runtimeExecutable": "${workspaceFolder}/node_modules/.bin/electron", "program": "${workspaceFolder}/main.js", "skipFiles": [ "/**" ], "cwd": "${workspaceFolder}", "console": "externalTerminal", "args": [ "--test=true" ] } ] } ================================================ FILE: src/ElectronNET.Host/.vscode/tasks.json ================================================ { "version": "2.0.0", "tasks": [ { "type": "typescript", "tsconfig": "tsconfig.json", "problemMatcher": [ "$tsc" ], "group": { "kind": "build", "isDefault": true } } ] } ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/.gitignore ================================================ # Created by https://www.gitignore.io/api/node # Edit at https://www.gitignore.io/?templates=node ### Node ### # Logs logs *.log npm-debug.log* yarn-debug.log* yarn-error.log* lerna-debug.log* # Diagnostic reports (https://nodejs.org/api/report.html) report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json # Runtime data pids *.pid *.seed *.pid.lock # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage # nyc test coverage .nyc_output # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) .grunt # Bower dependency directory (https://bower.io/) bower_components # node-waf configuration .lock-wscript # Compiled binary addons (https://nodejs.org/api/addons.html) build/Release # Dependency directories node_modules/ jspm_packages/ # TypeScript v1 declaration files typings/ # Optional npm cache directory .npm # Optional eslint cache .eslintcache # Optional REPL history .node_repl_history # Output of 'npm pack' *.tgz # Yarn Integrity file .yarn-integrity # dotenv environment variables file .env .env.test # parcel-bundler cache (https://parceljs.org/) .cache # next.js build output .next # nuxt.js build output .nuxt # vuepress build output .vuepress/dist # Serverless directories .serverless/ # FuseBox cache .fusebox/ # DynamoDB Local files .dynamodb/ # End of https://www.gitignore.io/api/node ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/connector.js ================================================ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.Connector = void 0; const socket_io_1 = require("socket.io"); class Connector { socket; app; constructor(socket, // @ts-ignore app) { this.socket = socket; this.app = app; } on(key, javaScriptCode) { this.socket.on(key, (...args) => { const id = args.pop(); try { javaScriptCode(...args, (data) => { if (data) { this.socket.emit(`${key}Complete${id}`, data); } }); } catch (error) { this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error); } }); } } exports.Connector = Connector; //# sourceMappingURL=connector.js.map ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/connector.ts ================================================ import { Socket } from 'socket.io'; export class Connector { constructor(private socket: Socket, // @ts-ignore public app: Electron.App) { } on(key: string, javaScriptCode: Function): void { this.socket.on(key, (...args: any[]) => { const id: string = args.pop(); try { javaScriptCode(...args, (data) => { if (data) { this.socket.emit(`${key}Complete${id}`, data); } }); } catch (error) { this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error); } }); } } ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/index.js ================================================ "use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || (function () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); Object.defineProperty(exports, "__esModule", { value: true }); exports.HookService = void 0; // @ts-ignore const Electron = __importStar(require("electron")); const socket_io_1 = require("socket.io"); const connector_1 = require("./connector"); class HookService extends connector_1.Connector { app; constructor(socket, app) { super(socket, app); this.app = app; } onHostReady() { // execute your own JavaScript Host logic here } } exports.HookService = HookService; //# sourceMappingURL=index.js.map ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/index.ts ================================================ // @ts-ignore import * as Electron from "electron"; import { Socket } from "socket.io"; import { Connector } from "./connector"; export class HookService extends Connector { constructor(socket: Socket, public app: Electron.App) { super(socket, app); } onHostReady(): void { // execute your own JavaScript Host logic here } } ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/package.json ================================================ { "name": "electron-host-hook", "version": "1.0.0", "description": "Connector for Electron.NET projects.", "repository": { "url": "https://github.com/ElectronNET/Electron.NET" }, "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "Gregor Biswanger", "license": "MIT", "devDependencies": { "typescript": "^5.9.3" }, "dependencies": { "socket.io": "^4.8.1" } } ================================================ FILE: src/ElectronNET.Host/ElectronHostHook/tsconfig.json ================================================ { "compilerOptions": { "module": "commonjs", "target": "ES2019", "sourceMap": true, "skipLibCheck": true, "newLine": "crlf" }, "exclude": [ "node_modules" ] } ================================================ FILE: src/ElectronNET.Host/ElectronNET.Host.esproj ================================================ ================================================ FILE: src/ElectronNET.Host/api/app.js ================================================ "use strict"; let isQuitWindowAllClosed = true; let electronSocket; let appWindowAllClosedEventId; module.exports = (socket, app) => { electronSocket = socket; // By default, quit when all windows are closed app.on("window-all-closed", () => { // On macOS it is common for applications and their menu bar // to stay active until the user quits explicitly with Cmd + Q if (process.platform !== "darwin" && isQuitWindowAllClosed) { app.quit(); } else if (appWindowAllClosedEventId) { // If the user is on macOS // - OR - // If the user has indicated NOT to quit when all windows are closed, // emit the event. electronSocket.emit("app-window-all-closed" + appWindowAllClosedEventId); } }); socket.on("quit-app-window-all-closed", (quit) => { isQuitWindowAllClosed = quit; }); socket.on("register-app-window-all-closed", (id) => { appWindowAllClosedEventId = id; }); socket.on("register-app-before-quit", (id) => { app.on("before-quit", (event) => { event.preventDefault(); electronSocket.emit("app-before-quit" + id); }); }); socket.on("register-app-will-quit", (id) => { app.on("will-quit", (event) => { event.preventDefault(); electronSocket.emit("app-will-quit" + id); }); }); socket.on("register-app-browser-window-blur", (id) => { app.on("browser-window-blur", () => { electronSocket.emit("app-browser-window-blur" + id); }); }); socket.on("register-app-browser-window-focus", (id) => { app.on("browser-window-focus", () => { electronSocket.emit("app-browser-window-focus" + id); }); }); socket.on("register-app-browser-window-created", (id) => { app.on("browser-window-created", () => { electronSocket.emit("app-browser-window-created" + id); }); }); socket.on("register-app-web-contents-created", (id) => { app.on("web-contents-created", () => { electronSocket.emit("app-web-contents-created" + id); }); }); socket.on("register-app-accessibility-support-changed", (id) => { app.on("accessibility-support-changed", (event, accessibilitySupportEnabled) => { electronSocket.emit("app-accessibility-support-changed" + id, accessibilitySupportEnabled); }); }); socket.on("appQuit", () => { app.quit(); }); socket.on("appExit", (exitCode = 0) => { app.exit(exitCode); }); socket.on("appRelaunch", (options) => { app.relaunch(options); }); socket.on("appFocus", (options) => { app.focus(options); }); socket.on("appHide", () => { app.hide(); }); socket.on("appShow", () => { app.show(); }); socket.on("appGetAppPath", () => { const path = app.getAppPath(); electronSocket.emit("appGetAppPathCompleted", path); }); socket.on("appSetAppLogsPath", (path) => { app.setAppLogsPath(path); }); socket.on("appGetPath", (name) => { const path = app.getPath(name); electronSocket.emit("appGetPathCompleted", path); }); socket.on("appGetFileIcon", async (path, options) => { let error = {}; if (options) { const nativeImage = await app .getFileIcon(path, options) .catch((errorFileIcon) => (error = errorFileIcon)); electronSocket.emit("appGetFileIconCompleted", [error, nativeImage]); } else { const nativeImage = await app .getFileIcon(path) .catch((errorFileIcon) => (error = errorFileIcon)); electronSocket.emit("appGetFileIconCompleted", [error, nativeImage]); } }); socket.on("appSetPath", (name, path) => { app.setPath(name, path); }); socket.on("appGetVersion", () => { const version = app.getVersion(); electronSocket.emit("appGetVersionCompleted", version); }); socket.on("appGetName", () => { electronSocket.emit("appGetNameCompleted", app.name); }); socket.on("appSetName", (name) => { app.name = name; }); socket.on("appGetLocale", () => { const locale = app.getLocale(); electronSocket.emit("appGetLocaleCompleted", locale); }); socket.on("appAddRecentDocument", (path) => { app.addRecentDocument(path); }); socket.on("appClearRecentDocuments", () => { app.clearRecentDocuments(); }); socket.on("appSetAsDefaultProtocolClient", (protocol, path, args) => { const success = app.setAsDefaultProtocolClient(protocol, path, args); electronSocket.emit("appSetAsDefaultProtocolClientCompleted", success); }); socket.on("appRemoveAsDefaultProtocolClient", (protocol, path, args) => { const success = app.removeAsDefaultProtocolClient(protocol, path, args); electronSocket.emit("appRemoveAsDefaultProtocolClientCompleted", success); }); socket.on("appIsDefaultProtocolClient", (protocol, path, args) => { const success = app.isDefaultProtocolClient(protocol, path, args); electronSocket.emit("appIsDefaultProtocolClientCompleted", success); }); socket.on("appSetUserTasks", (tasks) => { const success = app.setUserTasks(tasks); electronSocket.emit("appSetUserTasksCompleted", success); }); socket.on("appGetJumpListSettings", () => { const jumpListSettings = app.getJumpListSettings(); electronSocket.emit("appGetJumpListSettingsCompleted", jumpListSettings); }); socket.on("appSetJumpList", (categories) => { app.setJumpList(categories); }); socket.on("appRequestSingleInstanceLock", () => { const success = app.requestSingleInstanceLock(); electronSocket.emit("appRequestSingleInstanceLockCompleted", success); app.on("second-instance", (event, args = [], workingDirectory = "") => { electronSocket.emit("secondInstance", [args, workingDirectory]); }); }); socket.on("appHasSingleInstanceLock", () => { const hasLock = app.hasSingleInstanceLock(); electronSocket.emit("appHasSingleInstanceLockCompleted", hasLock); }); socket.on("appReleaseSingleInstanceLock", () => { app.releaseSingleInstanceLock(); }); socket.on("appSetUserActivity", (type, userInfo, webpageUrl) => { app.setUserActivity(type, userInfo, webpageUrl); }); socket.on("appGetCurrentActivityType", () => { const activityType = app.getCurrentActivityType(); electronSocket.emit("appGetCurrentActivityTypeCompleted", activityType); }); socket.on("appInvalidateCurrentActivity", () => { app.invalidateCurrentActivity(); }); socket.on("appResignCurrentActivity", () => { app.resignCurrentActivity(); }); socket.on("appSetAppUserModelId", (id) => { app.setAppUserModelId(id); }); socket.on("appImportCertificate", (options) => { app.importCertificate(options, (result) => { electronSocket.emit("appImportCertificateCompleted", result); }); }); socket.on("appGetAppMetrics", () => { const processMetrics = app.getAppMetrics(); electronSocket.emit("appGetAppMetricsCompleted", processMetrics); }); socket.on("appGetGpuFeatureStatus", () => { const gpuFeatureStatus = app.getGPUFeatureStatus(); electronSocket.emit("appGetGpuFeatureStatusCompleted", gpuFeatureStatus); }); socket.on("appSetBadgeCount", (count) => { const success = app.setBadgeCount(count); electronSocket.emit("appSetBadgeCountCompleted", success); }); socket.on("appGetBadgeCount", () => { const count = app.getBadgeCount(); electronSocket.emit("appGetBadgeCountCompleted", count); }); socket.on("appIsUnityRunning", () => { const isUnityRunning = app.isUnityRunning(); electronSocket.emit("appIsUnityRunningCompleted", isUnityRunning); }); socket.on("appGetLoginItemSettings", (options) => { const loginItemSettings = app.getLoginItemSettings(options); electronSocket.emit("appGetLoginItemSettingsCompleted", loginItemSettings); }); socket.on("appSetLoginItemSettings", (settings) => { app.setLoginItemSettings(settings); }); socket.on("appIsAccessibilitySupportEnabled", () => { const isAccessibilitySupportEnabled = app.isAccessibilitySupportEnabled(); electronSocket.emit("appIsAccessibilitySupportEnabledCompleted", isAccessibilitySupportEnabled); }); socket.on("appSetAccessibilitySupportEnabled", (enabled) => { app.setAccessibilitySupportEnabled(enabled); }); socket.on("appShowAboutPanel", () => { app.showAboutPanel(); }); socket.on("appSetAboutPanelOptions", (options) => { app.setAboutPanelOptions(options); }); socket.on("appGetUserAgentFallback", () => { electronSocket.emit("appGetUserAgentFallbackCompleted", app.userAgentFallback); }); socket.on("appSetUserAgentFallback", (userAgent) => { app.userAgentFallback = userAgent; }); socket.on("register-app-on-event", (eventName, listenerName) => { app.on(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); }); socket.on("register-app-once-event", (eventName, listenerName) => { app.once(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); }); }; //# sourceMappingURL=app.js.map ================================================ FILE: src/ElectronNET.Host/api/app.ts ================================================ import type { Socket } from "net"; import { RelaunchOptions, LoginItemSettingsOptions, Settings, AboutPanelOptionsOptions, } from "electron"; let isQuitWindowAllClosed = true; let electronSocket: Socket; let appWindowAllClosedEventId: string; export = (socket: Socket, app: Electron.App) => { electronSocket = socket; // By default, quit when all windows are closed app.on("window-all-closed", () => { // On macOS it is common for applications and their menu bar // to stay active until the user quits explicitly with Cmd + Q if (process.platform !== "darwin" && isQuitWindowAllClosed) { app.quit(); } else if (appWindowAllClosedEventId) { // If the user is on macOS // - OR - // If the user has indicated NOT to quit when all windows are closed, // emit the event. electronSocket.emit("app-window-all-closed" + appWindowAllClosedEventId); } }); socket.on("quit-app-window-all-closed", (quit) => { isQuitWindowAllClosed = quit; }); socket.on("register-app-window-all-closed", (id) => { appWindowAllClosedEventId = id; }); socket.on("register-app-before-quit", (id) => { app.on("before-quit", (event) => { event.preventDefault(); electronSocket.emit("app-before-quit" + id); }); }); socket.on("register-app-will-quit", (id) => { app.on("will-quit", (event) => { event.preventDefault(); electronSocket.emit("app-will-quit" + id); }); }); socket.on("register-app-browser-window-blur", (id) => { app.on("browser-window-blur", () => { electronSocket.emit("app-browser-window-blur" + id); }); }); socket.on("register-app-browser-window-focus", (id) => { app.on("browser-window-focus", () => { electronSocket.emit("app-browser-window-focus" + id); }); }); socket.on("register-app-browser-window-created", (id) => { app.on("browser-window-created", () => { electronSocket.emit("app-browser-window-created" + id); }); }); socket.on("register-app-web-contents-created", (id) => { app.on("web-contents-created", () => { electronSocket.emit("app-web-contents-created" + id); }); }); socket.on("register-app-accessibility-support-changed", (id) => { app.on( "accessibility-support-changed", (event, accessibilitySupportEnabled) => { electronSocket.emit( "app-accessibility-support-changed" + id, accessibilitySupportEnabled, ); }, ); }); socket.on("appQuit", () => { app.quit(); }); socket.on("appExit", (exitCode = 0) => { app.exit(exitCode); }); socket.on("appRelaunch", (options) => { app.relaunch(options as RelaunchOptions); }); socket.on("appFocus", (options) => { app.focus(options); }); socket.on("appHide", () => { app.hide(); }); socket.on("appShow", () => { app.show(); }); socket.on("appGetAppPath", () => { const path = app.getAppPath(); electronSocket.emit("appGetAppPathCompleted", path); }); socket.on("appSetAppLogsPath", (path) => { app.setAppLogsPath(path); }); socket.on("appGetPath", (name) => { const path = app.getPath(name); electronSocket.emit("appGetPathCompleted", path); }); socket.on("appGetFileIcon", async (path, options) => { let error = {}; if (options) { const nativeImage = await app .getFileIcon(path, options) .catch((errorFileIcon) => (error = errorFileIcon)); electronSocket.emit("appGetFileIconCompleted", [error, nativeImage]); } else { const nativeImage = await app .getFileIcon(path) .catch((errorFileIcon) => (error = errorFileIcon)); electronSocket.emit("appGetFileIconCompleted", [error, nativeImage]); } }); socket.on("appSetPath", (name, path) => { app.setPath(name, path); }); socket.on("appGetVersion", () => { const version = app.getVersion(); electronSocket.emit("appGetVersionCompleted", version); }); socket.on("appGetName", () => { electronSocket.emit("appGetNameCompleted", app.name); }); socket.on("appSetName", (name) => { app.name = name; }); socket.on("appGetLocale", () => { const locale = app.getLocale(); electronSocket.emit("appGetLocaleCompleted", locale); }); socket.on("appAddRecentDocument", (path) => { app.addRecentDocument(path); }); socket.on("appClearRecentDocuments", () => { app.clearRecentDocuments(); }); socket.on("appSetAsDefaultProtocolClient", (protocol, path, args) => { const success = app.setAsDefaultProtocolClient(protocol, path, args); electronSocket.emit("appSetAsDefaultProtocolClientCompleted", success); }); socket.on("appRemoveAsDefaultProtocolClient", (protocol, path, args) => { const success = app.removeAsDefaultProtocolClient(protocol, path, args); electronSocket.emit("appRemoveAsDefaultProtocolClientCompleted", success); }); socket.on("appIsDefaultProtocolClient", (protocol, path, args) => { const success = app.isDefaultProtocolClient(protocol, path, args); electronSocket.emit("appIsDefaultProtocolClientCompleted", success); }); socket.on("appSetUserTasks", (tasks) => { const success = app.setUserTasks(tasks); electronSocket.emit("appSetUserTasksCompleted", success); }); socket.on("appGetJumpListSettings", () => { const jumpListSettings = app.getJumpListSettings(); electronSocket.emit("appGetJumpListSettingsCompleted", jumpListSettings); }); socket.on("appSetJumpList", (categories) => { app.setJumpList(categories); }); socket.on("appRequestSingleInstanceLock", () => { const success = app.requestSingleInstanceLock(); electronSocket.emit("appRequestSingleInstanceLockCompleted", success); app.on("second-instance", (event, args = [], workingDirectory = "") => { electronSocket.emit("secondInstance", [args, workingDirectory]); }); }); socket.on("appHasSingleInstanceLock", () => { const hasLock = app.hasSingleInstanceLock(); electronSocket.emit("appHasSingleInstanceLockCompleted", hasLock); }); socket.on("appReleaseSingleInstanceLock", () => { app.releaseSingleInstanceLock(); }); socket.on("appSetUserActivity", (type, userInfo, webpageUrl) => { app.setUserActivity(type, userInfo, webpageUrl); }); socket.on("appGetCurrentActivityType", () => { const activityType = app.getCurrentActivityType(); electronSocket.emit("appGetCurrentActivityTypeCompleted", activityType); }); socket.on("appInvalidateCurrentActivity", () => { app.invalidateCurrentActivity(); }); socket.on("appResignCurrentActivity", () => { app.resignCurrentActivity(); }); socket.on("appSetAppUserModelId", (id) => { app.setAppUserModelId(id); }); socket.on("appImportCertificate", (options) => { app.importCertificate(options, (result) => { electronSocket.emit("appImportCertificateCompleted", result); }); }); socket.on("appGetAppMetrics", () => { const processMetrics = app.getAppMetrics(); electronSocket.emit("appGetAppMetricsCompleted", processMetrics); }); socket.on("appGetGpuFeatureStatus", () => { const gpuFeatureStatus = app.getGPUFeatureStatus(); electronSocket.emit("appGetGpuFeatureStatusCompleted", gpuFeatureStatus); }); socket.on("appSetBadgeCount", (count) => { const success = app.setBadgeCount(count); electronSocket.emit("appSetBadgeCountCompleted", success); }); socket.on("appGetBadgeCount", () => { const count = app.getBadgeCount(); electronSocket.emit("appGetBadgeCountCompleted", count); }); socket.on("appIsUnityRunning", () => { const isUnityRunning = app.isUnityRunning(); electronSocket.emit("appIsUnityRunningCompleted", isUnityRunning); }); socket.on("appGetLoginItemSettings", (options) => { const loginItemSettings = app.getLoginItemSettings( options as LoginItemSettingsOptions, ); electronSocket.emit("appGetLoginItemSettingsCompleted", loginItemSettings); }); socket.on("appSetLoginItemSettings", (settings) => { app.setLoginItemSettings(settings as Settings); }); socket.on("appIsAccessibilitySupportEnabled", () => { const isAccessibilitySupportEnabled = app.isAccessibilitySupportEnabled(); electronSocket.emit( "appIsAccessibilitySupportEnabledCompleted", isAccessibilitySupportEnabled, ); }); socket.on("appSetAccessibilitySupportEnabled", (enabled) => { app.setAccessibilitySupportEnabled(enabled); }); socket.on("appShowAboutPanel", () => { app.showAboutPanel(); }); socket.on("appSetAboutPanelOptions", (options) => { app.setAboutPanelOptions(options as AboutPanelOptionsOptions); }); socket.on("appGetUserAgentFallback", () => { electronSocket.emit( "appGetUserAgentFallbackCompleted", app.userAgentFallback, ); }); socket.on("appSetUserAgentFallback", (userAgent) => { app.userAgentFallback = userAgent; }); socket.on("register-app-on-event", (eventName, listenerName) => { app.on(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); }); socket.on("register-app-once-event", (eventName, listenerName) => { app.once(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); }); }; ================================================ FILE: src/ElectronNET.Host/api/autoUpdater.js ================================================ "use strict"; const electron_updater_1 = require("electron-updater"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("register-autoUpdater-error", (id) => { electron_updater_1.autoUpdater.on("error", (error) => { electronSocket.emit("autoUpdater-error" + id, error.message); }); }); socket.on("register-autoUpdater-checking-for-update", (id) => { electron_updater_1.autoUpdater.on("checking-for-update", () => { electronSocket.emit("autoUpdater-checking-for-update" + id); }); }); socket.on("register-autoUpdater-update-available", (id) => { electron_updater_1.autoUpdater.on("update-available", (updateInfo) => { electronSocket.emit("autoUpdater-update-available" + id, updateInfo); }); }); socket.on("register-autoUpdater-update-not-available", (id) => { electron_updater_1.autoUpdater.on("update-not-available", (updateInfo) => { electronSocket.emit("autoUpdater-update-not-available" + id, updateInfo); }); }); socket.on("register-autoUpdater-download-progress", (id) => { electron_updater_1.autoUpdater.on("download-progress", (progressInfo) => { electronSocket.emit("autoUpdater-download-progress" + id, progressInfo); }); }); socket.on("register-autoUpdater-update-downloaded", (id) => { electron_updater_1.autoUpdater.on("update-downloaded", (updateInfo) => { electronSocket.emit("autoUpdater-update-downloaded" + id, updateInfo); }); }); // Properties ***** socket.on("autoUpdater-autoDownload", () => { electronSocket.emit("autoUpdater-autoDownload-completed", electron_updater_1.autoUpdater.autoDownload); }); socket.on("autoUpdater-autoDownload-set", (value) => { electron_updater_1.autoUpdater.autoDownload = value; }); socket.on("autoUpdater-autoInstallOnAppQuit", () => { electronSocket.emit("autoUpdater-autoInstallOnAppQuit-completed", electron_updater_1.autoUpdater.autoInstallOnAppQuit); }); socket.on("autoUpdater-autoInstallOnAppQuit-set", (value) => { electron_updater_1.autoUpdater.autoInstallOnAppQuit = value; }); socket.on("autoUpdater-allowPrerelease", () => { electronSocket.emit("autoUpdater-allowPrerelease-completed", electron_updater_1.autoUpdater.allowPrerelease); }); socket.on("autoUpdater-allowPrerelease-set", (value) => { electron_updater_1.autoUpdater.allowPrerelease = value; }); socket.on("autoUpdater-fullChangelog", () => { electronSocket.emit("autoUpdater-fullChangelog-completed", electron_updater_1.autoUpdater.fullChangelog); }); socket.on("autoUpdater-fullChangelog-set", (value) => { electron_updater_1.autoUpdater.fullChangelog = value; }); socket.on("autoUpdater-allowDowngrade", () => { electronSocket.emit("autoUpdater-allowDowngrade-completed", electron_updater_1.autoUpdater.allowDowngrade); }); socket.on("autoUpdater-allowDowngrade-set", (value) => { electron_updater_1.autoUpdater.allowDowngrade = value; }); socket.on("autoUpdater-updateConfigPath", () => { electronSocket.emit("autoUpdater-updateConfigPath-completed", electron_updater_1.autoUpdater.updateConfigPath || ""); }); socket.on("autoUpdater-updateConfigPath-set", (value) => { electron_updater_1.autoUpdater.updateConfigPath = value; }); socket.on("autoUpdater-currentVersion", () => { electronSocket.emit("autoUpdater-currentVersion-completed", electron_updater_1.autoUpdater.currentVersion); }); socket.on("autoUpdater-channel", () => { electronSocket.emit("autoUpdater-channel-completed", electron_updater_1.autoUpdater.channel || ""); }); socket.on("autoUpdater-channel-set", (value) => { electron_updater_1.autoUpdater.channel = value; }); socket.on("autoUpdater-requestHeaders", () => { electronSocket.emit("autoUpdater-requestHeaders-completed", electron_updater_1.autoUpdater.requestHeaders); }); socket.on("autoUpdater-requestHeaders-set", (value) => { electron_updater_1.autoUpdater.requestHeaders = value; }); socket.on("autoUpdater-checkForUpdatesAndNotify", async (guid) => { electron_updater_1.autoUpdater .checkForUpdatesAndNotify() .then((updateCheckResult) => { electronSocket.emit("autoUpdater-checkForUpdatesAndNotify-completed" + guid, updateCheckResult); }) .catch((error) => { electronSocket.emit("autoUpdater-checkForUpdatesAndNotifyError" + guid, error); }); }); socket.on("autoUpdater-checkForUpdates", async (guid) => { electron_updater_1.autoUpdater .checkForUpdates() .then((updateCheckResult) => { electronSocket.emit("autoUpdater-checkForUpdates-completed" + guid, updateCheckResult); }) .catch((error) => { electronSocket.emit("autoUpdater-checkForUpdatesError" + guid, error); }); }); socket.on("autoUpdater-quitAndInstall", async (isSilent, isForceRunAfter) => { electron_updater_1.autoUpdater.quitAndInstall(isSilent, isForceRunAfter); }); socket.on("autoUpdater-downloadUpdate", async (guid) => { const downloadedPath = await electron_updater_1.autoUpdater.downloadUpdate(); electronSocket.emit("autoUpdater-downloadUpdate-completed" + guid, downloadedPath); }); socket.on("autoUpdater-getFeedURL", async (guid) => { const feedUrl = await electron_updater_1.autoUpdater.getFeedURL(); electronSocket.emit("autoUpdater-getFeedURL-completed" + guid, feedUrl || ""); }); }; //# sourceMappingURL=autoUpdater.js.map ================================================ FILE: src/ElectronNET.Host/api/autoUpdater.ts ================================================ import type { Socket } from "net"; import { autoUpdater } from "electron-updater"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("register-autoUpdater-error", (id) => { autoUpdater.on("error", (error) => { electronSocket.emit("autoUpdater-error" + id, error.message); }); }); socket.on("register-autoUpdater-checking-for-update", (id) => { autoUpdater.on("checking-for-update", () => { electronSocket.emit("autoUpdater-checking-for-update" + id); }); }); socket.on("register-autoUpdater-update-available", (id) => { autoUpdater.on("update-available", (updateInfo) => { electronSocket.emit("autoUpdater-update-available" + id, updateInfo); }); }); socket.on("register-autoUpdater-update-not-available", (id) => { autoUpdater.on("update-not-available", (updateInfo) => { electronSocket.emit("autoUpdater-update-not-available" + id, updateInfo); }); }); socket.on("register-autoUpdater-download-progress", (id) => { autoUpdater.on("download-progress", (progressInfo) => { electronSocket.emit("autoUpdater-download-progress" + id, progressInfo); }); }); socket.on("register-autoUpdater-update-downloaded", (id) => { autoUpdater.on("update-downloaded", (updateInfo) => { electronSocket.emit("autoUpdater-update-downloaded" + id, updateInfo); }); }); // Properties ***** socket.on("autoUpdater-autoDownload", () => { electronSocket.emit( "autoUpdater-autoDownload-completed", autoUpdater.autoDownload, ); }); socket.on("autoUpdater-autoDownload-set", (value) => { autoUpdater.autoDownload = value; }); socket.on("autoUpdater-autoInstallOnAppQuit", () => { electronSocket.emit( "autoUpdater-autoInstallOnAppQuit-completed", autoUpdater.autoInstallOnAppQuit, ); }); socket.on("autoUpdater-autoInstallOnAppQuit-set", (value) => { autoUpdater.autoInstallOnAppQuit = value; }); socket.on("autoUpdater-allowPrerelease", () => { electronSocket.emit( "autoUpdater-allowPrerelease-completed", autoUpdater.allowPrerelease, ); }); socket.on("autoUpdater-allowPrerelease-set", (value) => { autoUpdater.allowPrerelease = value; }); socket.on("autoUpdater-fullChangelog", () => { electronSocket.emit( "autoUpdater-fullChangelog-completed", autoUpdater.fullChangelog, ); }); socket.on("autoUpdater-fullChangelog-set", (value) => { autoUpdater.fullChangelog = value; }); socket.on("autoUpdater-allowDowngrade", () => { electronSocket.emit( "autoUpdater-allowDowngrade-completed", autoUpdater.allowDowngrade, ); }); socket.on("autoUpdater-allowDowngrade-set", (value) => { autoUpdater.allowDowngrade = value; }); socket.on("autoUpdater-updateConfigPath", () => { electronSocket.emit( "autoUpdater-updateConfigPath-completed", autoUpdater.updateConfigPath || "", ); }); socket.on("autoUpdater-updateConfigPath-set", (value) => { autoUpdater.updateConfigPath = value; }); socket.on("autoUpdater-currentVersion", () => { electronSocket.emit( "autoUpdater-currentVersion-completed", autoUpdater.currentVersion, ); }); socket.on("autoUpdater-channel", () => { electronSocket.emit( "autoUpdater-channel-completed", autoUpdater.channel || "", ); }); socket.on("autoUpdater-channel-set", (value) => { autoUpdater.channel = value; }); socket.on("autoUpdater-requestHeaders", () => { electronSocket.emit( "autoUpdater-requestHeaders-completed", autoUpdater.requestHeaders, ); }); socket.on("autoUpdater-requestHeaders-set", (value) => { autoUpdater.requestHeaders = value; }); socket.on("autoUpdater-checkForUpdatesAndNotify", async (guid) => { autoUpdater .checkForUpdatesAndNotify() .then((updateCheckResult) => { electronSocket.emit( "autoUpdater-checkForUpdatesAndNotify-completed" + guid, updateCheckResult, ); }) .catch((error) => { electronSocket.emit( "autoUpdater-checkForUpdatesAndNotifyError" + guid, error, ); }); }); socket.on("autoUpdater-checkForUpdates", async (guid) => { autoUpdater .checkForUpdates() .then((updateCheckResult) => { electronSocket.emit( "autoUpdater-checkForUpdates-completed" + guid, updateCheckResult, ); }) .catch((error) => { electronSocket.emit("autoUpdater-checkForUpdatesError" + guid, error); }); }); socket.on("autoUpdater-quitAndInstall", async (isSilent, isForceRunAfter) => { autoUpdater.quitAndInstall(isSilent, isForceRunAfter); }); socket.on("autoUpdater-downloadUpdate", async (guid) => { const downloadedPath = await autoUpdater.downloadUpdate(); electronSocket.emit( "autoUpdater-downloadUpdate-completed" + guid, downloadedPath, ); }); socket.on("autoUpdater-getFeedURL", async (guid) => { const feedUrl = await autoUpdater.getFeedURL(); electronSocket.emit( "autoUpdater-getFeedURL-completed" + guid, feedUrl || "", ); }); }; ================================================ FILE: src/ElectronNET.Host/api/browserView.js ================================================ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.browserViewMediateService = exports.browserViewApi = void 0; const electron_1 = require("electron"); const browserViews = (global["browserViews"] = global["browserViews"] || []); const proxyToCredentialsMap = (global["proxyToCredentialsMap"] = global["proxyToCredentialsMap"] || []); let browserView; let electronSocket; const browserViewApi = (socket) => { electronSocket = socket; socket.on("createBrowserView", (options) => { if (!hasOwnChildreen(options, "webPreferences", "nodeIntegration")) { options = { ...options, webPreferences: { nodeIntegration: true, contextIsolation: false }, }; } browserView = new electron_1.BrowserView(options); browserView["id"] = browserViews.length + 1; if (options.proxy) { browserView.webContents.session.setProxy({ proxyRules: options.proxy }); } if (options.proxy && options.proxyCredentials) { proxyToCredentialsMap[options.proxy] = options.proxyCredentials; } browserViews.push(browserView); electronSocket.emit("BrowserViewCreated", browserView["id"]); }); socket.on("browserView-bounds", (id) => { const bounds = getBrowserViewById(id).getBounds(); electronSocket.emit("browserView-bounds-completed", bounds); }); socket.on("browserView-bounds-set", (id, bounds) => { getBrowserViewById(id).setBounds(bounds); }); socket.on("browserView-setAutoResize", (id, options) => { getBrowserViewById(id).setAutoResize(options); }); socket.on("browserView-setBackgroundColor", (id, color) => { getBrowserViewById(id).setBackgroundColor(color); }); function hasOwnChildreen(obj, ...childNames) { for (let i = 0; i < childNames.length; i++) { if (!obj || !obj.hasOwnProperty(childNames[i])) { return false; } obj = obj[childNames[i]]; } return true; } }; exports.browserViewApi = browserViewApi; const browserViewMediateService = (browserViewId) => { return getBrowserViewById(browserViewId); }; exports.browserViewMediateService = browserViewMediateService; function getBrowserViewById(id) { for (let index = 0; index < browserViews.length; index++) { const browserViewItem = browserViews[index]; if (browserViewItem["id"] === id) { return browserViewItem; } } } //# sourceMappingURL=browserView.js.map ================================================ FILE: src/ElectronNET.Host/api/browserView.ts ================================================ import type { Socket } from "net"; import { BrowserView } from "electron"; const browserViews: BrowserView[] = (global["browserViews"] = global["browserViews"] || []) as BrowserView[]; const proxyToCredentialsMap: { [proxy: string]: string } = (global[ "proxyToCredentialsMap" ] = global["proxyToCredentialsMap"] || []) as { [proxy: string]: string }; let browserView: BrowserView; let electronSocket: Socket; const browserViewApi = (socket: Socket) => { electronSocket = socket; socket.on("createBrowserView", (options) => { if (!hasOwnChildreen(options, "webPreferences", "nodeIntegration")) { options = { ...options, webPreferences: { nodeIntegration: true, contextIsolation: false }, }; } browserView = new BrowserView(options); browserView["id"] = browserViews.length + 1; if (options.proxy) { browserView.webContents.session.setProxy({ proxyRules: options.proxy }); } if (options.proxy && options.proxyCredentials) { proxyToCredentialsMap[options.proxy] = options.proxyCredentials; } browserViews.push(browserView); electronSocket.emit("BrowserViewCreated", browserView["id"]); }); socket.on("browserView-bounds", (id) => { const bounds = getBrowserViewById(id).getBounds(); electronSocket.emit("browserView-bounds-completed", bounds); }); socket.on("browserView-bounds-set", (id, bounds) => { getBrowserViewById(id).setBounds(bounds); }); socket.on("browserView-setAutoResize", (id, options) => { getBrowserViewById(id).setAutoResize(options); }); socket.on("browserView-setBackgroundColor", (id, color) => { getBrowserViewById(id).setBackgroundColor(color); }); function hasOwnChildreen(obj, ...childNames) { for (let i = 0; i < childNames.length; i++) { if (!obj || !obj.hasOwnProperty(childNames[i])) { return false; } obj = obj[childNames[i]]; } return true; } }; const browserViewMediateService = (browserViewId: number): BrowserView => { return getBrowserViewById(browserViewId); }; function getBrowserViewById(id: number) { for (let index = 0; index < browserViews.length; index++) { const browserViewItem = browserViews[index]; if (browserViewItem["id"] === id) { return browserViewItem; } } } export { browserViewApi, browserViewMediateService }; ================================================ FILE: src/ElectronNET.Host/api/browserWindows.js ================================================ "use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || (function () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); const path = __importStar(require("path")); const electron_1 = require("electron"); const browserView_1 = require("./browserView"); const windows = (global["browserWindows"] = global["browserWindows"] || []); let readyToShowWindowsIds = []; let window; let lastOptions; let electronSocket; const proxyToCredentialsMap = (global["proxyToCredentialsMap"] = global["proxyToCredentialsMap"] || []); module.exports = (socket, app) => { electronSocket = socket; app.on("login", (event, webContents, request, authInfo, callback) => { if (authInfo.isProxy) { let proxy = `${authInfo.host}:${authInfo.port}`; if (proxy in proxyToCredentialsMap && proxyToCredentialsMap[proxy].split(":").length === 2) { event.preventDefault(); let user = proxyToCredentialsMap[proxy].split(":")[0]; let pass = proxyToCredentialsMap[proxy].split(":")[1]; callback(user, pass); } } }); socket.on("register-browserWindow-ready-to-show", (id) => { if (readyToShowWindowsIds.includes(id)) { readyToShowWindowsIds = readyToShowWindowsIds.filter((value) => value !== id); electronSocket.emit("browserWindow-ready-to-show" + id); } getWindowById(id).on("ready-to-show", () => { readyToShowWindowsIds.push(id); electronSocket.emit("browserWindow-ready-to-show" + id); }); }); socket.on("register-browserWindow-page-title-updated", (id) => { getWindowById(id).on("page-title-updated", (event, title) => { electronSocket.emit("browserWindow-page-title-updated" + id, title); }); }); socket.on("register-browserWindow-close", (id) => { getWindowById(id).on("close", () => { electronSocket.emit("browserWindow-close" + id); }); }); socket.on("register-browserWindow-closed", (id) => { getWindowById(id).on("closed", () => { electronSocket.emit("browserWindow-closed" + id); }); }); socket.on("register-browserWindow-session-end", (id) => { getWindowById(id).on("session-end", () => { electronSocket.emit("browserWindow-session-end" + id); }); }); socket.on("register-browserWindow-unresponsive", (id) => { getWindowById(id).on("unresponsive", () => { electronSocket.emit("browserWindow-unresponsive" + id); }); }); socket.on("register-browserWindow-responsive", (id) => { getWindowById(id).on("responsive", () => { electronSocket.emit("browserWindow-responsive" + id); }); }); socket.on("register-browserWindow-blur", (id) => { getWindowById(id).on("blur", () => { electronSocket.emit("browserWindow-blur" + id); }); }); socket.on("register-browserWindow-focus", (id) => { getWindowById(id).on("focus", () => { electronSocket.emit("browserWindow-focus" + id); }); }); socket.on("register-browserWindow-show", (id) => { getWindowById(id).on("show", () => { electronSocket.emit("browserWindow-show" + id); }); }); socket.on("register-browserWindow-hide", (id) => { getWindowById(id).on("hide", () => { electronSocket.emit("browserWindow-hide" + id); }); }); socket.on("register-browserWindow-maximize", (id) => { getWindowById(id).on("maximize", () => { electronSocket.emit("browserWindow-maximize" + id); }); }); socket.on("register-browserWindow-unmaximize", (id) => { getWindowById(id).on("unmaximize", () => { electronSocket.emit("browserWindow-unmaximize" + id); }); }); socket.on("register-browserWindow-minimize", (id) => { getWindowById(id).on("minimize", () => { electronSocket.emit("browserWindow-minimize" + id); }); }); socket.on("register-browserWindow-restore", (id) => { getWindowById(id).on("restore", () => { electronSocket.emit("browserWindow-restore" + id); }); }); socket.on("register-browserWindow-resize", (id) => { getWindowById(id).on("resize", () => { electronSocket.emit("browserWindow-resize" + id); }); }); socket.on("register-browserWindow-move", (id) => { getWindowById(id).on("move", () => { electronSocket.emit("browserWindow-move" + id); }); }); socket.on("register-browserWindow-bounds-changed", (id) => { const window = getWindowById(id); const cb = () => electronSocket.emit("browserWindow-bounds-changed" + id, window.getBounds()); window.on("resize", cb); window.on("move", cb); }); socket.on("register-browserWindow-moved", (id) => { getWindowById(id).on("moved", () => { electronSocket.emit("browserWindow-moved" + id); }); }); socket.on("register-browserWindow-enter-full-screen", (id) => { getWindowById(id).on("enter-full-screen", () => { electronSocket.emit("browserWindow-enter-full-screen" + id); }); }); socket.on("register-browserWindow-leave-full-screen", (id) => { getWindowById(id).on("leave-full-screen", () => { electronSocket.emit("browserWindow-leave-full-screen" + id); }); }); socket.on("register-browserWindow-enter-html-full-screen", (id) => { getWindowById(id).on("enter-html-full-screen", () => { electronSocket.emit("browserWindow-enter-html-full-screen" + id); }); }); socket.on("register-browserWindow-leave-html-full-screen", (id) => { getWindowById(id).on("leave-html-full-screen", () => { electronSocket.emit("browserWindow-leave-html-full-screen" + id); }); }); socket.on("register-browserWindow-app-command", (id) => { getWindowById(id).on("app-command", (event, command) => { electronSocket.emit("browserWindow-app-command" + id, command); }); }); socket.on("register-browserWindow-swipe", (id) => { getWindowById(id).on("swipe", (event, direction) => { electronSocket.emit("browserWindow-swipe" + id, direction); }); }); socket.on("register-browserWindow-sheet-begin", (id) => { getWindowById(id).on("sheet-begin", () => { electronSocket.emit("browserWindow-sheet-begin" + id); }); }); socket.on("register-browserWindow-sheet-end", (id) => { getWindowById(id).on("sheet-end", () => { electronSocket.emit("browserWindow-sheet-end" + id); }); }); socket.on("register-browserWindow-new-window-for-tab", (id) => { getWindowById(id).on("new-window-for-tab", () => { electronSocket.emit("browserWindow-new-window-for-tab" + id); }); }); socket.on("createBrowserWindow", (options, loadUrl) => { if (options.webPreferences && !("nodeIntegration" in options.webPreferences)) { options = { ...options, webPreferences: { ...options.webPreferences, nodeIntegration: true, contextIsolation: false, }, }; } else if (!options.webPreferences) { options = { ...options, webPreferences: { nodeIntegration: true, contextIsolation: false }, }; } if (options.isRunningBlazor) { options.webPreferences["preload"] = path.join(__dirname, "..", "scripts", "blazor-preload.js"); } delete options.isRunningBlazor; // we dont want to recreate the window when watch is ready. if (app.commandLine.hasSwitch("watch") && app["mainWindowURL"] === loadUrl) { window = app["mainWindow"]; if (window) { window.reload(); windows.push(window); electronSocket.emit("BrowserWindowCreated", window.id); return; } } else { window = new electron_1.BrowserWindow(options); } if (options.proxy) { window.webContents.session.setProxy({ proxyRules: options.proxy }); } if (options.proxy && options.proxyCredentials) { proxyToCredentialsMap[options.proxy] = options.proxyCredentials; } window.on("ready-to-show", () => { if (readyToShowWindowsIds.includes(window.id)) { readyToShowWindowsIds = readyToShowWindowsIds.filter((value) => value !== window.id); } else { readyToShowWindowsIds.push(window.id); } }); lastOptions = options; window.on("closed", (sender) => { for (let index = 0; index < windows.length; index++) { const windowItem = windows[index]; try { windowItem.id; } catch (error) { if (error.message === "Object has been destroyed") { windows.splice(index, 1); const ids = []; windows.forEach((x) => ids.push(x.id)); electronSocket.emit("BrowserWindowClosed", ids); } } } }); app.on("activate", () => { // On macOS it's common to re-create a window in the app when the // dock icon is clicked and there are no other windows open. if (window === null && lastOptions) { window = new electron_1.BrowserWindow(lastOptions); } }); if (loadUrl) { window.loadURL(loadUrl); } if (app.commandLine.hasSwitch("clear-cache") && app.commandLine.getSwitchValue("clear-cache")) { window.webContents.session.clearCache(); console.log("auto clear-cache active for new window."); } // set main window url if (app["mainWindowURL"] == undefined || app["mainWindowURL"] == "") { app["mainWindowURL"] = loadUrl; app["mainWindow"] = window; } windows.push(window); electronSocket.emit("BrowserWindowCreated", window.id); }); socket.on("browserWindowDestroy", (id) => { getWindowById(id).destroy(); }); socket.on("browserWindowClose", (id) => { getWindowById(id).close(); }); socket.on("browserWindowFocus", (id) => { getWindowById(id).focus(); }); socket.on("browserWindowBlur", (id) => { getWindowById(id).blur(); }); socket.on("browserWindowIsFocused", (id) => { const isFocused = getWindowById(id).isFocused(); electronSocket.emit("browserWindow-isFocused-completed", isFocused); }); socket.on("browserWindowIsDestroyed", (id) => { const isDestroyed = getWindowById(id).isDestroyed(); electronSocket.emit("browserWindow-isDestroyed-completed", isDestroyed); }); socket.on("browserWindowShow", (id) => { getWindowById(id).show(); }); socket.on("browserWindowShowInactive", (id) => { getWindowById(id).showInactive(); }); socket.on("browserWindowHide", (id) => { getWindowById(id).hide(); }); socket.on("browserWindowIsVisible", (id) => { const isVisible = getWindowById(id).isVisible(); electronSocket.emit("browserWindow-isVisible-completed", isVisible); }); socket.on("browserWindowIsModal", (id) => { const isModal = getWindowById(id).isModal(); electronSocket.emit("browserWindow-isModal-completed", isModal); }); socket.on("browserWindowMaximize", (id) => { getWindowById(id).maximize(); }); socket.on("browserWindowUnmaximize", (id) => { getWindowById(id).unmaximize(); }); socket.on("browserWindowIsMaximized", (id) => { const isMaximized = getWindowById(id).isMaximized(); electronSocket.emit("browserWindow-isMaximized-completed", isMaximized); }); socket.on("browserWindowMinimize", (id) => { getWindowById(id).minimize(); }); socket.on("browserWindowRestore", (id) => { getWindowById(id).restore(); }); socket.on("browserWindowIsMinimized", (id) => { const isMinimized = getWindowById(id).isMinimized(); electronSocket.emit("browserWindow-isMinimized-completed", isMinimized); }); socket.on("browserWindowSetFullScreen", (id, fullscreen) => { getWindowById(id).setFullScreen(fullscreen); }); socket.on("browserWindowIsFullScreen", (id) => { const isFullScreen = getWindowById(id).isFullScreen(); electronSocket.emit("browserWindow-isFullScreen-completed", isFullScreen); }); socket.on("browserWindowSetAspectRatio", (id, aspectRatio, extraSize) => { getWindowById(id).setAspectRatio(aspectRatio, extraSize); }); socket.on("browserWindowPreviewFile", (id, path, displayname) => { getWindowById(id).previewFile(path, displayname); }); socket.on("browserWindowCloseFilePreview", (id) => { getWindowById(id).closeFilePreview(); }); socket.on("browserWindowSetBounds", (id, bounds, animate) => { getWindowById(id).setBounds(bounds, animate); }); socket.on("browserWindowGetBounds", (id) => { const rectangle = getWindowById(id).getBounds(); electronSocket.emit("browserWindow-getBounds-completed", rectangle); }); socket.on("browserWindowSetContentBounds", (id, bounds, animate) => { getWindowById(id).setContentBounds(bounds, animate); }); socket.on("browserWindowGetContentBounds", (id) => { const rectangle = getWindowById(id).getContentBounds(); electronSocket.emit("browserWindow-getContentBounds-completed", rectangle); }); socket.on("browserWindowSetSize", (id, width, height, animate) => { getWindowById(id).setSize(width, height, animate); }); socket.on("browserWindowGetSize", (id) => { const size = getWindowById(id).getSize(); electronSocket.emit("browserWindow-getSize-completed", size); }); socket.on("browserWindowSetContentSize", (id, width, height, animate) => { getWindowById(id).setContentSize(width, height, animate); }); socket.on("browserWindowGetContentSize", (id) => { const size = getWindowById(id).getContentSize(); electronSocket.emit("browserWindow-getContentSize-completed", size); }); socket.on("browserWindowSetMinimumSize", (id, width, height) => { getWindowById(id).setMinimumSize(width, height); }); socket.on("browserWindowGetMinimumSize", (id) => { const size = getWindowById(id).getMinimumSize(); electronSocket.emit("browserWindow-getMinimumSize-completed", size); }); socket.on("browserWindowSetMaximumSize", (id, width, height) => { getWindowById(id).setMaximumSize(width, height); }); socket.on("browserWindowGetMaximumSize", (id) => { const size = getWindowById(id).getMaximumSize(); electronSocket.emit("browserWindow-getMaximumSize-completed", size); }); socket.on("browserWindowSetResizable", (id, resizable) => { getWindowById(id).setResizable(resizable); }); socket.on("browserWindowIsResizable", (id) => { const resizable = getWindowById(id).isResizable(); electronSocket.emit("browserWindow-isResizable-completed", resizable); }); socket.on("browserWindowSetMovable", (id, movable) => { getWindowById(id).setMovable(movable); }); socket.on("browserWindowIsMovable", (id) => { const movable = getWindowById(id).isMovable(); electronSocket.emit("browserWindow-isMovable-completed", movable); }); socket.on("browserWindowSetMinimizable", (id, minimizable) => { getWindowById(id).setMinimizable(minimizable); }); socket.on("browserWindowIsMinimizable", (id) => { const minimizable = getWindowById(id).isMinimizable(); electronSocket.emit("browserWindow-isMinimizable-completed", minimizable); }); socket.on("browserWindowSetMaximizable", (id, maximizable) => { getWindowById(id).setMaximizable(maximizable); }); socket.on("browserWindowIsMaximizable", (id) => { const maximizable = getWindowById(id).isMaximizable(); electronSocket.emit("browserWindow-isMaximizable-completed", maximizable); }); socket.on("browserWindowSetFullScreenable", (id, fullscreenable) => { getWindowById(id).setFullScreenable(fullscreenable); }); socket.on("browserWindowIsFullScreenable", (id) => { const fullscreenable = getWindowById(id).isFullScreenable(); electronSocket.emit("browserWindow-isFullScreenable-completed", fullscreenable); }); socket.on("browserWindowSetClosable", (id, closable) => { getWindowById(id).setClosable(closable); }); socket.on("browserWindowIsClosable", (id) => { const closable = getWindowById(id).isClosable(); electronSocket.emit("browserWindow-isClosable-completed", closable); }); socket.on("browserWindowSetAlwaysOnTop", (id, flag, level, relativeLevel) => { getWindowById(id).setAlwaysOnTop(flag, level, relativeLevel); }); socket.on("browserWindowIsAlwaysOnTop", (id) => { const isAlwaysOnTop = getWindowById(id).isAlwaysOnTop(); electronSocket.emit("browserWindow-isAlwaysOnTop-completed", isAlwaysOnTop); }); socket.on("browserWindowCenter", (id) => { getWindowById(id).center(); }); socket.on("browserWindowSetPosition", (id, x, y, animate) => { getWindowById(id).setPosition(x, y, animate); }); socket.on("browserWindowGetPosition", (id) => { const position = getWindowById(id).getPosition(); electronSocket.emit("browserWindow-getPosition-completed", position); }); socket.on("browserWindowSetTitle", (id, title) => { getWindowById(id).setTitle(title); }); socket.on("browserWindowGetTitle", (id) => { const title = getWindowById(id).getTitle(); electronSocket.emit("browserWindow-getTitle-completed", title); }); socket.on("browserWindowSetTitle", (id, title) => { getWindowById(id).setTitle(title); }); socket.on("browserWindowSetSheetOffset", (id, offsetY, offsetX) => { if (offsetX) { getWindowById(id).setSheetOffset(offsetY, offsetX); } else { getWindowById(id).setSheetOffset(offsetY); } }); socket.on("browserWindowFlashFrame", (id, flag) => { getWindowById(id).flashFrame(flag); }); socket.on("browserWindowSetSkipTaskbar", (id, skip) => { getWindowById(id).setSkipTaskbar(skip); }); socket.on("browserWindowSetKiosk", (id, flag) => { getWindowById(id).setKiosk(flag); }); socket.on("browserWindowIsKiosk", (id) => { const isKiosk = getWindowById(id).isKiosk(); electronSocket.emit("browserWindow-isKiosk-completed", isKiosk); }); socket.on("browserWindowGetNativeWindowHandle", (id) => { const nativeWindowHandle = getWindowById(id) .getNativeWindowHandle() .readInt32LE(0) .toString(16); electronSocket.emit("browserWindow-getNativeWindowHandle-completed", nativeWindowHandle); }); socket.on("browserWindowSetRepresentedFilename", (id, filename) => { const win = getWindowById(id); try { if (win && typeof win.setRepresentedFilename === "function") { win.setRepresentedFilename(filename); } } catch (e) { console.warn("setRepresentedFilename failed (likely unsupported platform):", e); } }); socket.on("browserWindowGetRepresentedFilename", (id) => { const win = getWindowById(id); let pathname = ""; try { if (win && typeof win.getRepresentedFilename === "function") { pathname = win.getRepresentedFilename() || ""; } } catch (e) { console.warn("getRepresentedFilename failed (likely unsupported platform):", e); } electronSocket.emit("browserWindow-getRepresentedFilename-completed", pathname); }); socket.on("browserWindowSetDocumentEdited", (id, edited) => { getWindowById(id).setDocumentEdited(edited); }); socket.on("browserWindowIsDocumentEdited", (id) => { const edited = getWindowById(id).isDocumentEdited(); electronSocket.emit("browserWindow-isDocumentEdited-completed", edited); }); socket.on("browserWindowFocusOnWebView", (id) => { getWindowById(id).focusOnWebView(); }); socket.on("browserWindowBlurWebView", (id) => { getWindowById(id).blurWebView(); }); socket.on("browserWindowLoadURL", (id, url, options) => { getWindowById(id).loadURL(url, options); }); socket.on("browserWindowReload", (id) => { getWindowById(id).reload(); }); socket.on("browserWindowSetMenu", (id, menuItems) => { let menu = null; if (menuItems) { menu = electron_1.Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("windowMenuItemClicked", id); }); } getWindowById(id).setMenu(menu); }); socket.on("browserWindowRemoveMenu", (id) => { getWindowById(id).removeMenu(); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } socket.on("browserWindowSetProgressBar", (id, progress) => { getWindowById(id).setProgressBar(progress); }); socket.on("browserWindowSetProgressBar", (id, progress, options) => { getWindowById(id).setProgressBar(progress, options); }); socket.on("browserWindowSetHasShadow", (id, hasShadow) => { getWindowById(id).setHasShadow(hasShadow); }); socket.on("browserWindowHasShadow", (id) => { const hasShadow = getWindowById(id).hasShadow(); electronSocket.emit("browserWindow-hasShadow-completed", hasShadow); }); socket.on("browserWindowSetThumbarButtons", (id, thumbarButtons) => { thumbarButtons.forEach((thumbarButton) => { const originalIconPath = thumbarButton.icon.toString(); const path = require("path"); const fs = require("fs"); let imagePath = originalIconPath; if (!path.isAbsolute(originalIconPath)) { imagePath = path.join(__dirname.replace("api", ""), "bin", originalIconPath); } const { nativeImage } = require("electron"); if (fs.existsSync(imagePath)) { thumbarButton.icon = nativeImage.createFromPath(imagePath); } else { // Fallback to empty image to avoid failure thumbarButton.icon = nativeImage.createEmpty(); } thumbarButton.click = () => { electronSocket.emit("thumbarButtonClicked", thumbarButton["id"]); }; }); const success = getWindowById(id).setThumbarButtons(thumbarButtons); electronSocket.emit("browserWindowSetThumbarButtons-completed", success); }); socket.on("browserWindowSetThumbnailClip", (id, rectangle) => { getWindowById(id).setThumbnailClip(rectangle); }); socket.on("browserWindowSetThumbnailToolTip", (id, toolTip) => { getWindowById(id).setThumbnailToolTip(toolTip); }); socket.on("browserWindowSetAppDetails", (id, options) => { getWindowById(id).setAppDetails(options); }); socket.on("browserWindowShowDefinitionForSelection", (id) => { getWindowById(id).showDefinitionForSelection(); }); socket.on("browserWindowSetAutoHideMenuBar", (id, hide) => { getWindowById(id).setAutoHideMenuBar(hide); }); socket.on("browserWindowIsMenuBarAutoHide", (id) => { const isMenuBarAutoHide = getWindowById(id).isMenuBarAutoHide(); electronSocket.emit("browserWindow-isMenuBarAutoHide-completed", isMenuBarAutoHide); }); socket.on("browserWindowSetMenuBarVisibility", (id, visible) => { getWindowById(id).setMenuBarVisibility(visible); }); socket.on("browserWindowIsMenuBarVisible", (id) => { const isMenuBarVisible = getWindowById(id).isMenuBarVisible(); electronSocket.emit("browserWindow-isMenuBarVisible-completed", isMenuBarVisible); }); socket.on("browserWindowSetVisibleOnAllWorkspaces", (id, visible) => { getWindowById(id).setVisibleOnAllWorkspaces(visible); }); socket.on("browserWindowIsVisibleOnAllWorkspaces", (id) => { const isVisibleOnAllWorkspaces = getWindowById(id).isVisibleOnAllWorkspaces(); electronSocket.emit("browserWindow-isVisibleOnAllWorkspaces-completed", isVisibleOnAllWorkspaces); }); socket.on("browserWindowSetIgnoreMouseEvents", (id, ignore) => { getWindowById(id).setIgnoreMouseEvents(ignore); }); socket.on("browserWindowSetContentProtection", (id, enable) => { getWindowById(id).setContentProtection(enable); }); socket.on("browserWindowSetFocusable", (id, focusable) => { getWindowById(id).setFocusable(focusable); }); socket.on("browserWindowSetParentWindow", (id, parent) => { const child = getWindowById(id); if (!parent) { // Clear parent: make this window top-level child.setParentWindow(null); return; } const browserWindow = electron_1.BrowserWindow.fromId(parent.id); child.setParentWindow(browserWindow); }); socket.on("browserWindowGetParentWindow", (id) => { const browserWindow = getWindowById(id).getParentWindow(); electronSocket.emit("browserWindow-getParentWindow-completed", browserWindow.id); }); socket.on("browserWindowGetChildWindows", (id) => { const browserWindows = getWindowById(id).getChildWindows(); const ids = []; browserWindows.forEach((x) => { ids.push(x.id); }); electronSocket.emit("browserWindow-getChildWindows-completed", ids); }); socket.on("browserWindowSetAutoHideCursor", (id, autoHide) => { getWindowById(id).setAutoHideCursor(autoHide); }); socket.on("browserWindowSetVibrancy", (id, type) => { getWindowById(id).setVibrancy(type); }); socket.on("browserWindow-setBrowserView", (id, browserViewId) => { getWindowById(id).setBrowserView((0, browserView_1.browserViewMediateService)(browserViewId)); }); function getWindowById(id) { for (let index = 0; index < windows.length; index++) { const element = windows[index]; if (element.id === id) { return element; } } } }; //# sourceMappingURL=browserWindows.js.map ================================================ FILE: src/ElectronNET.Host/api/browserWindows.ts ================================================ import * as path from "path"; import type { Socket } from "net"; import { BrowserWindow, Menu } from "electron"; import { browserViewMediateService } from "./browserView"; const windows: Electron.BrowserWindow[] = (global["browserWindows"] = global["browserWindows"] || []) as Electron.BrowserWindow[]; let readyToShowWindowsIds: number[] = []; let window; let lastOptions; let electronSocket; const proxyToCredentialsMap: { [proxy: string]: string } = (global[ "proxyToCredentialsMap" ] = global["proxyToCredentialsMap"] || []) as { [proxy: string]: string }; export = (socket: Socket, app: Electron.App) => { electronSocket = socket; app.on("login", (event, webContents, request, authInfo, callback) => { if (authInfo.isProxy) { let proxy = `${authInfo.host}:${authInfo.port}`; if ( proxy in proxyToCredentialsMap && proxyToCredentialsMap[proxy].split(":").length === 2 ) { event.preventDefault(); let user = proxyToCredentialsMap[proxy].split(":")[0]; let pass = proxyToCredentialsMap[proxy].split(":")[1]; callback(user, pass); } } }); socket.on("register-browserWindow-ready-to-show", (id) => { if (readyToShowWindowsIds.includes(id)) { readyToShowWindowsIds = readyToShowWindowsIds.filter( (value) => value !== id, ); electronSocket.emit("browserWindow-ready-to-show" + id); } getWindowById(id).on("ready-to-show", () => { readyToShowWindowsIds.push(id); electronSocket.emit("browserWindow-ready-to-show" + id); }); }); socket.on("register-browserWindow-page-title-updated", (id) => { getWindowById(id).on("page-title-updated", (event, title) => { electronSocket.emit("browserWindow-page-title-updated" + id, title); }); }); socket.on("register-browserWindow-close", (id) => { getWindowById(id).on("close", () => { electronSocket.emit("browserWindow-close" + id); }); }); socket.on("register-browserWindow-closed", (id) => { getWindowById(id).on("closed", () => { electronSocket.emit("browserWindow-closed" + id); }); }); socket.on("register-browserWindow-session-end", (id) => { getWindowById(id).on("session-end", () => { electronSocket.emit("browserWindow-session-end" + id); }); }); socket.on("register-browserWindow-unresponsive", (id) => { getWindowById(id).on("unresponsive", () => { electronSocket.emit("browserWindow-unresponsive" + id); }); }); socket.on("register-browserWindow-responsive", (id) => { getWindowById(id).on("responsive", () => { electronSocket.emit("browserWindow-responsive" + id); }); }); socket.on("register-browserWindow-blur", (id) => { getWindowById(id).on("blur", () => { electronSocket.emit("browserWindow-blur" + id); }); }); socket.on("register-browserWindow-focus", (id) => { getWindowById(id).on("focus", () => { electronSocket.emit("browserWindow-focus" + id); }); }); socket.on("register-browserWindow-show", (id) => { getWindowById(id).on("show", () => { electronSocket.emit("browserWindow-show" + id); }); }); socket.on("register-browserWindow-hide", (id) => { getWindowById(id).on("hide", () => { electronSocket.emit("browserWindow-hide" + id); }); }); socket.on("register-browserWindow-maximize", (id) => { getWindowById(id).on("maximize", () => { electronSocket.emit("browserWindow-maximize" + id); }); }); socket.on("register-browserWindow-unmaximize", (id) => { getWindowById(id).on("unmaximize", () => { electronSocket.emit("browserWindow-unmaximize" + id); }); }); socket.on("register-browserWindow-minimize", (id) => { getWindowById(id).on("minimize", () => { electronSocket.emit("browserWindow-minimize" + id); }); }); socket.on("register-browserWindow-restore", (id) => { getWindowById(id).on("restore", () => { electronSocket.emit("browserWindow-restore" + id); }); }); socket.on("register-browserWindow-resize", (id) => { getWindowById(id).on("resize", () => { electronSocket.emit("browserWindow-resize" + id); }); }); socket.on("register-browserWindow-move", (id) => { getWindowById(id).on("move", () => { electronSocket.emit("browserWindow-move" + id); }); }); socket.on("register-browserWindow-bounds-changed", (id) => { const window = getWindowById(id); const cb = () => electronSocket.emit( "browserWindow-bounds-changed" + id, window.getBounds(), ); window.on("resize", cb); window.on("move", cb); }); socket.on("register-browserWindow-moved", (id) => { getWindowById(id).on("moved", () => { electronSocket.emit("browserWindow-moved" + id); }); }); socket.on("register-browserWindow-enter-full-screen", (id) => { getWindowById(id).on("enter-full-screen", () => { electronSocket.emit("browserWindow-enter-full-screen" + id); }); }); socket.on("register-browserWindow-leave-full-screen", (id) => { getWindowById(id).on("leave-full-screen", () => { electronSocket.emit("browserWindow-leave-full-screen" + id); }); }); socket.on("register-browserWindow-enter-html-full-screen", (id) => { getWindowById(id).on("enter-html-full-screen", () => { electronSocket.emit("browserWindow-enter-html-full-screen" + id); }); }); socket.on("register-browserWindow-leave-html-full-screen", (id) => { getWindowById(id).on("leave-html-full-screen", () => { electronSocket.emit("browserWindow-leave-html-full-screen" + id); }); }); socket.on("register-browserWindow-app-command", (id) => { getWindowById(id).on("app-command", (event, command) => { electronSocket.emit("browserWindow-app-command" + id, command); }); }); socket.on("register-browserWindow-swipe", (id) => { getWindowById(id).on("swipe", (event, direction) => { electronSocket.emit("browserWindow-swipe" + id, direction); }); }); socket.on("register-browserWindow-sheet-begin", (id) => { getWindowById(id).on("sheet-begin", () => { electronSocket.emit("browserWindow-sheet-begin" + id); }); }); socket.on("register-browserWindow-sheet-end", (id) => { getWindowById(id).on("sheet-end", () => { electronSocket.emit("browserWindow-sheet-end" + id); }); }); socket.on("register-browserWindow-new-window-for-tab", (id) => { getWindowById(id).on("new-window-for-tab", () => { electronSocket.emit("browserWindow-new-window-for-tab" + id); }); }); socket.on("createBrowserWindow", (options, loadUrl) => { if ( options.webPreferences && !("nodeIntegration" in options.webPreferences) ) { options = { ...options, webPreferences: { ...options.webPreferences, nodeIntegration: true, contextIsolation: false, }, }; } else if (!options.webPreferences) { options = { ...options, webPreferences: { nodeIntegration: true, contextIsolation: false }, }; } if (options.isRunningBlazor) { options.webPreferences["preload"] = path.join( __dirname, "..", "scripts", "blazor-preload.js", ); } delete options.isRunningBlazor; // we dont want to recreate the window when watch is ready. if ( app.commandLine.hasSwitch("watch") && app["mainWindowURL"] === loadUrl ) { window = app["mainWindow"]; if (window) { window.reload(); windows.push(window); electronSocket.emit("BrowserWindowCreated", window.id); return; } } else { window = new BrowserWindow(options); } if (options.proxy) { window.webContents.session.setProxy({ proxyRules: options.proxy }); } if (options.proxy && options.proxyCredentials) { proxyToCredentialsMap[options.proxy] = options.proxyCredentials; } window.on("ready-to-show", () => { if (readyToShowWindowsIds.includes(window.id)) { readyToShowWindowsIds = readyToShowWindowsIds.filter( (value) => value !== window.id, ); } else { readyToShowWindowsIds.push(window.id); } }); lastOptions = options; window.on("closed", (sender) => { for (let index = 0; index < windows.length; index++) { const windowItem = windows[index]; try { windowItem.id; } catch (error) { if (error.message === "Object has been destroyed") { windows.splice(index, 1); const ids = []; windows.forEach((x) => ids.push(x.id)); electronSocket.emit("BrowserWindowClosed", ids); } } } }); app.on("activate", () => { // On macOS it's common to re-create a window in the app when the // dock icon is clicked and there are no other windows open. if (window === null && lastOptions) { window = new BrowserWindow(lastOptions); } }); if (loadUrl) { window.loadURL(loadUrl); } if ( app.commandLine.hasSwitch("clear-cache") && app.commandLine.getSwitchValue("clear-cache") ) { window.webContents.session.clearCache(); console.log("auto clear-cache active for new window."); } // set main window url if (app["mainWindowURL"] == undefined || app["mainWindowURL"] == "") { app["mainWindowURL"] = loadUrl; app["mainWindow"] = window; } windows.push(window); electronSocket.emit("BrowserWindowCreated", window.id); }); socket.on("browserWindowDestroy", (id) => { getWindowById(id).destroy(); }); socket.on("browserWindowClose", (id) => { getWindowById(id).close(); }); socket.on("browserWindowFocus", (id) => { getWindowById(id).focus(); }); socket.on("browserWindowBlur", (id) => { getWindowById(id).blur(); }); socket.on("browserWindowIsFocused", (id) => { const isFocused = getWindowById(id).isFocused(); electronSocket.emit("browserWindow-isFocused-completed", isFocused); }); socket.on("browserWindowIsDestroyed", (id) => { const isDestroyed = getWindowById(id).isDestroyed(); electronSocket.emit("browserWindow-isDestroyed-completed", isDestroyed); }); socket.on("browserWindowShow", (id) => { getWindowById(id).show(); }); socket.on("browserWindowShowInactive", (id) => { getWindowById(id).showInactive(); }); socket.on("browserWindowHide", (id) => { getWindowById(id).hide(); }); socket.on("browserWindowIsVisible", (id) => { const isVisible = getWindowById(id).isVisible(); electronSocket.emit("browserWindow-isVisible-completed", isVisible); }); socket.on("browserWindowIsModal", (id) => { const isModal = getWindowById(id).isModal(); electronSocket.emit("browserWindow-isModal-completed", isModal); }); socket.on("browserWindowMaximize", (id) => { getWindowById(id).maximize(); }); socket.on("browserWindowUnmaximize", (id) => { getWindowById(id).unmaximize(); }); socket.on("browserWindowIsMaximized", (id) => { const isMaximized = getWindowById(id).isMaximized(); electronSocket.emit("browserWindow-isMaximized-completed", isMaximized); }); socket.on("browserWindowMinimize", (id) => { getWindowById(id).minimize(); }); socket.on("browserWindowRestore", (id) => { getWindowById(id).restore(); }); socket.on("browserWindowIsMinimized", (id) => { const isMinimized = getWindowById(id).isMinimized(); electronSocket.emit("browserWindow-isMinimized-completed", isMinimized); }); socket.on("browserWindowSetFullScreen", (id, fullscreen) => { getWindowById(id).setFullScreen(fullscreen); }); socket.on("browserWindowIsFullScreen", (id) => { const isFullScreen = getWindowById(id).isFullScreen(); electronSocket.emit("browserWindow-isFullScreen-completed", isFullScreen); }); socket.on("browserWindowSetAspectRatio", (id, aspectRatio, extraSize) => { getWindowById(id).setAspectRatio(aspectRatio, extraSize); }); socket.on("browserWindowPreviewFile", (id, path, displayname) => { getWindowById(id).previewFile(path, displayname); }); socket.on("browserWindowCloseFilePreview", (id) => { getWindowById(id).closeFilePreview(); }); socket.on("browserWindowSetBounds", (id, bounds, animate) => { getWindowById(id).setBounds(bounds, animate); }); socket.on("browserWindowGetBounds", (id) => { const rectangle = getWindowById(id).getBounds(); electronSocket.emit("browserWindow-getBounds-completed", rectangle); }); socket.on("browserWindowSetContentBounds", (id, bounds, animate) => { getWindowById(id).setContentBounds(bounds, animate); }); socket.on("browserWindowGetContentBounds", (id) => { const rectangle = getWindowById(id).getContentBounds(); electronSocket.emit("browserWindow-getContentBounds-completed", rectangle); }); socket.on("browserWindowSetSize", (id, width, height, animate) => { getWindowById(id).setSize(width, height, animate); }); socket.on("browserWindowGetSize", (id) => { const size = getWindowById(id).getSize(); electronSocket.emit("browserWindow-getSize-completed", size); }); socket.on("browserWindowSetContentSize", (id, width, height, animate) => { getWindowById(id).setContentSize(width, height, animate); }); socket.on("browserWindowGetContentSize", (id) => { const size = getWindowById(id).getContentSize(); electronSocket.emit("browserWindow-getContentSize-completed", size); }); socket.on("browserWindowSetMinimumSize", (id, width, height) => { getWindowById(id).setMinimumSize(width, height); }); socket.on("browserWindowGetMinimumSize", (id) => { const size = getWindowById(id).getMinimumSize(); electronSocket.emit("browserWindow-getMinimumSize-completed", size); }); socket.on("browserWindowSetMaximumSize", (id, width, height) => { getWindowById(id).setMaximumSize(width, height); }); socket.on("browserWindowGetMaximumSize", (id) => { const size = getWindowById(id).getMaximumSize(); electronSocket.emit("browserWindow-getMaximumSize-completed", size); }); socket.on("browserWindowSetResizable", (id, resizable) => { getWindowById(id).setResizable(resizable); }); socket.on("browserWindowIsResizable", (id) => { const resizable = getWindowById(id).isResizable(); electronSocket.emit("browserWindow-isResizable-completed", resizable); }); socket.on("browserWindowSetMovable", (id, movable) => { getWindowById(id).setMovable(movable); }); socket.on("browserWindowIsMovable", (id) => { const movable = getWindowById(id).isMovable(); electronSocket.emit("browserWindow-isMovable-completed", movable); }); socket.on("browserWindowSetMinimizable", (id, minimizable) => { getWindowById(id).setMinimizable(minimizable); }); socket.on("browserWindowIsMinimizable", (id) => { const minimizable = getWindowById(id).isMinimizable(); electronSocket.emit("browserWindow-isMinimizable-completed", minimizable); }); socket.on("browserWindowSetMaximizable", (id, maximizable) => { getWindowById(id).setMaximizable(maximizable); }); socket.on("browserWindowIsMaximizable", (id) => { const maximizable = getWindowById(id).isMaximizable(); electronSocket.emit("browserWindow-isMaximizable-completed", maximizable); }); socket.on("browserWindowSetFullScreenable", (id, fullscreenable) => { getWindowById(id).setFullScreenable(fullscreenable); }); socket.on("browserWindowIsFullScreenable", (id) => { const fullscreenable = getWindowById(id).isFullScreenable(); electronSocket.emit( "browserWindow-isFullScreenable-completed", fullscreenable, ); }); socket.on("browserWindowSetClosable", (id, closable) => { getWindowById(id).setClosable(closable); }); socket.on("browserWindowIsClosable", (id) => { const closable = getWindowById(id).isClosable(); electronSocket.emit("browserWindow-isClosable-completed", closable); }); socket.on("browserWindowSetAlwaysOnTop", (id, flag, level, relativeLevel) => { getWindowById(id).setAlwaysOnTop(flag, level, relativeLevel); }); socket.on("browserWindowIsAlwaysOnTop", (id) => { const isAlwaysOnTop = getWindowById(id).isAlwaysOnTop(); electronSocket.emit("browserWindow-isAlwaysOnTop-completed", isAlwaysOnTop); }); socket.on("browserWindowCenter", (id) => { getWindowById(id).center(); }); socket.on("browserWindowSetPosition", (id, x, y, animate) => { getWindowById(id).setPosition(x, y, animate); }); socket.on("browserWindowGetPosition", (id) => { const position = getWindowById(id).getPosition(); electronSocket.emit("browserWindow-getPosition-completed", position); }); socket.on("browserWindowSetTitle", (id, title) => { getWindowById(id).setTitle(title); }); socket.on("browserWindowGetTitle", (id) => { const title = getWindowById(id).getTitle(); electronSocket.emit("browserWindow-getTitle-completed", title); }); socket.on("browserWindowSetTitle", (id, title) => { getWindowById(id).setTitle(title); }); socket.on("browserWindowSetSheetOffset", (id, offsetY, offsetX) => { if (offsetX) { getWindowById(id).setSheetOffset(offsetY, offsetX); } else { getWindowById(id).setSheetOffset(offsetY); } }); socket.on("browserWindowFlashFrame", (id, flag) => { getWindowById(id).flashFrame(flag); }); socket.on("browserWindowSetSkipTaskbar", (id, skip) => { getWindowById(id).setSkipTaskbar(skip); }); socket.on("browserWindowSetKiosk", (id, flag) => { getWindowById(id).setKiosk(flag); }); socket.on("browserWindowIsKiosk", (id) => { const isKiosk = getWindowById(id).isKiosk(); electronSocket.emit("browserWindow-isKiosk-completed", isKiosk); }); socket.on("browserWindowGetNativeWindowHandle", (id) => { const nativeWindowHandle = getWindowById(id) .getNativeWindowHandle() .readInt32LE(0) .toString(16); electronSocket.emit( "browserWindow-getNativeWindowHandle-completed", nativeWindowHandle, ); }); socket.on("browserWindowSetRepresentedFilename", (id, filename) => { const win = getWindowById(id); try { if (win && typeof win.setRepresentedFilename === "function") { win.setRepresentedFilename(filename); } } catch (e) { console.warn( "setRepresentedFilename failed (likely unsupported platform):", e, ); } }); socket.on("browserWindowGetRepresentedFilename", (id) => { const win = getWindowById(id); let pathname = ""; try { if (win && typeof win.getRepresentedFilename === "function") { pathname = win.getRepresentedFilename() || ""; } } catch (e) { console.warn( "getRepresentedFilename failed (likely unsupported platform):", e, ); } electronSocket.emit( "browserWindow-getRepresentedFilename-completed", pathname, ); }); socket.on("browserWindowSetDocumentEdited", (id, edited) => { getWindowById(id).setDocumentEdited(edited); }); socket.on("browserWindowIsDocumentEdited", (id) => { const edited = getWindowById(id).isDocumentEdited(); electronSocket.emit("browserWindow-isDocumentEdited-completed", edited); }); socket.on("browserWindowFocusOnWebView", (id) => { getWindowById(id).focusOnWebView(); }); socket.on("browserWindowBlurWebView", (id) => { getWindowById(id).blurWebView(); }); socket.on("browserWindowLoadURL", (id, url, options) => { getWindowById(id).loadURL(url, options); }); socket.on("browserWindowReload", (id) => { getWindowById(id).reload(); }); socket.on("browserWindowSetMenu", (id, menuItems) => { let menu = null; if (menuItems) { menu = Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("windowMenuItemClicked", id); }); } getWindowById(id).setMenu(menu); }); socket.on("browserWindowRemoveMenu", (id) => { getWindowById(id).removeMenu(); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } socket.on("browserWindowSetProgressBar", (id, progress) => { getWindowById(id).setProgressBar(progress); }); socket.on("browserWindowSetProgressBar", (id, progress, options) => { getWindowById(id).setProgressBar(progress, options); }); socket.on("browserWindowSetHasShadow", (id, hasShadow) => { getWindowById(id).setHasShadow(hasShadow); }); socket.on("browserWindowHasShadow", (id) => { const hasShadow = getWindowById(id).hasShadow(); electronSocket.emit("browserWindow-hasShadow-completed", hasShadow); }); socket.on( "browserWindowSetThumbarButtons", (id, thumbarButtons: Electron.ThumbarButton[]) => { thumbarButtons.forEach((thumbarButton) => { const originalIconPath = thumbarButton.icon.toString(); const path = require("path"); const fs = require("fs"); let imagePath = originalIconPath; if (!path.isAbsolute(originalIconPath)) { imagePath = path.join( __dirname.replace("api", ""), "bin", originalIconPath, ); } const { nativeImage } = require("electron"); if (fs.existsSync(imagePath)) { thumbarButton.icon = nativeImage.createFromPath(imagePath); } else { // Fallback to empty image to avoid failure thumbarButton.icon = nativeImage.createEmpty(); } thumbarButton.click = () => { electronSocket.emit("thumbarButtonClicked", thumbarButton["id"]); }; }); const success = getWindowById(id).setThumbarButtons(thumbarButtons); electronSocket.emit("browserWindowSetThumbarButtons-completed", success); }, ); socket.on("browserWindowSetThumbnailClip", (id, rectangle) => { getWindowById(id).setThumbnailClip(rectangle); }); socket.on("browserWindowSetThumbnailToolTip", (id, toolTip) => { getWindowById(id).setThumbnailToolTip(toolTip); }); socket.on("browserWindowSetAppDetails", (id, options) => { getWindowById(id).setAppDetails(options); }); socket.on("browserWindowShowDefinitionForSelection", (id) => { getWindowById(id).showDefinitionForSelection(); }); socket.on("browserWindowSetAutoHideMenuBar", (id, hide) => { getWindowById(id).setAutoHideMenuBar(hide); }); socket.on("browserWindowIsMenuBarAutoHide", (id) => { const isMenuBarAutoHide = getWindowById(id).isMenuBarAutoHide(); electronSocket.emit( "browserWindow-isMenuBarAutoHide-completed", isMenuBarAutoHide, ); }); socket.on("browserWindowSetMenuBarVisibility", (id, visible) => { getWindowById(id).setMenuBarVisibility(visible); }); socket.on("browserWindowIsMenuBarVisible", (id) => { const isMenuBarVisible = getWindowById(id).isMenuBarVisible(); electronSocket.emit( "browserWindow-isMenuBarVisible-completed", isMenuBarVisible, ); }); socket.on("browserWindowSetVisibleOnAllWorkspaces", (id, visible) => { getWindowById(id).setVisibleOnAllWorkspaces(visible); }); socket.on("browserWindowIsVisibleOnAllWorkspaces", (id) => { const isVisibleOnAllWorkspaces = getWindowById(id).isVisibleOnAllWorkspaces(); electronSocket.emit( "browserWindow-isVisibleOnAllWorkspaces-completed", isVisibleOnAllWorkspaces, ); }); socket.on("browserWindowSetIgnoreMouseEvents", (id, ignore) => { getWindowById(id).setIgnoreMouseEvents(ignore); }); socket.on("browserWindowSetContentProtection", (id, enable) => { getWindowById(id).setContentProtection(enable); }); socket.on("browserWindowSetFocusable", (id, focusable) => { getWindowById(id).setFocusable(focusable); }); socket.on("browserWindowSetParentWindow", (id, parent) => { const child = getWindowById(id); if (!parent) { // Clear parent: make this window top-level child.setParentWindow(null); return; } const browserWindow = BrowserWindow.fromId(parent.id); child.setParentWindow(browserWindow); }); socket.on("browserWindowGetParentWindow", (id) => { const browserWindow = getWindowById(id).getParentWindow(); electronSocket.emit( "browserWindow-getParentWindow-completed", browserWindow.id, ); }); socket.on("browserWindowGetChildWindows", (id) => { const browserWindows = getWindowById(id).getChildWindows(); const ids = []; browserWindows.forEach((x) => { ids.push(x.id); }); electronSocket.emit("browserWindow-getChildWindows-completed", ids); }); socket.on("browserWindowSetAutoHideCursor", (id, autoHide) => { getWindowById(id).setAutoHideCursor(autoHide); }); socket.on("browserWindowSetVibrancy", (id, type) => { getWindowById(id).setVibrancy(type); }); socket.on("browserWindow-setBrowserView", (id, browserViewId) => { getWindowById(id).setBrowserView(browserViewMediateService(browserViewId)); }); function getWindowById(id: number): Electron.BrowserWindow { for (let index = 0; index < windows.length; index++) { const element = windows[index]; if (element.id === id) { return element; } } } }; ================================================ FILE: src/ElectronNET.Host/api/clipboard.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("clipboard-readText", (type) => { const text = electron_1.clipboard.readText(type); electronSocket.emit("clipboard-readText-completed", text); }); socket.on("clipboard-writeText", (text, type) => { electron_1.clipboard.writeText(text, type); }); socket.on("clipboard-readHTML", (type) => { const content = electron_1.clipboard.readHTML(type); electronSocket.emit("clipboard-readHTML-completed", content); }); socket.on("clipboard-writeHTML", (markup, type) => { electron_1.clipboard.writeHTML(markup, type); }); socket.on("clipboard-readRTF", (type) => { const content = electron_1.clipboard.readRTF(type); electronSocket.emit("clipboard-readRTF-completed", content); }); socket.on("clipboard-writeRTF", (text, type) => { electron_1.clipboard.writeHTML(text, type); }); socket.on("clipboard-readBookmark", () => { const bookmark = electron_1.clipboard.readBookmark(); electronSocket.emit("clipboard-readBookmark-completed", bookmark); }); socket.on("clipboard-writeBookmark", (title, url, type) => { electron_1.clipboard.writeBookmark(title, url, type); }); socket.on("clipboard-readFindText", () => { const content = electron_1.clipboard.readFindText(); electronSocket.emit("clipboard-readFindText-completed", content); }); socket.on("clipboard-writeFindText", (text) => { electron_1.clipboard.writeFindText(text); }); socket.on("clipboard-clear", (type) => { electron_1.clipboard.clear(type); }); socket.on("clipboard-availableFormats", (type) => { const formats = electron_1.clipboard.availableFormats(type); electronSocket.emit("clipboard-availableFormats-completed", formats); }); socket.on("clipboard-write", (data, type) => { electron_1.clipboard.write(data, type); }); socket.on("clipboard-readImage", (type) => { const image = electron_1.clipboard.readImage(type); electronSocket.emit("clipboard-readImage-completed", { 1: image.toPNG().toString("base64"), }); }); socket.on("clipboard-writeImage", (data, type) => { const dataContent = JSON.parse(data); const image = electron_1.nativeImage.createEmpty(); // tslint:disable-next-line: forin for (const key in dataContent) { const scaleFactor = key; const bytes = data[key]; const buffer = Buffer.from(bytes, "base64"); image.addRepresentation({ scaleFactor: +scaleFactor, buffer: buffer }); } electron_1.clipboard.writeImage(image, type); }); }; //# sourceMappingURL=clipboard.js.map ================================================ FILE: src/ElectronNET.Host/api/clipboard.ts ================================================ import type { Socket } from "net"; import { clipboard, nativeImage } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("clipboard-readText", (type) => { const text = clipboard.readText(type); electronSocket.emit("clipboard-readText-completed", text); }); socket.on("clipboard-writeText", (text, type) => { clipboard.writeText(text, type); }); socket.on("clipboard-readHTML", (type) => { const content = clipboard.readHTML(type); electronSocket.emit("clipboard-readHTML-completed", content); }); socket.on("clipboard-writeHTML", (markup, type) => { clipboard.writeHTML(markup, type); }); socket.on("clipboard-readRTF", (type) => { const content = clipboard.readRTF(type); electronSocket.emit("clipboard-readRTF-completed", content); }); socket.on("clipboard-writeRTF", (text, type) => { clipboard.writeHTML(text, type); }); socket.on("clipboard-readBookmark", () => { const bookmark = clipboard.readBookmark(); electronSocket.emit("clipboard-readBookmark-completed", bookmark); }); socket.on("clipboard-writeBookmark", (title, url, type) => { clipboard.writeBookmark(title, url, type); }); socket.on("clipboard-readFindText", () => { const content = clipboard.readFindText(); electronSocket.emit("clipboard-readFindText-completed", content); }); socket.on("clipboard-writeFindText", (text) => { clipboard.writeFindText(text); }); socket.on("clipboard-clear", (type) => { clipboard.clear(type); }); socket.on("clipboard-availableFormats", (type) => { const formats = clipboard.availableFormats(type); electronSocket.emit("clipboard-availableFormats-completed", formats); }); socket.on("clipboard-write", (data, type) => { clipboard.write(data, type); }); socket.on("clipboard-readImage", (type) => { const image = clipboard.readImage(type); electronSocket.emit("clipboard-readImage-completed", { 1: image.toPNG().toString("base64"), }); }); socket.on("clipboard-writeImage", (data, type) => { const dataContent = JSON.parse(data); const image = nativeImage.createEmpty(); // tslint:disable-next-line: forin for (const key in dataContent) { const scaleFactor = key; const bytes = data[key]; const buffer = Buffer.from(bytes, "base64"); image.addRepresentation({ scaleFactor: +scaleFactor, buffer: buffer }); } clipboard.writeImage(image, type); }); }; ================================================ FILE: src/ElectronNET.Host/api/commandLine.js ================================================ "use strict"; let electronSocket; module.exports = (socket, app) => { electronSocket = socket; socket.on("appCommandLineAppendSwitch", (the_switch, value) => { app.commandLine.appendSwitch(the_switch, value); }); socket.on("appCommandLineAppendArgument", (value) => { app.commandLine.appendArgument(value); }); socket.on("appCommandLineHasSwitch", (value) => { const hasSwitch = app.commandLine.hasSwitch(value); electronSocket.emit("appCommandLineHasSwitchCompleted", hasSwitch); }); socket.on("appCommandLineGetSwitchValue", (the_switch) => { const value = app.commandLine.getSwitchValue(the_switch); electronSocket.emit("appCommandLineGetSwitchValueCompleted", value); }); }; //# sourceMappingURL=commandLine.js.map ================================================ FILE: src/ElectronNET.Host/api/commandLine.ts ================================================ import type { Socket } from "net"; let electronSocket: Socket; export = (socket: Socket, app: Electron.App) => { electronSocket = socket; socket.on( "appCommandLineAppendSwitch", (the_switch: string, value: string) => { app.commandLine.appendSwitch(the_switch, value); }, ); socket.on("appCommandLineAppendArgument", (value: string) => { app.commandLine.appendArgument(value); }); socket.on("appCommandLineHasSwitch", (value: string) => { const hasSwitch = app.commandLine.hasSwitch(value); electronSocket.emit("appCommandLineHasSwitchCompleted", hasSwitch); }); socket.on("appCommandLineGetSwitchValue", (the_switch: string) => { const value = app.commandLine.getSwitchValue(the_switch); electronSocket.emit("appCommandLineGetSwitchValueCompleted", value); }); }; ================================================ FILE: src/ElectronNET.Host/api/dialog.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("showMessageBox", async (browserWindow, options, guid) => { if ("id" in browserWindow) { const window = electron_1.BrowserWindow.fromId(browserWindow.id); const messageBoxReturnValue = await electron_1.dialog.showMessageBox(window, options); electronSocket.emit("showMessageBoxComplete" + guid, [ messageBoxReturnValue.response, messageBoxReturnValue.checkboxChecked, ]); } else { const id = guid || options; const messageBoxReturnValue = await electron_1.dialog.showMessageBox(browserWindow); electronSocket.emit("showMessageBoxComplete" + id, [ messageBoxReturnValue.response, messageBoxReturnValue.checkboxChecked, ]); } }); socket.on("showOpenDialog", async (browserWindow, options, guid) => { const window = electron_1.BrowserWindow.fromId(browserWindow.id); const openDialogReturnValue = await electron_1.dialog.showOpenDialog(window, options); electronSocket.emit("showOpenDialogComplete" + guid, openDialogReturnValue.filePaths || []); }); socket.on("showSaveDialog", async (browserWindow, options, guid) => { const window = electron_1.BrowserWindow.fromId(browserWindow.id); const saveDialogReturnValue = await electron_1.dialog.showSaveDialog(window, options); electronSocket.emit("showSaveDialogComplete" + guid, saveDialogReturnValue.filePath || ""); }); socket.on("showErrorBox", (title, content) => { electron_1.dialog.showErrorBox(title, content); }); socket.on("showCertificateTrustDialog", async (browserWindow, options, guid) => { const window = electron_1.BrowserWindow.fromId(browserWindow.id); await electron_1.dialog.showCertificateTrustDialog(window, options); electronSocket.emit("showCertificateTrustDialogComplete" + guid); }); }; //# sourceMappingURL=dialog.js.map ================================================ FILE: src/ElectronNET.Host/api/dialog.ts ================================================ import type { Socket } from "net"; import { BrowserWindow, dialog } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("showMessageBox", async (browserWindow, options, guid) => { if ("id" in browserWindow) { const window = BrowserWindow.fromId(browserWindow.id); const messageBoxReturnValue = await dialog.showMessageBox( window, options, ); electronSocket.emit("showMessageBoxComplete" + guid, [ messageBoxReturnValue.response, messageBoxReturnValue.checkboxChecked, ]); } else { const id = guid || options; const messageBoxReturnValue = await dialog.showMessageBox(browserWindow); electronSocket.emit("showMessageBoxComplete" + id, [ messageBoxReturnValue.response, messageBoxReturnValue.checkboxChecked, ]); } }); socket.on("showOpenDialog", async (browserWindow, options, guid) => { const window = BrowserWindow.fromId(browserWindow.id); const openDialogReturnValue = await dialog.showOpenDialog(window, options); electronSocket.emit( "showOpenDialogComplete" + guid, openDialogReturnValue.filePaths || [], ); }); socket.on("showSaveDialog", async (browserWindow, options, guid) => { const window = BrowserWindow.fromId(browserWindow.id); const saveDialogReturnValue = await dialog.showSaveDialog(window, options); electronSocket.emit( "showSaveDialogComplete" + guid, saveDialogReturnValue.filePath || "", ); }); socket.on("showErrorBox", (title, content) => { dialog.showErrorBox(title, content); }); socket.on( "showCertificateTrustDialog", async (browserWindow, options, guid) => { const window = BrowserWindow.fromId(browserWindow.id); await dialog.showCertificateTrustDialog(window, options); electronSocket.emit("showCertificateTrustDialogComplete" + guid); }, ); }; ================================================ FILE: src/ElectronNET.Host/api/dock.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("dock-bounce", (type) => { const id = electron_1.app.dock.bounce(type); electronSocket.emit("dock-bounce-completed", id); }); socket.on("dock-cancelBounce", (id) => { electron_1.app.dock.cancelBounce(id); }); socket.on("dock-downloadFinished", (filePath) => { electron_1.app.dock.downloadFinished(filePath); }); socket.on("dock-setBadge", (text) => { electron_1.app.dock.setBadge(text); }); socket.on("dock-getBadge", () => { const text = electron_1.app.dock.getBadge(); electronSocket.emit("dock-getBadge-completed", text); }); socket.on("dock-hide", () => { electron_1.app.dock.hide(); }); socket.on("dock-show", () => { electron_1.app.dock.show(); }); socket.on("dock-isVisible", () => { const isVisible = electron_1.app.dock.isVisible(); electronSocket.emit("dock-isVisible-completed", isVisible); }); socket.on("dock-setMenu", (menuItems) => { let menu = null; if (menuItems) { menu = electron_1.Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("dockMenuItemClicked", id); }); } electron_1.app.dock.setMenu(menu); }); // TODO: Menu (macOS) still to be implemented socket.on("dock-getMenu", () => { const menu = electron_1.app.dock.getMenu(); electronSocket.emit("dock-getMenu-completed", menu); }); socket.on("dock-setIcon", (image) => { electron_1.app.dock.setIcon(image); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; //# sourceMappingURL=dock.js.map ================================================ FILE: src/ElectronNET.Host/api/dock.ts ================================================ import type { Socket } from "net"; import { app, Menu } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("dock-bounce", (type) => { const id = app.dock.bounce(type); electronSocket.emit("dock-bounce-completed", id); }); socket.on("dock-cancelBounce", (id) => { app.dock.cancelBounce(id); }); socket.on("dock-downloadFinished", (filePath) => { app.dock.downloadFinished(filePath); }); socket.on("dock-setBadge", (text) => { app.dock.setBadge(text); }); socket.on("dock-getBadge", () => { const text = app.dock.getBadge(); electronSocket.emit("dock-getBadge-completed", text); }); socket.on("dock-hide", () => { app.dock.hide(); }); socket.on("dock-show", () => { app.dock.show(); }); socket.on("dock-isVisible", () => { const isVisible = app.dock.isVisible(); electronSocket.emit("dock-isVisible-completed", isVisible); }); socket.on("dock-setMenu", (menuItems) => { let menu = null; if (menuItems) { menu = Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("dockMenuItemClicked", id); }); } app.dock.setMenu(menu); }); // TODO: Menu (macOS) still to be implemented socket.on("dock-getMenu", () => { const menu = app.dock.getMenu(); electronSocket.emit("dock-getMenu-completed", menu); }); socket.on("dock-setIcon", (image) => { app.dock.setIcon(image); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; ================================================ FILE: src/ElectronNET.Host/api/globalShortcut.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("globalShortcut-register", (accelerator) => { electron_1.globalShortcut.register(accelerator, () => { electronSocket.emit("globalShortcut-pressed", accelerator); }); }); socket.on("globalShortcut-isRegistered", (accelerator) => { const isRegistered = electron_1.globalShortcut.isRegistered(accelerator); electronSocket.emit("globalShortcut-isRegisteredCompleted", isRegistered); }); socket.on("globalShortcut-unregister", (accelerator) => { electron_1.globalShortcut.unregister(accelerator); }); socket.on("globalShortcut-unregisterAll", () => { try { electron_1.globalShortcut.unregisterAll(); } catch (error) { } }); }; //# sourceMappingURL=globalShortcut.js.map ================================================ FILE: src/ElectronNET.Host/api/globalShortcut.ts ================================================ import type { Socket } from "net"; import { globalShortcut } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("globalShortcut-register", (accelerator) => { globalShortcut.register(accelerator, () => { electronSocket.emit("globalShortcut-pressed", accelerator); }); }); socket.on("globalShortcut-isRegistered", (accelerator) => { const isRegistered = globalShortcut.isRegistered(accelerator); electronSocket.emit("globalShortcut-isRegisteredCompleted", isRegistered); }); socket.on("globalShortcut-unregister", (accelerator) => { globalShortcut.unregister(accelerator); }); socket.on("globalShortcut-unregisterAll", () => { try { globalShortcut.unregisterAll(); } catch (error) {} }); }; ================================================ FILE: src/ElectronNET.Host/api/ipc.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("registerIpcMainChannel", (channel) => { electron_1.ipcMain.on(channel, (event, args) => { electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("registerSyncIpcMainChannel", (channel) => { electron_1.ipcMain.on(channel, (event, args) => { const x = socket; x.removeAllListeners(channel + "Sync"); socket.on(channel + "Sync", (result) => { event.returnValue = result; }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("registerOnceIpcMainChannel", (channel) => { electron_1.ipcMain.once(channel, (event, args) => { electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("removeAllListenersIpcMainChannel", (channel) => { electron_1.ipcMain.removeAllListeners(channel); }); socket.on("sendToIpcRenderer", (browserWindow, channel, data) => { const window = electron_1.BrowserWindow.fromId(browserWindow.id); if (window) { window.webContents.send(channel, ...data); } }); socket.on("sendToIpcRendererBrowserView", (id, channel, data) => { const browserViews = (global["browserViews"] = global["browserViews"] || []); let view = null; for (let i = 0; i < browserViews.length; i++) { if (browserViews[i]["id"] === id) { view = browserViews[i]; break; } } if (view) { view.webContents.send(channel, ...data); } }); socket.on("registerHandleIpcMainChannel", (channel) => { electron_1.ipcMain.handle(channel, (event, args) => { return new Promise((resolve, _reject) => { socket.removeAllListeners(channel + "Handle"); socket.on(channel + "Handle", (result) => { resolve(result); }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); }); socket.on("registerHandleOnceIpcMainChannel", (channel) => { electron_1.ipcMain.handleOnce(channel, (event, args) => { return new Promise((resolve, _reject) => { socket.removeAllListeners(channel + "HandleOnce"); socket.once(channel + "HandleOnce", (result) => { resolve(result); }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); }); socket.on("removeHandlerIpcMainChannel", (channel) => { electron_1.ipcMain.removeHandler(channel); }); // Integration helpers: programmatically click menu items from renderer tests electron_1.ipcMain.on("integration-click-application-menu", (event, id) => { try { const menu = electron_1.Menu.getApplicationMenu(); const mi = menu ? menu.getMenuItemById(id) : null; if (mi && typeof mi.click === "function") { const bw = electron_1.BrowserWindow.fromWebContents(event.sender); mi.click(undefined, bw, undefined); } } catch { /* ignore */ } }); electron_1.ipcMain.on("integration-click-context-menu", (event, windowId, id) => { try { const entries = global["contextMenuItems"] || []; const entry = entries.find((x) => x.browserWindowId === windowId); const mi = entry?.menu?.items?.find((i) => i.id === id); if (mi && typeof mi.click === "function") { const bw = electron_1.BrowserWindow.fromId(windowId); mi.click(undefined, bw, undefined); } } catch { /* ignore */ } }); }; //# sourceMappingURL=ipc.js.map ================================================ FILE: src/ElectronNET.Host/api/ipc.ts ================================================ import type { Socket } from "net"; import { ipcMain, BrowserWindow, BrowserView, Menu } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("registerIpcMainChannel", (channel) => { ipcMain.on(channel, (event, args) => { electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("registerSyncIpcMainChannel", (channel) => { ipcMain.on(channel, (event, args) => { const x = socket; x.removeAllListeners(channel + "Sync"); socket.on(channel + "Sync", (result) => { event.returnValue = result; }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("registerOnceIpcMainChannel", (channel) => { ipcMain.once(channel, (event, args) => { electronSocket.emit(channel, [event.preventDefault(), args]); }); }); socket.on("removeAllListenersIpcMainChannel", (channel) => { ipcMain.removeAllListeners(channel); }); socket.on("sendToIpcRenderer", (browserWindow, channel, data) => { const window = BrowserWindow.fromId(browserWindow.id); if (window) { window.webContents.send(channel, ...data); } }); socket.on("sendToIpcRendererBrowserView", (id, channel, data) => { const browserViews: BrowserView[] = (global["browserViews"] = global["browserViews"] || []) as BrowserView[]; let view: BrowserView = null; for (let i = 0; i < browserViews.length; i++) { if (browserViews[i]["id"] === id) { view = browserViews[i]; break; } } if (view) { view.webContents.send(channel, ...data); } }); socket.on("registerHandleIpcMainChannel", (channel) => { ipcMain.handle(channel, (event, args) => { return new Promise((resolve, _reject) => { socket.removeAllListeners(channel + "Handle"); socket.on(channel + "Handle", (result) => { resolve(result); }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); }); socket.on("registerHandleOnceIpcMainChannel", (channel) => { ipcMain.handleOnce(channel, (event, args) => { return new Promise((resolve, _reject) => { socket.removeAllListeners(channel + "HandleOnce"); socket.once(channel + "HandleOnce", (result) => { resolve(result); }); electronSocket.emit(channel, [event.preventDefault(), args]); }); }); }); socket.on("removeHandlerIpcMainChannel", (channel) => { ipcMain.removeHandler(channel); }); // Integration helpers: programmatically click menu items from renderer tests ipcMain.on("integration-click-application-menu", (event, id: string) => { try { const menu = Menu.getApplicationMenu(); const mi = menu ? menu.getMenuItemById(id) : null; if (mi && typeof (mi as any).click === "function") { const bw = BrowserWindow.fromWebContents(event.sender); (mi as any).click(undefined, bw, undefined); } } catch { /* ignore */ } }); ipcMain.on( "integration-click-context-menu", (event, windowId: number, id: string) => { try { const entries = (global as any)["contextMenuItems"] || []; const entry = entries.find((x: any) => x.browserWindowId === windowId); const mi = entry?.menu?.items?.find((i: any) => i.id === id); if (mi && typeof (mi as any).click === "function") { const bw = BrowserWindow.fromId(windowId); (mi as any).click(undefined, bw, undefined); } } catch { /* ignore */ } }, ); }; ================================================ FILE: src/ElectronNET.Host/api/menu.js ================================================ "use strict"; const electron_1 = require("electron"); const contextMenuItems = (global["contextMenuItems"] = global["contextMenuItems"] || []); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("menu-setContextMenu", (browserWindowId, menuItems) => { const menu = electron_1.Menu.buildFromTemplate(menuItems); addContextMenuItemClickConnector(menu.items, browserWindowId, (id, windowId) => { electronSocket.emit("contextMenuItemClicked", [id, windowId]); }); const index = contextMenuItems.findIndex((contextMenu) => contextMenu.browserWindowId === browserWindowId); const contextMenuItem = { menu: menu, browserWindowId: browserWindowId, }; if (index === -1) { contextMenuItems.push(contextMenuItem); } else { contextMenuItems[index] = contextMenuItem; } }); function addContextMenuItemClickConnector(menuItems, browserWindowId, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addContextMenuItemClickConnector(item.submenu.items, browserWindowId, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id, browserWindowId); }; } }); } socket.on("menu-contextMenuPopup", (browserWindowId) => { contextMenuItems.forEach((x) => { if (x.browserWindowId === browserWindowId) { const browserWindow = electron_1.BrowserWindow.fromId(browserWindowId); x.menu.popup(browserWindow); } }); }); socket.on("menu-setApplicationMenu", (menuItems) => { const menu = electron_1.Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("menuItemClicked", id); }); electron_1.Menu.setApplicationMenu(menu); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; //# sourceMappingURL=menu.js.map ================================================ FILE: src/ElectronNET.Host/api/menu.ts ================================================ import type { Socket } from "net"; import { Menu, BrowserWindow } from "electron"; const contextMenuItems = (global["contextMenuItems"] = global["contextMenuItems"] || []); let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("menu-setContextMenu", (browserWindowId, menuItems) => { const menu = Menu.buildFromTemplate(menuItems); addContextMenuItemClickConnector( menu.items, browserWindowId, (id, windowId) => { electronSocket.emit("contextMenuItemClicked", [id, windowId]); }, ); const index = contextMenuItems.findIndex( (contextMenu) => contextMenu.browserWindowId === browserWindowId, ); const contextMenuItem = { menu: menu, browserWindowId: browserWindowId, }; if (index === -1) { contextMenuItems.push(contextMenuItem); } else { contextMenuItems[index] = contextMenuItem; } }); function addContextMenuItemClickConnector( menuItems, browserWindowId, callback, ) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addContextMenuItemClickConnector( item.submenu.items, browserWindowId, callback, ); } if ("id" in item && item.id) { item.click = () => { callback(item.id, browserWindowId); }; } }); } socket.on("menu-contextMenuPopup", (browserWindowId) => { contextMenuItems.forEach((x) => { if (x.browserWindowId === browserWindowId) { const browserWindow = BrowserWindow.fromId(browserWindowId); x.menu.popup(browserWindow); } }); }); socket.on("menu-setApplicationMenu", (menuItems) => { const menu = Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("menuItemClicked", id); }); Menu.setApplicationMenu(menu); }); function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; ================================================ FILE: src/ElectronNET.Host/api/nativeTheme.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("nativeTheme-shouldUseDarkColors", () => { const shouldUseDarkColors = electron_1.nativeTheme.shouldUseDarkColors; electronSocket.emit("nativeTheme-shouldUseDarkColors-completed", shouldUseDarkColors); }); socket.on("nativeTheme-shouldUseHighContrastColors", () => { const shouldUseHighContrastColors = electron_1.nativeTheme.shouldUseHighContrastColors; electronSocket.emit("nativeTheme-shouldUseHighContrastColors-completed", shouldUseHighContrastColors); }); socket.on("nativeTheme-shouldUseInvertedColorScheme", () => { const shouldUseInvertedColorScheme = electron_1.nativeTheme.shouldUseInvertedColorScheme; electronSocket.emit("nativeTheme-shouldUseInvertedColorScheme-completed", shouldUseInvertedColorScheme); }); socket.on("nativeTheme-getThemeSource", () => { const themeSource = electron_1.nativeTheme.themeSource; electronSocket.emit("nativeTheme-getThemeSource-completed", themeSource); }); socket.on("nativeTheme-themeSource", (themeSource) => { electron_1.nativeTheme.themeSource = themeSource; }); socket.on("register-nativeTheme-updated", (id) => { electron_1.nativeTheme.on("updated", () => { electronSocket.emit("nativeTheme-updated" + id); }); }); }; //# sourceMappingURL=nativeTheme.js.map ================================================ FILE: src/ElectronNET.Host/api/nativeTheme.ts ================================================ import type { Socket } from "net"; import { nativeTheme } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("nativeTheme-shouldUseDarkColors", () => { const shouldUseDarkColors = nativeTheme.shouldUseDarkColors; electronSocket.emit( "nativeTheme-shouldUseDarkColors-completed", shouldUseDarkColors, ); }); socket.on("nativeTheme-shouldUseHighContrastColors", () => { const shouldUseHighContrastColors = nativeTheme.shouldUseHighContrastColors; electronSocket.emit( "nativeTheme-shouldUseHighContrastColors-completed", shouldUseHighContrastColors, ); }); socket.on("nativeTheme-shouldUseInvertedColorScheme", () => { const shouldUseInvertedColorScheme = nativeTheme.shouldUseInvertedColorScheme; electronSocket.emit( "nativeTheme-shouldUseInvertedColorScheme-completed", shouldUseInvertedColorScheme, ); }); socket.on("nativeTheme-getThemeSource", () => { const themeSource = nativeTheme.themeSource; electronSocket.emit("nativeTheme-getThemeSource-completed", themeSource); }); socket.on("nativeTheme-themeSource", (themeSource) => { nativeTheme.themeSource = themeSource; }); socket.on("register-nativeTheme-updated", (id) => { nativeTheme.on("updated", () => { electronSocket.emit("nativeTheme-updated" + id); }); }); }; ================================================ FILE: src/ElectronNET.Host/api/notification.js ================================================ "use strict"; const electron_1 = require("electron"); const notifications = (global["notifications"] = global["notifications"] || []); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("createNotification", (options) => { const notification = new electron_1.Notification(options); let haveEvent = false; if (options.showID) { haveEvent = true; notification.on("show", () => { electronSocket.emit("NotificationEventShow", options.showID); }); } if (options.clickID) { haveEvent = true; notification.on("click", () => { electronSocket.emit("NotificationEventClick", options.clickID); }); } if (options.closeID) { haveEvent = true; notification.on("close", () => { electronSocket.emit("NotificationEventClose", options.closeID); }); } if (options.replyID) { haveEvent = true; notification.on("reply", (event, value) => { electronSocket.emit("NotificationEventReply", [options.replyID, value]); }); } if (options.actionID) { haveEvent = true; notification.on("action", (event, value) => { electronSocket.emit("NotificationEventAction", [ options.actionID, value, ]); }); } if (haveEvent) { notifications.push(notification); } notification.show(); }); socket.on("notificationIsSupported", () => { const isSupported = electron_1.Notification.isSupported(); electronSocket.emit("notificationIsSupportedCompleted", isSupported); }); }; //# sourceMappingURL=notification.js.map ================================================ FILE: src/ElectronNET.Host/api/notification.ts ================================================ import type { Socket } from "net"; import { Notification } from "electron"; const notifications: Electron.Notification[] = (global["notifications"] = global["notifications"] || []) as Electron.Notification[]; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("createNotification", (options) => { const notification = new Notification(options); let haveEvent = false; if (options.showID) { haveEvent = true; notification.on("show", () => { electronSocket.emit("NotificationEventShow", options.showID); }); } if (options.clickID) { haveEvent = true; notification.on("click", () => { electronSocket.emit("NotificationEventClick", options.clickID); }); } if (options.closeID) { haveEvent = true; notification.on("close", () => { electronSocket.emit("NotificationEventClose", options.closeID); }); } if (options.replyID) { haveEvent = true; notification.on("reply", (event, value) => { electronSocket.emit("NotificationEventReply", [options.replyID, value]); }); } if (options.actionID) { haveEvent = true; notification.on("action", (event, value) => { electronSocket.emit("NotificationEventAction", [ options.actionID, value, ]); }); } if (haveEvent) { notifications.push(notification); } notification.show(); }); socket.on("notificationIsSupported", () => { const isSupported = Notification.isSupported(); electronSocket.emit("notificationIsSupportedCompleted", isSupported); }); }; ================================================ FILE: src/ElectronNET.Host/api/powerMonitor.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("register-powerMonitor-lock-screen", () => { electron_1.powerMonitor.on("lock-screen", () => { electronSocket.emit("powerMonitor-lock-screen"); }); }); socket.on("register-powerMonitor-unlock-screen", () => { electron_1.powerMonitor.on("unlock-screen", () => { electronSocket.emit("powerMonitor-unlock-screen"); }); }); socket.on("register-powerMonitor-suspend", () => { electron_1.powerMonitor.on("suspend", () => { electronSocket.emit("powerMonitor-suspend"); }); }); socket.on("register-powerMonitor-resume", () => { electron_1.powerMonitor.on("resume", () => { electronSocket.emit("powerMonitor-resume"); }); }); socket.on("register-powerMonitor-ac", () => { electron_1.powerMonitor.on("on-ac", () => { electronSocket.emit("powerMonitor-ac"); }); }); socket.on("register-powerMonitor-battery", () => { electron_1.powerMonitor.on("on-battery", () => { electronSocket.emit("powerMonitor-battery"); }); }); socket.on("register-powerMonitor-shutdown", () => { electron_1.powerMonitor.on("shutdown", () => { electronSocket.emit("powerMonitor-shutdown"); }); }); }; //# sourceMappingURL=powerMonitor.js.map ================================================ FILE: src/ElectronNET.Host/api/powerMonitor.ts ================================================ import type { Socket } from "net"; import { powerMonitor } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("register-powerMonitor-lock-screen", () => { powerMonitor.on("lock-screen", () => { electronSocket.emit("powerMonitor-lock-screen"); }); }); socket.on("register-powerMonitor-unlock-screen", () => { powerMonitor.on("unlock-screen", () => { electronSocket.emit("powerMonitor-unlock-screen"); }); }); socket.on("register-powerMonitor-suspend", () => { powerMonitor.on("suspend", () => { electronSocket.emit("powerMonitor-suspend"); }); }); socket.on("register-powerMonitor-resume", () => { powerMonitor.on("resume", () => { electronSocket.emit("powerMonitor-resume"); }); }); socket.on("register-powerMonitor-ac", () => { powerMonitor.on("on-ac", () => { electronSocket.emit("powerMonitor-ac"); }); }); socket.on("register-powerMonitor-battery", () => { powerMonitor.on("on-battery", () => { electronSocket.emit("powerMonitor-battery"); }); }); socket.on("register-powerMonitor-shutdown", () => { powerMonitor.on("shutdown", () => { electronSocket.emit("powerMonitor-shutdown"); }); }); }; ================================================ FILE: src/ElectronNET.Host/api/process.js ================================================ "use strict"; let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("process-execPath", () => { const value = process.execPath; electronSocket.emit("process-execPath-completed", value); }); socket.on("process-argv", () => { const value = process.argv; electronSocket.emit("process-argv-completed", value); }); socket.on("process-type", () => { const value = process.type; electronSocket.emit("process-type-completed", value); }); socket.on("process-versions", () => { const value = process.versions; electronSocket.emit("process-versions-completed", value); }); socket.on("process-defaultApp", () => { if (process.defaultApp === undefined) { electronSocket.emit("process-defaultApp-completed", false); return; } electronSocket.emit("process-defaultApp-completed", process.defaultApp); }); socket.on("process-isMainFrame", () => { if (process.isMainFrame === undefined) { electronSocket.emit("process-isMainFrame-completed", false); return; } electronSocket.emit("process-isMainFrame-completed", process.isMainFrame); }); socket.on("process-resourcesPath", () => { const value = process.resourcesPath; electronSocket.emit("process-resourcesPath-completed", value); }); socket.on("process-upTime", () => { let value = process.uptime(); if (value === undefined) { value = -1; } electronSocket.emit("process-upTime-completed", value); }); socket.on("process-pid", () => { if (process.pid === undefined) { electronSocket.emit("process-pid-completed", -1); return; } electronSocket.emit("process-pid-completed", process.pid); }); socket.on("process-arch", () => { const value = process.arch; electronSocket.emit("process-arch-completed", value); }); socket.on("process-platform", () => { const value = process.platform; electronSocket.emit("process-platform-completed", value); }); }; //# sourceMappingURL=process.js.map ================================================ FILE: src/ElectronNET.Host/api/process.ts ================================================ import type { Socket } from "net"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("process-execPath", () => { const value = process.execPath; electronSocket.emit("process-execPath-completed", value); }); socket.on("process-argv", () => { const value = process.argv; electronSocket.emit("process-argv-completed", value); }); socket.on("process-type", () => { const value = process.type; electronSocket.emit("process-type-completed", value); }); socket.on("process-versions", () => { const value = process.versions; electronSocket.emit("process-versions-completed", value); }); socket.on("process-defaultApp", () => { if (process.defaultApp === undefined) { electronSocket.emit("process-defaultApp-completed", false); return; } electronSocket.emit("process-defaultApp-completed", process.defaultApp); }); socket.on("process-isMainFrame", () => { if (process.isMainFrame === undefined) { electronSocket.emit("process-isMainFrame-completed", false); return; } electronSocket.emit("process-isMainFrame-completed", process.isMainFrame); }); socket.on("process-resourcesPath", () => { const value = process.resourcesPath; electronSocket.emit("process-resourcesPath-completed", value); }); socket.on("process-upTime", () => { let value = process.uptime(); if (value === undefined) { value = -1; } electronSocket.emit("process-upTime-completed", value); }); socket.on("process-pid", () => { if (process.pid === undefined) { electronSocket.emit("process-pid-completed", -1); return; } electronSocket.emit("process-pid-completed", process.pid); }); socket.on("process-arch", () => { const value = process.arch; electronSocket.emit("process-arch-completed", value); }); socket.on("process-platform", () => { const value = process.platform; electronSocket.emit("process-platform-completed", value); }); }; ================================================ FILE: src/ElectronNET.Host/api/screen.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("register-screen-display-added", (id) => { electron_1.screen.on("display-added", (event, display) => { electronSocket.emit("screen-display-added" + id, display); }); }); socket.on("register-screen-display-removed", (id) => { electron_1.screen.on("display-removed", (event, display) => { electronSocket.emit("screen-display-removed" + id, display); }); }); socket.on("register-screen-display-metrics-changed", (id) => { electron_1.screen.on("display-metrics-changed", (event, display, changedMetrics) => { electronSocket.emit("screen-display-metrics-changed" + id, [ display, changedMetrics, ]); }); }); socket.on("screen-getCursorScreenPoint", () => { const point = electron_1.screen.getCursorScreenPoint(); electronSocket.emit("screen-getCursorScreenPoint-completed", point); }); socket.on("screen-getMenuBarWorkArea", () => { const height = electron_1.screen.getPrimaryDisplay().workArea; electronSocket.emit("screen-getMenuBarWorkArea-completed", height); }); socket.on("screen-getPrimaryDisplay", () => { const display = electron_1.screen.getPrimaryDisplay(); electronSocket.emit("screen-getPrimaryDisplay-completed", display); }); socket.on("screen-getAllDisplays", () => { const display = electron_1.screen.getAllDisplays(); electronSocket.emit("screen-getAllDisplays-completed", display); }); socket.on("screen-getDisplayNearestPoint", (point) => { const display = electron_1.screen.getDisplayNearestPoint(point); electronSocket.emit("screen-getDisplayNearestPoint-completed", display); }); socket.on("screen-getDisplayMatching", (rectangle) => { const display = electron_1.screen.getDisplayMatching(rectangle); electronSocket.emit("screen-getDisplayMatching-completed", display); }); }; //# sourceMappingURL=screen.js.map ================================================ FILE: src/ElectronNET.Host/api/screen.ts ================================================ import type { Socket } from "net"; import { screen } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("register-screen-display-added", (id) => { screen.on("display-added", (event, display) => { electronSocket.emit("screen-display-added" + id, display); }); }); socket.on("register-screen-display-removed", (id) => { screen.on("display-removed", (event, display) => { electronSocket.emit("screen-display-removed" + id, display); }); }); socket.on("register-screen-display-metrics-changed", (id) => { screen.on("display-metrics-changed", (event, display, changedMetrics) => { electronSocket.emit("screen-display-metrics-changed" + id, [ display, changedMetrics, ]); }); }); socket.on("screen-getCursorScreenPoint", () => { const point = screen.getCursorScreenPoint(); electronSocket.emit("screen-getCursorScreenPoint-completed", point); }); socket.on("screen-getMenuBarWorkArea", () => { const height = screen.getPrimaryDisplay().workArea; electronSocket.emit("screen-getMenuBarWorkArea-completed", height); }); socket.on("screen-getPrimaryDisplay", () => { const display = screen.getPrimaryDisplay(); electronSocket.emit("screen-getPrimaryDisplay-completed", display); }); socket.on("screen-getAllDisplays", () => { const display = screen.getAllDisplays(); electronSocket.emit("screen-getAllDisplays-completed", display); }); socket.on("screen-getDisplayNearestPoint", (point) => { const display = screen.getDisplayNearestPoint(point); electronSocket.emit("screen-getDisplayNearestPoint-completed", display); }); socket.on("screen-getDisplayMatching", (rectangle) => { const display = screen.getDisplayMatching(rectangle); electronSocket.emit("screen-getDisplayMatching-completed", display); }); }; ================================================ FILE: src/ElectronNET.Host/api/shell.js ================================================ "use strict"; const electron_1 = require("electron"); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("shell-showItemInFolder", (fullPath) => { electron_1.shell.showItemInFolder(fullPath); electronSocket.emit("shell-showItemInFolderCompleted"); }); socket.on("shell-openPath", async (path) => { const errorMessage = await electron_1.shell.openPath(path); electronSocket.emit("shell-openPathCompleted", errorMessage); }); socket.on("shell-openExternal", async (url, options) => { let result = ""; if (options) { await electron_1.shell.openExternal(url, options).catch((e) => { result = e.message; }); } else { await electron_1.shell.openExternal(url).catch((e) => { result = e.message; }); } electronSocket.emit("shell-openExternalCompleted", result); }); socket.on("shell-trashItem", async (fullPath, deleteOnFail) => { let success = false; try { await electron_1.shell.trashItem(fullPath); success = true; } catch (error) { success = false; } electronSocket.emit("shell-trashItem-completed", success); }); socket.on("shell-beep", () => { electron_1.shell.beep(); }); socket.on("shell-writeShortcutLink", (shortcutPath, operation, options) => { const success = electron_1.shell.writeShortcutLink(shortcutPath, operation, options); electronSocket.emit("shell-writeShortcutLinkCompleted", success); }); socket.on("shell-readShortcutLink", (shortcutPath) => { const shortcutDetails = electron_1.shell.readShortcutLink(shortcutPath); electronSocket.emit("shell-readShortcutLinkCompleted", shortcutDetails); }); }; //# sourceMappingURL=shell.js.map ================================================ FILE: src/ElectronNET.Host/api/shell.ts ================================================ import type { Socket } from "net"; import { shell } from "electron"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("shell-showItemInFolder", (fullPath) => { shell.showItemInFolder(fullPath); electronSocket.emit("shell-showItemInFolderCompleted"); }); socket.on("shell-openPath", async (path) => { const errorMessage = await shell.openPath(path); electronSocket.emit("shell-openPathCompleted", errorMessage); }); socket.on("shell-openExternal", async (url, options) => { let result = ""; if (options) { await shell.openExternal(url, options).catch((e) => { result = e.message; }); } else { await shell.openExternal(url).catch((e) => { result = e.message; }); } electronSocket.emit("shell-openExternalCompleted", result); }); socket.on("shell-trashItem", async (fullPath, deleteOnFail) => { let success = false; try { await shell.trashItem(fullPath); success = true; } catch (error) { success = false; } electronSocket.emit("shell-trashItem-completed", success); }); socket.on("shell-beep", () => { shell.beep(); }); socket.on("shell-writeShortcutLink", (shortcutPath, operation, options) => { const success = shell.writeShortcutLink(shortcutPath, operation, options); electronSocket.emit("shell-writeShortcutLinkCompleted", success); }); socket.on("shell-readShortcutLink", (shortcutPath) => { const shortcutDetails = shell.readShortcutLink(shortcutPath); electronSocket.emit("shell-readShortcutLinkCompleted", shortcutDetails); }); }; ================================================ FILE: src/ElectronNET.Host/api/tray.js ================================================ "use strict"; const electron_1 = require("electron"); let tray = (global["$tray"] = global["tray"] || { value: null, }); let electronSocket; module.exports = (socket) => { electronSocket = socket; socket.on("register-tray-click", (id) => { if (tray.value) { tray.value.on("click", (event, bounds) => { electronSocket.emit("tray-click" + id, [ event.__proto__, bounds, ]); }); } }); socket.on("register-tray-right-click", (id) => { if (tray.value) { tray.value.on("right-click", (event, bounds) => { electronSocket.emit("tray-right-click" + id, [ event.__proto__, bounds, ]); }); } }); socket.on("register-tray-double-click", (id) => { if (tray.value) { tray.value.on("double-click", (event, bounds) => { electronSocket.emit("tray-double-click" + id, [ event.__proto__, bounds, ]); }); } }); socket.on("register-tray-balloon-show", (id) => { if (tray.value) { tray.value.on("balloon-show", () => { electronSocket.emit("tray-balloon-show" + id); }); } }); socket.on("register-tray-balloon-click", (id) => { if (tray.value) { tray.value.on("balloon-click", () => { electronSocket.emit("tray-balloon-click" + id); }); } }); socket.on("register-tray-balloon-closed", (id) => { if (tray.value) { tray.value.on("balloon-closed", () => { electronSocket.emit("tray-balloon-closed" + id); }); } }); socket.on("create-tray", (image, menuItems) => { const trayIcon = electron_1.nativeImage.createFromPath(image); tray.value = new electron_1.Tray(trayIcon); if (menuItems) { applyContextMenu(menuItems); } }); socket.on("tray-destroy", () => { if (tray.value) { tray.value.destroy(); } }); socket.on("set-contextMenu", (menuItems) => { if (menuItems && tray.value) { applyContextMenu(menuItems); } }); socket.on("tray-setImage", (image) => { if (tray.value) { tray.value.setImage(image); } }); socket.on("tray-setPressedImage", (image) => { if (tray.value) { const img = electron_1.nativeImage.createFromPath(image); tray.value.setPressedImage(img); } }); socket.on("tray-setToolTip", (toolTip) => { if (tray.value) { tray.value.setToolTip(toolTip); } }); socket.on("tray-setTitle", (title) => { if (tray.value) { tray.value.setTitle(title); } }); socket.on("tray-displayBalloon", (options) => { if (tray.value) { tray.value.displayBalloon(options); } }); socket.on("tray-isDestroyed", () => { if (tray.value) { const isDestroyed = tray.value.isDestroyed(); electronSocket.emit("tray-isDestroyedCompleted", isDestroyed); } }); socket.on("register-tray-on-event", (eventName, listenerName) => { if (tray.value) { tray.value.on(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); } }); socket.on("register-tray-once-event", (eventName, listenerName) => { if (tray.value) { tray.value.once(eventName, (...args) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); } }); function applyContextMenu(menuItems) { const menu = electron_1.Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("trayMenuItemClicked", id); }); tray.value.setContextMenu(menu); } function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; //# sourceMappingURL=tray.js.map ================================================ FILE: src/ElectronNET.Host/api/tray.ts ================================================ import type { Socket } from "net"; import { Menu, Tray, nativeImage } from "electron"; let tray: { value: Electron.Tray } = (global["$tray"] = global["tray"] || { value: null, }); let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; socket.on("register-tray-click", (id) => { if (tray.value) { tray.value.on("click", (event, bounds) => { electronSocket.emit("tray-click" + id, [ (event).__proto__, bounds, ]); }); } }); socket.on("register-tray-right-click", (id) => { if (tray.value) { tray.value.on("right-click", (event, bounds) => { electronSocket.emit("tray-right-click" + id, [ (event).__proto__, bounds, ]); }); } }); socket.on("register-tray-double-click", (id) => { if (tray.value) { tray.value.on("double-click", (event, bounds) => { electronSocket.emit("tray-double-click" + id, [ (event).__proto__, bounds, ]); }); } }); socket.on("register-tray-balloon-show", (id) => { if (tray.value) { tray.value.on("balloon-show", () => { electronSocket.emit("tray-balloon-show" + id); }); } }); socket.on("register-tray-balloon-click", (id) => { if (tray.value) { tray.value.on("balloon-click", () => { electronSocket.emit("tray-balloon-click" + id); }); } }); socket.on("register-tray-balloon-closed", (id) => { if (tray.value) { tray.value.on("balloon-closed", () => { electronSocket.emit("tray-balloon-closed" + id); }); } }); socket.on("create-tray", (image, menuItems) => { const trayIcon = nativeImage.createFromPath(image); tray.value = new Tray(trayIcon); if (menuItems) { applyContextMenu(menuItems); } }); socket.on("tray-destroy", () => { if (tray.value) { tray.value.destroy(); } }); socket.on("set-contextMenu", (menuItems) => { if (menuItems && tray.value) { applyContextMenu(menuItems); } }); socket.on("tray-setImage", (image) => { if (tray.value) { tray.value.setImage(image); } }); socket.on("tray-setPressedImage", (image) => { if (tray.value) { const img = nativeImage.createFromPath(image); tray.value.setPressedImage(img); } }); socket.on("tray-setToolTip", (toolTip) => { if (tray.value) { tray.value.setToolTip(toolTip); } }); socket.on("tray-setTitle", (title) => { if (tray.value) { tray.value.setTitle(title); } }); socket.on("tray-displayBalloon", (options) => { if (tray.value) { tray.value.displayBalloon(options); } }); socket.on("tray-isDestroyed", () => { if (tray.value) { const isDestroyed = tray.value.isDestroyed(); electronSocket.emit("tray-isDestroyedCompleted", isDestroyed); } }); socket.on("register-tray-on-event", (eventName, listenerName) => { if (tray.value) { tray.value.on(eventName, (...args: any[]) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); } }); socket.on("register-tray-once-event", (eventName, listenerName) => { if (tray.value) { tray.value.once(eventName, (...args: any[]) => { if (args.length > 1) { electronSocket.emit(listenerName, args[1]); } else { electronSocket.emit(listenerName); } }); } }); function applyContextMenu(menuItems) { const menu = Menu.buildFromTemplate(menuItems); addMenuItemClickConnector(menu.items, (id) => { electronSocket.emit("trayMenuItemClicked", id); }); tray.value.setContextMenu(menu); } function addMenuItemClickConnector(menuItems, callback) { menuItems.forEach((item) => { if (item.submenu && item.submenu.items.length > 0) { addMenuItemClickConnector(item.submenu.items, callback); } if ("id" in item && item.id) { item.click = () => { callback(item.id); }; } }); } }; ================================================ FILE: src/ElectronNET.Host/api/webContents.js ================================================ "use strict"; var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) { if (k2 === undefined) k2 = k; var desc = Object.getOwnPropertyDescriptor(m, k); if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) { desc = { enumerable: true, get: function() { return m[k]; } }; } Object.defineProperty(o, k2, desc); }) : (function(o, m, k, k2) { if (k2 === undefined) k2 = k; o[k2] = m[k]; })); var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) { Object.defineProperty(o, "default", { enumerable: true, value: v }); }) : function(o, v) { o["default"] = v; }); var __importStar = (this && this.__importStar) || (function () { var ownKeys = function(o) { ownKeys = Object.getOwnPropertyNames || function (o) { var ar = []; for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k; return ar; }; return ownKeys(o); }; return function (mod) { if (mod && mod.__esModule) return mod; var result = {}; if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]); __setModuleDefault(result, mod); return result; }; })(); const fs = __importStar(require("fs")); const electron_1 = require("electron"); const browserView_1 = require("./browserView"); let electronSocket; module.exports = (socket) => { electronSocket = socket; // The crashed event has been removed in Electron 29 socket.on("register-webContents-crashed", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("crashed"); // @ts-expect-error No overload matches this call browserWindow.webContents.on("crashed", (event, killed) => { electronSocket.emit("webContents-crashed" + id, killed); }); }); socket.on("register-webContents-didFinishLoad", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-finish-load"); browserWindow.webContents.on("did-finish-load", () => { electronSocket.emit("webContents-didFinishLoad" + id); }); }); socket.on("register-webContents-didStartNavigation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-start-navigation"); browserWindow.webContents.on("did-start-navigation", (_, url) => { electronSocket.emit("webContents-didStartNavigation" + id, url); }); }); socket.on("register-webContents-didNavigate", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-navigate"); browserWindow.webContents.on("did-navigate", (_, url, httpResponseCode) => { electronSocket.emit("webContents-didNavigate" + id, { url, httpResponseCode, }); }); }); socket.on("register-webContents-willRedirect", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("will-redirect"); browserWindow.webContents.on("will-redirect", (_, url) => { electronSocket.emit("webContents-willRedirect" + id, url); }); }); socket.on("register-webContents-didFailLoad", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-fail-load"); browserWindow.webContents.on("did-fail-load", (_, errorCode, validatedUrl) => { electronSocket.emit("webContents-didFailLoad" + id, { errorCode, validatedUrl, }); }); }); socket.on("register-webContents-didRedirectNavigation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-redirect-navigation"); browserWindow.webContents.on("did-redirect-navigation", (_, url) => { electronSocket.emit("webContents-didRedirectNavigation" + id, url); }); }); socket.on("register-webContents-input-event", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("input-event"); browserWindow.webContents.on("input-event", (_, eventArgs) => { if (eventArgs.type !== "char") { electronSocket.emit("webContents-input-event" + id, eventArgs); } }); }); socket.on("register-webContents-domReady", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("dom-ready"); browserWindow.webContents.on("dom-ready", () => { electronSocket.emit("webContents-domReady" + id); }); }); socket.on("webContents-openDevTools", (id, options) => { if (options) { getWindowById(id).webContents.openDevTools(options); } else { getWindowById(id).webContents.openDevTools(); } }); socket.on("webContents-getPrinters", async (id) => { const printers = await getWindowById(id).webContents.getPrintersAsync(); electronSocket.emit("webContents-getPrinters-completed", printers); }); socket.on("webContents-print", async (id, options = {}) => { await getWindowById(id).webContents.print(options); electronSocket.emit("webContents-print-completed", true); }); socket.on("webContents-printToPDF", async (id, options = {}, path) => { const buffer = await getWindowById(id).webContents.printToPDF(options); fs.writeFile(path, buffer, (error) => { if (error) { electronSocket.emit("webContents-printToPDF-completed", false); } else { electronSocket.emit("webContents-printToPDF-completed", true); } }); }); socket.on("webContents-executeJavaScript", async (id, code, userGesture = false) => { const result = await getWindowById(id).webContents.executeJavaScript(code, userGesture); electronSocket.emit("webContents-executeJavaScript-completed", result); }); socket.on("webContents-getUrl", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-getUrl" + id, browserWindow.webContents.getURL()); }); socket.on("webContents-session-allowNTLMCredentialsForDomains", (id, domains) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.allowNTLMCredentialsForDomains(domains); }); socket.on("webContents-session-clearAuthCache", async (...args) => { // Overload support: (id, guid) OR (id, options, guid) const browserWindow = getWindowById(args[0]); let guid; if (args.length === 2) { // No options guid = args[1]; await browserWindow.webContents.session.clearAuthCache(); } else if (args.length === 3) { const options = args[1]; guid = args[2]; try { // @ts-ignore await browserWindow.webContents.session.clearAuthCache(options); } catch { // Fallback to clearing without options if Electron version rejects custom options await browserWindow.webContents.session.clearAuthCache(); } } else { return; // invalid invocation } electronSocket.emit("webContents-session-clearAuthCache-completed" + guid); }); socket.on("webContents-session-clearCache", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearCache(); electronSocket.emit("webContents-session-clearCache-completed" + guid); }); socket.on("webContents-session-clearHostResolverCache", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearHostResolverCache(); electronSocket.emit("webContents-session-clearHostResolverCache-completed" + guid); }); socket.on("webContents-session-clearStorageData", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearStorageData({}); electronSocket.emit("webContents-session-clearStorageData-completed" + guid); }); socket.on("webContents-session-clearStorageData-options", async (id, options, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearStorageData(options); electronSocket.emit("webContents-session-clearStorageData-options-completed" + guid); }); socket.on("webContents-session-createInterruptedDownload", (id, options) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.createInterruptedDownload(options); }); socket.on("webContents-session-disableNetworkEmulation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.disableNetworkEmulation(); }); socket.on("webContents-session-enableNetworkEmulation", (id, options) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.enableNetworkEmulation(options); }); socket.on("webContents-session-flushStorageData", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.flushStorageData(); }); socket.on("webContents-session-getBlobData", async (id, identifier, guid) => { const browserWindow = getWindowById(id); const buffer = await browserWindow.webContents.session.getBlobData(identifier); electronSocket.emit("webContents-session-getBlobData-completed" + guid, buffer.buffer); }); socket.on("webContents-session-getCacheSize", async (id, guid) => { const browserWindow = getWindowById(id); const size = await browserWindow.webContents.session.getCacheSize(); electronSocket.emit("webContents-session-getCacheSize-completed" + guid, size); }); socket.on("webContents-session-getPreloads", (id, guid) => { const browserWindow = getWindowById(id); const preloads = browserWindow.webContents.session.getPreloads(); electronSocket.emit("webContents-session-getPreloads-completed" + guid, preloads); }); socket.on("webContents-session-getUserAgent", (id, guid) => { const browserWindow = getWindowById(id); const userAgent = browserWindow.webContents.session.getUserAgent(); electronSocket.emit("webContents-session-getUserAgent-completed" + guid, userAgent); }); socket.on("webContents-session-resolveProxy", async (id, url, guid) => { const browserWindow = getWindowById(id); const proxy = await browserWindow.webContents.session.resolveProxy(url); electronSocket.emit("webContents-session-resolveProxy-completed" + guid, proxy); }); socket.on("webContents-session-setDownloadPath", (id, path) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setDownloadPath(path); }); socket.on("webContents-session-setPreloads", (id, preloads) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setPreloads(preloads); }); socket.on("webContents-session-setProxy", async (id, configuration, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.setProxy(configuration); electronSocket.emit("webContents-session-setProxy-completed" + guid); }); socket.on("webContents-session-setUserAgent", (id, userAgent, acceptLanguages) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setUserAgent(userAgent, acceptLanguages); }); socket.on("register-webContents-session-webRequest-onBeforeRequest", (id, filter) => { const browserWindow = getWindowById(id); const session = browserWindow.webContents.session; session.webRequest.onBeforeRequest(filter, (details, callback) => { socket.emit(`webContents-session-webRequest-onBeforeRequest${id}`, details); // Listen for a response from C# to continue the request electronSocket.once(`webContents-session-webRequest-onBeforeRequest-response${id}`, (response) => { callback(response); }); }); }); socket.on("register-webContents-session-cookies-changed", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.cookies.removeAllListeners("changed"); browserWindow.webContents.session.cookies.on("changed", (event, cookie, cause, removed) => { electronSocket.emit("webContents-session-cookies-changed" + id, [ cookie, cause, removed, ]); }); }); socket.on("webContents-session-cookies-get", async (id, filter, guid) => { const browserWindow = getWindowById(id); const cookies = await browserWindow.webContents.session.cookies.get(filter); electronSocket.emit("webContents-session-cookies-get-completed" + guid, cookies); }); socket.on("webContents-session-cookies-set", async (id, details, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.set(details); electronSocket.emit("webContents-session-cookies-set-completed" + guid); }); socket.on("webContents-session-cookies-remove", async (id, url, name, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.remove(url, name); electronSocket.emit("webContents-session-cookies-remove-completed" + guid); }); socket.on("webContents-session-cookies-flushStore", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.flushStore(); electronSocket.emit("webContents-session-cookies-flushStore-completed" + guid); }); socket.on("webContents-loadURL", (id, url, options) => { const browserWindow = getWindowById(id); browserWindow.webContents .loadURL(url, options) .then(() => { electronSocket.emit("webContents-loadURL-complete" + id); }) .catch((error) => { console.error(error); electronSocket.emit("webContents-loadURL-error" + id, error); }); }); socket.on("webContents-insertCSS", (id, isBrowserWindow, path) => { if (isBrowserWindow) { const browserWindow = getWindowById(id); if (browserWindow) { browserWindow.webContents.insertCSS(fs.readFileSync(path, "utf8")); } } else { const browserViews = (global["browserViews"] = global["browserViews"] || []); let view = null; for (let i = 0; i < browserViews.length; i++) { if (browserViews[i]["id"] + 1000 === id) { view = browserViews[i]; break; } } if (view) { view.webContents.insertCSS(fs.readFileSync(path, "utf8")); } } }); socket.on("webContents-session-getAllExtensions", (id) => { const browserWindow = getWindowById(id); const extensionsList = browserWindow.webContents.session.getAllExtensions(); const chromeExtensionInfo = []; Object.keys(extensionsList).forEach((key) => { chromeExtensionInfo.push(extensionsList[key]); }); electronSocket.emit("webContents-session-getAllExtensions-completed", chromeExtensionInfo); }); socket.on("webContents-session-removeExtension", (id, name) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.removeExtension(name); }); socket.on("webContents-session-loadExtension", async (id, path, allowFileAccess = false) => { const browserWindow = getWindowById(id); const extension = await browserWindow.webContents.session.loadExtension(path, { allowFileAccess: allowFileAccess }); electronSocket.emit("webContents-session-loadExtension-completed", extension); }); socket.on("webContents-getZoomFactor", (id) => { const browserWindow = getWindowById(id); const text = browserWindow.webContents.getZoomFactor(); electronSocket.emit("webContents-getZoomFactor-completed", text); }); socket.on("webContents-setZoomFactor", (id, factor) => { const browserWindow = getWindowById(id); browserWindow.webContents.setZoomFactor(factor); }); socket.on("webContents-getZoomLevel", (id) => { const browserWindow = getWindowById(id); const content = browserWindow.webContents.getZoomLevel(); electronSocket.emit("webContents-getZoomLevel-completed", content); }); socket.on("webContents-setZoomLevel", (id, level) => { const browserWindow = getWindowById(id); browserWindow.webContents.setZoomLevel(level); }); socket.on("webContents-setVisualZoomLevelLimits", async (id, minimumLevel, maximumLevel) => { const browserWindow = getWindowById(id); await browserWindow.webContents.setVisualZoomLevelLimits(minimumLevel, maximumLevel); electronSocket.emit("webContents-setVisualZoomLevelLimits-completed"); }); socket.on("webContents-toggleDevTools", (id) => { getWindowById(id).webContents.toggleDevTools(); }); socket.on("webContents-closeDevTools", (id) => { getWindowById(id).webContents.closeDevTools(); }); socket.on("webContents-isDevToolsOpened", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-isDevToolsOpened-completed", browserWindow.webContents.isDevToolsOpened()); }); socket.on("webContents-isDevToolsFocused", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-isDevToolsFocused-completed", browserWindow.webContents.isDevToolsFocused()); }); socket.on("webContents-setAudioMuted", (id, muted) => { getWindowById(id).webContents.setAudioMuted(muted); }); socket.on("webContents-isAudioMuted", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-isAudioMuted-completed", browserWindow.webContents.isAudioMuted()); }); socket.on("webContents-isCurrentlyAudible", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-isCurrentlyAudible-completed", browserWindow.webContents.isCurrentlyAudible()); }); socket.on("webContents-getUserAgent", function (id) { const browserWindow = getWindowById(id); electronSocket.emit("webContents-getUserAgent-completed", browserWindow.webContents.getUserAgent()); }); socket.on("webContents-setUserAgent", (id, userAgent) => { getWindowById(id).webContents.setUserAgent(userAgent); }); function getWindowById(id) { if (id >= 1000) { return (0, browserView_1.browserViewMediateService)(id - 1000); } return electron_1.BrowserWindow.fromId(id); } }; //# sourceMappingURL=webContents.js.map ================================================ FILE: src/ElectronNET.Host/api/webContents.ts ================================================ import * as fs from "fs"; import type { Socket } from "net"; import { BrowserWindow, BrowserView } from "electron"; import { browserViewMediateService } from "./browserView"; let electronSocket: Socket; export = (socket: Socket) => { electronSocket = socket; // The crashed event has been removed in Electron 29 socket.on("register-webContents-crashed", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("crashed"); // @ts-expect-error No overload matches this call browserWindow.webContents.on("crashed", (event, killed) => { electronSocket.emit("webContents-crashed" + id, killed); }); }); socket.on("register-webContents-didFinishLoad", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-finish-load"); browserWindow.webContents.on("did-finish-load", () => { electronSocket.emit("webContents-didFinishLoad" + id); }); }); socket.on("register-webContents-didStartNavigation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-start-navigation"); browserWindow.webContents.on("did-start-navigation", (_, url) => { electronSocket.emit("webContents-didStartNavigation" + id, url); }); }); socket.on("register-webContents-didNavigate", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-navigate"); browserWindow.webContents.on("did-navigate", (_, url, httpResponseCode) => { electronSocket.emit("webContents-didNavigate" + id, { url, httpResponseCode, }); }); }); socket.on("register-webContents-willRedirect", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("will-redirect"); browserWindow.webContents.on("will-redirect", (_, url) => { electronSocket.emit("webContents-willRedirect" + id, url); }); }); socket.on("register-webContents-didFailLoad", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-fail-load"); browserWindow.webContents.on( "did-fail-load", (_, errorCode, validatedUrl) => { electronSocket.emit("webContents-didFailLoad" + id, { errorCode, validatedUrl, }); }, ); }); socket.on("register-webContents-didRedirectNavigation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("did-redirect-navigation"); browserWindow.webContents.on("did-redirect-navigation", (_, url) => { electronSocket.emit("webContents-didRedirectNavigation" + id, url); }); }); socket.on("register-webContents-input-event", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("input-event"); browserWindow.webContents.on("input-event", (_, eventArgs) => { if (eventArgs.type !== "char") { electronSocket.emit("webContents-input-event" + id, eventArgs); } }); }); socket.on("register-webContents-domReady", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.removeAllListeners("dom-ready"); browserWindow.webContents.on("dom-ready", () => { electronSocket.emit("webContents-domReady" + id); }); }); socket.on("webContents-openDevTools", (id, options) => { if (options) { getWindowById(id).webContents.openDevTools(options); } else { getWindowById(id).webContents.openDevTools(); } }); socket.on("webContents-getPrinters", async (id) => { const printers = await getWindowById(id).webContents.getPrintersAsync(); electronSocket.emit("webContents-getPrinters-completed", printers); }); socket.on("webContents-print", async (id, options = {}) => { await getWindowById(id).webContents.print(options); electronSocket.emit("webContents-print-completed", true); }); socket.on("webContents-printToPDF", async (id, options = {}, path) => { const buffer = await getWindowById(id).webContents.printToPDF(options); fs.writeFile(path, buffer, (error) => { if (error) { electronSocket.emit("webContents-printToPDF-completed", false); } else { electronSocket.emit("webContents-printToPDF-completed", true); } }); }); socket.on( "webContents-executeJavaScript", async (id, code, userGesture = false) => { const result = await getWindowById(id).webContents.executeJavaScript( code, userGesture, ); electronSocket.emit("webContents-executeJavaScript-completed", result); }, ); socket.on("webContents-getUrl", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-getUrl" + id, browserWindow.webContents.getURL(), ); }); socket.on( "webContents-session-allowNTLMCredentialsForDomains", (id, domains) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.allowNTLMCredentialsForDomains(domains); }, ); socket.on("webContents-session-clearAuthCache", async (...args) => { // Overload support: (id, guid) OR (id, options, guid) const browserWindow = getWindowById(args[0]); let guid: string; if (args.length === 2) { // No options guid = args[1]; await browserWindow.webContents.session.clearAuthCache(); } else if (args.length === 3) { const options = args[1]; guid = args[2]; try { // @ts-ignore await browserWindow.webContents.session.clearAuthCache(options); } catch { // Fallback to clearing without options if Electron version rejects custom options await browserWindow.webContents.session.clearAuthCache(); } } else { return; // invalid invocation } electronSocket.emit("webContents-session-clearAuthCache-completed" + guid); }); socket.on("webContents-session-clearCache", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearCache(); electronSocket.emit("webContents-session-clearCache-completed" + guid); }); socket.on("webContents-session-clearHostResolverCache", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearHostResolverCache(); electronSocket.emit( "webContents-session-clearHostResolverCache-completed" + guid, ); }); socket.on("webContents-session-clearStorageData", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearStorageData({}); electronSocket.emit( "webContents-session-clearStorageData-completed" + guid, ); }); socket.on( "webContents-session-clearStorageData-options", async (id, options, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.clearStorageData(options); electronSocket.emit( "webContents-session-clearStorageData-options-completed" + guid, ); }, ); socket.on("webContents-session-createInterruptedDownload", (id, options) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.createInterruptedDownload(options); }); socket.on("webContents-session-disableNetworkEmulation", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.disableNetworkEmulation(); }); socket.on("webContents-session-enableNetworkEmulation", (id, options) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.enableNetworkEmulation(options); }); socket.on("webContents-session-flushStorageData", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.flushStorageData(); }); socket.on("webContents-session-getBlobData", async (id, identifier, guid) => { const browserWindow = getWindowById(id); const buffer = await browserWindow.webContents.session.getBlobData(identifier); electronSocket.emit( "webContents-session-getBlobData-completed" + guid, buffer.buffer, ); }); socket.on("webContents-session-getCacheSize", async (id, guid) => { const browserWindow = getWindowById(id); const size = await browserWindow.webContents.session.getCacheSize(); electronSocket.emit( "webContents-session-getCacheSize-completed" + guid, size, ); }); socket.on("webContents-session-getPreloads", (id, guid) => { const browserWindow = getWindowById(id); const preloads = browserWindow.webContents.session.getPreloads(); electronSocket.emit( "webContents-session-getPreloads-completed" + guid, preloads, ); }); socket.on("webContents-session-getUserAgent", (id, guid) => { const browserWindow = getWindowById(id); const userAgent = browserWindow.webContents.session.getUserAgent(); electronSocket.emit( "webContents-session-getUserAgent-completed" + guid, userAgent, ); }); socket.on("webContents-session-resolveProxy", async (id, url, guid) => { const browserWindow = getWindowById(id); const proxy = await browserWindow.webContents.session.resolveProxy(url); electronSocket.emit( "webContents-session-resolveProxy-completed" + guid, proxy, ); }); socket.on("webContents-session-setDownloadPath", (id, path) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setDownloadPath(path); }); socket.on("webContents-session-setPreloads", (id, preloads) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setPreloads(preloads); }); socket.on("webContents-session-setProxy", async (id, configuration, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.setProxy(configuration); electronSocket.emit("webContents-session-setProxy-completed" + guid); }); socket.on( "webContents-session-setUserAgent", (id, userAgent, acceptLanguages) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.setUserAgent( userAgent, acceptLanguages, ); }, ); socket.on( "register-webContents-session-webRequest-onBeforeRequest", (id, filter) => { const browserWindow = getWindowById(id); const session = browserWindow.webContents.session; session.webRequest.onBeforeRequest(filter, (details, callback) => { socket.emit( `webContents-session-webRequest-onBeforeRequest${id}`, details, ); // Listen for a response from C# to continue the request electronSocket.once( `webContents-session-webRequest-onBeforeRequest-response${id}`, (response) => { callback(response); }, ); }); }, ); socket.on("register-webContents-session-cookies-changed", (id) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.cookies.removeAllListeners("changed"); browserWindow.webContents.session.cookies.on( "changed", (event, cookie, cause, removed) => { electronSocket.emit("webContents-session-cookies-changed" + id, [ cookie, cause, removed, ]); }, ); }); socket.on("webContents-session-cookies-get", async (id, filter, guid) => { const browserWindow = getWindowById(id); const cookies = await browserWindow.webContents.session.cookies.get(filter); electronSocket.emit( "webContents-session-cookies-get-completed" + guid, cookies, ); }); socket.on("webContents-session-cookies-set", async (id, details, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.set(details); electronSocket.emit("webContents-session-cookies-set-completed" + guid); }); socket.on( "webContents-session-cookies-remove", async (id, url, name, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.remove(url, name); electronSocket.emit( "webContents-session-cookies-remove-completed" + guid, ); }, ); socket.on("webContents-session-cookies-flushStore", async (id, guid) => { const browserWindow = getWindowById(id); await browserWindow.webContents.session.cookies.flushStore(); electronSocket.emit( "webContents-session-cookies-flushStore-completed" + guid, ); }); socket.on("webContents-loadURL", (id, url, options) => { const browserWindow = getWindowById(id); browserWindow.webContents .loadURL(url, options) .then(() => { electronSocket.emit("webContents-loadURL-complete" + id); }) .catch((error) => { console.error(error); electronSocket.emit("webContents-loadURL-error" + id, error); }); }); socket.on("webContents-insertCSS", (id, isBrowserWindow, path) => { if (isBrowserWindow) { const browserWindow = getWindowById(id); if (browserWindow) { browserWindow.webContents.insertCSS(fs.readFileSync(path, "utf8")); } } else { const browserViews: BrowserView[] = (global["browserViews"] = global["browserViews"] || []) as BrowserView[]; let view: BrowserView = null; for (let i = 0; i < browserViews.length; i++) { if (browserViews[i]["id"] + 1000 === id) { view = browserViews[i]; break; } } if (view) { view.webContents.insertCSS(fs.readFileSync(path, "utf8")); } } }); socket.on("webContents-session-getAllExtensions", (id) => { const browserWindow = getWindowById(id); const extensionsList = browserWindow.webContents.session.getAllExtensions(); const chromeExtensionInfo = []; Object.keys(extensionsList).forEach((key) => { chromeExtensionInfo.push(extensionsList[key]); }); electronSocket.emit( "webContents-session-getAllExtensions-completed", chromeExtensionInfo, ); }); socket.on("webContents-session-removeExtension", (id, name) => { const browserWindow = getWindowById(id); browserWindow.webContents.session.removeExtension(name); }); socket.on( "webContents-session-loadExtension", async (id, path, allowFileAccess = false) => { const browserWindow = getWindowById(id); const extension = await browserWindow.webContents.session.loadExtension( path, { allowFileAccess: allowFileAccess }, ); electronSocket.emit( "webContents-session-loadExtension-completed", extension, ); }, ); socket.on("webContents-getZoomFactor", (id) => { const browserWindow = getWindowById(id); const text = browserWindow.webContents.getZoomFactor(); electronSocket.emit("webContents-getZoomFactor-completed", text); }); socket.on("webContents-setZoomFactor", (id, factor) => { const browserWindow = getWindowById(id); browserWindow.webContents.setZoomFactor(factor); }); socket.on("webContents-getZoomLevel", (id) => { const browserWindow = getWindowById(id); const content = browserWindow.webContents.getZoomLevel(); electronSocket.emit("webContents-getZoomLevel-completed", content); }); socket.on("webContents-setZoomLevel", (id, level) => { const browserWindow = getWindowById(id); browserWindow.webContents.setZoomLevel(level); }); socket.on( "webContents-setVisualZoomLevelLimits", async (id, minimumLevel, maximumLevel) => { const browserWindow = getWindowById(id); await browserWindow.webContents.setVisualZoomLevelLimits( minimumLevel, maximumLevel, ); electronSocket.emit("webContents-setVisualZoomLevelLimits-completed"); }, ); socket.on("webContents-toggleDevTools", (id) => { getWindowById(id).webContents.toggleDevTools(); }); socket.on("webContents-closeDevTools", (id) => { getWindowById(id).webContents.closeDevTools(); }); socket.on("webContents-isDevToolsOpened", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-isDevToolsOpened-completed", browserWindow.webContents.isDevToolsOpened(), ); }); socket.on("webContents-isDevToolsFocused", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-isDevToolsFocused-completed", browserWindow.webContents.isDevToolsFocused(), ); }); socket.on("webContents-setAudioMuted", (id, muted) => { getWindowById(id).webContents.setAudioMuted(muted); }); socket.on("webContents-isAudioMuted", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-isAudioMuted-completed", browserWindow.webContents.isAudioMuted(), ); }); socket.on("webContents-isCurrentlyAudible", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-isCurrentlyAudible-completed", browserWindow.webContents.isCurrentlyAudible(), ); }); socket.on("webContents-getUserAgent", function (id) { const browserWindow = getWindowById(id); electronSocket.emit( "webContents-getUserAgent-completed", browserWindow.webContents.getUserAgent(), ); }); socket.on("webContents-setUserAgent", (id, userAgent) => { getWindowById(id).webContents.setUserAgent(userAgent); }); function getWindowById( id: number, ): Electron.BrowserWindow | Electron.BrowserView { if (id >= 1000) { return browserViewMediateService(id - 1000); } return BrowserWindow.fromId(id); } }; ================================================ FILE: src/ElectronNET.Host/eslint.config.js ================================================ module.exports = [ { rules: { // Add rules here. } } ]; ================================================ FILE: src/ElectronNET.Host/globals.d.ts ================================================ // Ambient declarations to silence implicit any / global index usage // Minimal surface expand only if further errors appear. declare var browserViews: any; declare var tray: any; declare var electronsocket: any; ================================================ FILE: src/ElectronNET.Host/main.js ================================================ const { app } = require('electron'); const { BrowserWindow } = require('electron'); const { protocol } = require('electron'); const path = require('path'); const cProcess = require('child_process').spawn; const portscanner = require('portscanner'); const { imageSize } = require('image-size'); let io, server, browserWindows, ipc, apiProcess, loadURL; let appApi, menu, dialogApi, notification, tray, webContents; let globalShortcut, shellApi, screen, clipboard, autoUpdater; let commandLine, browserView; let powerMonitor; let processInfo; let splashScreen; let nativeTheme; let dock; let launchFile; let launchUrl; let processApi; let manifestJsonFileName = 'package.json'; let unpackedelectron = false; let unpackeddotnet = false; let dotnetpacked = false; let electronforcedport; if (app.commandLine.hasSwitch('manifest')) { manifestJsonFileName = app.commandLine.getSwitchValue('manifest'); } console.log('Entry!!!: '); if (app.commandLine.hasSwitch('unpackedelectron')) { unpackedelectron = true; } else if (app.commandLine.hasSwitch('unpackeddotnet')) { unpackeddotnet = true; } else if (app.commandLine.hasSwitch('dotnetpacked')) { dotnetpacked = true; } if (app.commandLine.hasSwitch('electronforcedport')) { electronforcedport = app.commandLine.getSwitchValue('electronforcedport'); } // Custom startup hook: look for custom_main.js and invoke its onStartup(host) if present. // If the hook returns false, abort Electron startup. try { const fs = require('fs'); const customMainPath = path.join(__dirname, 'custom_main.js'); if (fs.existsSync(customMainPath)) { const customMain = require(customMainPath); if (customMain && typeof customMain.onStartup === 'function') { const continueStartup = customMain.onStartup(globalThis); if (continueStartup === false) { ////console.log('custom_main.js onStartup returned false. Exiting Electron host.'); // Ensure the app terminates immediately before further initialization. // Use app.exit to allow Electron to perform its shutdown, fallback to process.exit. try { app.exit(0); } catch (err) { process.exit(0); } } } else { console.warn('custom_main.js found but no onStartup function exported.'); } } } catch (err) { console.error('Error while executing custom_main.js:', err); } const currentPath = __dirname; let currentBinPath = path.join(currentPath.replace('app.asar', ''), 'bin'); let manifestJsonFilePath = path.join(currentPath, manifestJsonFileName); // if running unpackedelectron, lets change the path if (unpackedelectron || unpackeddotnet) { console.log('unpackedelectron! dir: ' + currentPath); manifestJsonFilePath = path.join(currentPath, manifestJsonFileName); currentBinPath = path.join(currentPath, '../'); // go to project directory } // handle macOS events for opening the app with a file, etc app.on('will-finish-launching', () => { app.on('open-file', (evt, file) => { evt.preventDefault(); launchFile = file; }); app.on('open-url', (evt, url) => { evt.preventDefault(); launchUrl = url; }); }); const manifestJsonFile = require(manifestJsonFilePath); if (manifestJsonFile.singleInstance) { const mainInstance = app.requestSingleInstanceLock(); app.on('second-instance', (events, args = []) => { args.forEach((parameter) => { const words = parameter.split('='); if (words.length > 1) { app.commandLine.appendSwitch(words[0].replace('--', ''), words[1]); } else { app.commandLine.appendSwitch(words[0].replace('--', '')); } }); const windows = BrowserWindow.getAllWindows(); if (windows.length) { if (windows[0].isMinimized()) { windows[0].restore(); } windows[0].focus(); } }); if (!mainInstance) { app.quit(); } } // Collect user supplied command line args (excluding those handled by Electron host itself) function getForwardedArgs() { const skipSwitches = new Set(['unpackedelectron', 'unpackeddotnet', 'dotnetpacked']); return process.argv.slice(2).filter(arg => { if (!arg) return false; // Node/Electron internal or we already process them if (arg.startsWith('--manifest')) return false; const cleaned = arg.replace(/^--/, '').replace(/^\//, ''); if (skipSwitches.has(cleaned)) return false; if (cleaned.startsWith('inspect')) return false; if (cleaned.startsWith('remote-debugging-port')) return false; // We add /electronPort ourselves later if (cleaned.startsWith('electronPort=')) return false; if (cleaned.startsWith('electronWebPort=')) return false; return true; }); } const forwardedArgs = getForwardedArgs(); app.on('ready', () => { // Fix ERR_UNKNOWN_URL_SCHEME using file protocol // https://github.com/electron/electron/issues/23757 ////protocol.registerFileProtocol('file', (request, callback) => { //// const pathname = request.url.replace('file:///', ''); //// callback(pathname); ////}); if (isSplashScreenEnabled()) { startSplashScreen(); } if (electronforcedport) { console.log('Electron Socket IO (forced) Port: ' + electronforcedport); startSocketApiBridge(electronforcedport); return; } // Added default port as configurable for port restricted environments. let defaultElectronPort = 8000; if (manifestJsonFile.electronPort) { defaultElectronPort = manifestJsonFile.electronPort; } // hostname needs to be localhost, otherwise Windows Firewall will be triggered. portscanner.findAPortNotInUse(defaultElectronPort, 65535, 'localhost', function (error, port) { console.log('Electron Socket IO Port: ' + port); startSocketApiBridge(port); }); }); app.on('quit', async (event, exitCode) => { try { server.close(); server.closeAllConnections(); } catch (e) { console.error(e); } try { apiProcess?.kill(); } catch (e) { console.error(e); } try { if (io && typeof io.close === 'function') { io.close(); } } catch (e) { console.error(e); } }); function isSplashScreenEnabled() { if (manifestJsonFile.hasOwnProperty('splashscreen')) { if (manifestJsonFile.splashscreen.hasOwnProperty('imageFile')) { return Boolean(manifestJsonFile.splashscreen.imageFile); } } return false; } function startSplashScreen() { const imageFile = path.join(currentPath, manifestJsonFile.splashscreen.imageFile); const isHtml = imageFile.endsWith('.html') || imageFile.endsWith('.htm'); const startWindow = (width, height) => { splashScreen = new BrowserWindow({ width: width, height: height, transparent: true, center: true, frame: false, closable: false, resizable: false, skipTaskbar: true, alwaysOnTop: true, show: true, }); splashScreen.setIgnoreMouseEvents(true); app.once('browser-window-created', () => { splashScreen.destroy(); }); const loadSplashscreenUrl = isHtml ? imageFile : path.join(currentPath, 'splashscreen', 'index.html') + '?imgPath=' + imageFile; splashScreen.loadURL('file://' + loadSplashscreenUrl); splashScreen.once('closed', () => { splashScreen = null; }); }; if (manifestJsonFile.splashscreen.width && manifestJsonFile.splashscreen.height) { // width and height are set explicitly return startWindow(manifestJsonFile.splashscreen.width, manifestJsonFile.splashscreen.height); } if (isHtml) { // we cannot compute width and height => use default return startWindow(800, 600); } // it's an image, so we can compute the desired splash screen size imageSize(imageFile, (error, dimensions) => { if (error) { console.log(`load splashscreen error:`); console.error(error); throw new Error(error.message); } startWindow(dimensions.width, dimensions.height); }); } function startSocketApiBridge(port) { // instead of 'require('socket.io')(port);' we need to use this workaround // otherwise the Windows Firewall will be triggered console.log('Electron Socket: starting...'); server = require('http').createServer(); const { Server } = require('socket.io'); let hostHook; io = new Server({ pingTimeout: 60000, // in ms, default is 5000 pingInterval: 10000, // in ms, default is 25000 }); io.attach(server); server.listen(port, 'localhost'); server.on('listening', function () { console.log('Electron Socket: listening on port %s at %s', server.address().port, server.address().address); // Now that socket connection is established, we can guarantee port will not be open for portscanner if (unpackedelectron) { startAspCoreBackendUnpackaged(port); } else if (!unpackeddotnet && !dotnetpacked) { startAspCoreBackend(port); } }); // prototype app['mainWindowURL'] = ''; app['mainWindow'] = null; // @ts-ignore io.on('connection', (socket) => { console.log('Electron Socket: connected!'); socket.on('disconnect', function (reason) { console.log('Got disconnect! Reason: ' + reason); try { ////console.log('requireCache'); ////console.log(require.cache['electron-host-hook']); if (hostHook) { const hostHookScriptFilePath = path.join(currentPath, 'ElectronHostHook', 'index.js'); delete require.cache[require.resolve(hostHookScriptFilePath)]; hostHook = undefined; } } catch (err) { console.error(err.message); } }); if (global['electronsocket'] === undefined) { global['electronsocket'] = socket; global['electronsocket'].setMaxListeners(0); } console.log('Electron Socket: loading components...'); if (appApi === undefined) appApi = require('./api/app')(socket, app); if (browserWindows === undefined) browserWindows = require('./api/browserWindows')(socket, app); if (commandLine === undefined) commandLine = require('./api/commandLine')(socket, app); if (autoUpdater === undefined) autoUpdater = require('./api/autoUpdater')(socket); if (ipc === undefined) ipc = require('./api/ipc')(socket); if (menu === undefined) menu = require('./api/menu')(socket); if (dialogApi === undefined) dialogApi = require('./api/dialog')(socket); if (notification === undefined) notification = require('./api/notification')(socket); if (tray === undefined) tray = require('./api/tray')(socket); if (webContents === undefined) webContents = require('./api/webContents')(socket); if (globalShortcut === undefined) globalShortcut = require('./api/globalShortcut')(socket); if (shellApi === undefined) shellApi = require('./api/shell')(socket); if (screen === undefined) screen = require('./api/screen')(socket); if (clipboard === undefined) clipboard = require('./api/clipboard')(socket); if (browserView === undefined) browserView = require('./api/browserView').browserViewApi(socket); if (powerMonitor === undefined) powerMonitor = require('./api/powerMonitor')(socket); if (nativeTheme === undefined) nativeTheme = require('./api/nativeTheme')(socket); if (dock === undefined) dock = require('./api/dock')(socket); if (processInfo === undefined) processInfo = require('./api/process')(socket); socket.on('register-app-open-file', (id) => { global['electronsocket'] = socket; app.on('open-file', (event, file) => { event.preventDefault(); global['electronsocket'].emit('app-open-file' + id, file); }); if (launchFile) { global['electronsocket'].emit('app-open-file' + id, launchFile); } }); socket.on('register-app-open-url', (id) => { global['electronsocket'] = socket; app.on('open-url', (event, url) => { event.preventDefault(); global['electronsocket'].emit('app-open-url' + id, url); }); if (launchUrl) { global['electronsocket'].emit('app-open-url' + id, launchUrl); } }); try { const { HookService } = require('electron-host-hook'); if (hostHook === undefined) { hostHook = new HookService(socket, app); hostHook.onHostReady(); } } catch (error) { console.error(error.message); } console.log('Electron Socket: startup complete.'); }); } function startAspCoreBackend(electronPort) { startBackend(); function startBackend() { loadURL = `about:blank`; const envParam = getEnvironmentParameter(); const parameters = [ envParam, `/electronPort=${electronPort}`, `/electronPID=${process.pid}`, // forward user supplied args (avoid duplicate environment) ...forwardedArgs.filter(a => !(envParam && a.startsWith('--environment='))) ].filter(p => p); let binaryFile = manifestJsonFile.executable; const os = require('os'); if (os.platform() === 'win32') { binaryFile = binaryFile + '.exe'; } let binFilePath = path.join(currentBinPath, binaryFile); var options = { cwd: currentBinPath }; console.log('Starting backend with parameters:', parameters.join(' ')); apiProcess = cProcess(binFilePath, parameters, options); apiProcess.stdout.on('data', (data) => { console.log(`stdout: ${data.toString()}`); }); } } function startAspCoreBackendUnpackaged(electronPort) { startBackend(); function startBackend() { loadURL = `about:blank`; const envParam = getEnvironmentParameter(); const parameters = [ envParam, `/electronPort=${electronPort}`, `/electronPID=${process.pid}`, ...forwardedArgs.filter(a => !(envParam && a.startsWith('--environment='))) ].filter(p => p); let binaryFile = manifestJsonFile.executable; const os = require('os'); if (os.platform() === 'win32') { binaryFile = binaryFile + '.exe'; } let binFilePath = path.join(currentBinPath, binaryFile); var options = { cwd: currentBinPath }; console.log('Starting backend (unpackaged) with parameters:', parameters.join(' ')); apiProcess = cProcess(binFilePath, parameters, options); apiProcess.stdout.on('data', (data) => { console.log(`stdout: ${data.toString()}`); }); } } function getEnvironmentParameter() { if (manifestJsonFile.environment) { return '--environment=' + manifestJsonFile.environment; } return ''; } ================================================ FILE: src/ElectronNET.Host/package.json ================================================ { "name": "electron.net.host", "version": "1.0.0", "description": "Electron-Host for Electron.NET.", "repository": { "url": "https://github.com/ElectronNET/Electron.NET" }, "main": "main.js", "type": "commonjs", "scripts": { "build": "tsc --build", "clean": "tsc --build --clean", "start": "tsc -p ." }, "keywords": [], "author": "Gregor Biswanger, Florian Rappl", "license": "MIT", "dependencies": { "dasherize": "^2.0.0", "electron-host-hook": "file:./ElectronHostHook", "image-size": "^1.2.1", "portscanner": "^2.2.0", "electron-updater": "^6.6.2", "socket.io": "^4.8.1" }, "devDependencies": { "@types/node": "^22.18", "electron": "^30.0.3", "eslint": "^9.39.1", "typescript": "^5.9.3" } } ================================================ FILE: src/ElectronNET.Host/scripts/blazor-preload.js ================================================ global.process = undefined; global.module = undefined; ================================================ FILE: src/ElectronNET.Host/splashscreen/index.html ================================================  Splashscreen splashscreen ================================================ FILE: src/ElectronNET.Host/tsconfig.json ================================================ { "exclude": [ "node_modules", "ElectronHostHook" ], "compilerOptions": { "module": "commonjs", "moduleResolution": "node", "target": "es2020", "lib": ["es2020"], "types": ["node"], "sourceMap": true, "strict": false, "noImplicitAny": false, "skipLibCheck": true, "isolatedModules": false, "esModuleInterop": true, "allowSyntheticDefaultImports": true, "baseUrl": ".", "paths": { "electron-updater": ["node_modules/electron-updater/dist/index.d.ts"] } }, "include": [ "**/*.ts", "types-shims.d.ts", "globals.d.ts" ] } ================================================ FILE: src/ElectronNET.Host/tsconfig.tsbuildinfo ================================================ {"root":["./globals.d.ts","./types-shims.d.ts","./api/app.ts","./api/autoupdater.ts","./api/browserview.ts","./api/browserwindows.ts","./api/clipboard.ts","./api/commandline.ts","./api/dialog.ts","./api/dock.ts","./api/globalshortcut.ts","./api/ipc.ts","./api/menu.ts","./api/nativetheme.ts","./api/notification.ts","./api/powermonitor.ts","./api/process.ts","./api/screen.ts","./api/shell.ts","./api/tray.ts","./api/webcontents.ts"],"version":"5.9.3"} ================================================ FILE: src/ElectronNET.Host/types-shims.d.ts ================================================ // Simplified ambient module declarations to silence unresolved external module TS errors // and missing extended tsconfig references inside node_modules. // This is internal only. declare module 'electron-updater' { export const autoUpdater: any; } declare module '@ljharb/tsconfig'; ================================================ FILE: src/ElectronNET.IntegrationTests/Common/IntegrationFactAttribute.cs ================================================ namespace ElectronNET.IntegrationTests.Common { using System.Runtime.InteropServices; using Xunit.Sdk; /// /// Custom fact attribute with a default timeout of 20 seconds, allowing tests to be skipped on specific environments. /// /// [AttributeUsage(AttributeTargets.Method)] [XunitTestCaseDiscoverer("Xunit.Sdk.SkippableFactDiscoverer", "Xunit.SkippableFact")] internal sealed class IntegrationFactAttribute : FactAttribute { private static readonly bool IsOnWsl; private static readonly bool IsOnCI; static IntegrationFactAttribute() { IsOnWsl = DetectWsl(); IsOnCI = DetectCI(); } /// /// Initializes a new instance of the class. /// public IntegrationFactAttribute() { this.Timeout = 20_000; } public bool SkipOnWsl { get; set; } public bool SkipOnCI { get; set; } /// /// Marks the test so that it will not be run, and gets or sets the skip reason /// public override string Skip { get { if (IsOnWsl && this.SkipOnWsl) { return "Skipping test on WSL environment."; } if (IsOnCI && this.SkipOnCI) { return "Skipping test on CI environment."; } return base.Skip; } set { base.Skip = value; } } private static bool DetectWsl() { try { if (!RuntimeInformation.IsOSPlatform(OSPlatform.Linux)) { return false; } if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("WSL_DISTRO_NAME")) || !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("WSL_INTEROP"))) { return true; } return false; } catch { return false; } } private static bool DetectCI() { try { if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("TF_BUILD")) || !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("GITHUB_ACTIONS"))) { return true; } return false; } catch { return false; } } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Common/IntegrationTestBase.cs ================================================ namespace ElectronNET.IntegrationTests.Common { using ElectronNET.API; using ElectronNET.API.Entities; // Base class for integration tests providing shared access to MainWindow and OS platform constants public abstract class IntegrationTestBase { protected IntegrationTestBase(ElectronFixture fixture) { Fixture = fixture; MainWindow = fixture.MainWindow; } protected ElectronFixture Fixture { get; } protected BrowserWindow MainWindow { get; } // Constants for SupportedOSPlatform attributes public const string Windows = "Windows"; public const string MacOS = "macOS"; public const string Linux = "Linux"; } } ================================================ FILE: src/ElectronNET.IntegrationTests/ElectronFixture.cs ================================================ namespace ElectronNET.IntegrationTests { using System.Diagnostics.CodeAnalysis; using System.Reflection; using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; // Shared fixture that starts Electron runtime once [SuppressMessage("ReSharper", "MethodHasAsyncOverload")] public class ElectronFixture : IAsyncLifetime { public BrowserWindow MainWindow { get; private set; } = null!; public async Task InitializeAsync() { try { Console.Error.WriteLine("[ElectronFixture] InitializeAsync: start"); AppDomain.CurrentDomain.SetData("ElectronTestAssembly", Assembly.GetExecutingAssembly()); Console.WriteLine("[ElectronFixture] Acquire RuntimeController"); var runtimeController = ElectronNetRuntime.RuntimeController; ElectronNetRuntime.ElectronExtraArguments = "--no-sandbox"; Console.Error.WriteLine("[ElectronFixture] Starting Electron runtime..."); await runtimeController.Start(); Console.Error.WriteLine("[ElectronFixture] Waiting for Ready..."); await Task.WhenAny(runtimeController.WaitReadyTask, Task.Delay(10.seconds())); if (!runtimeController.WaitReadyTask.IsCompleted) { throw new TimeoutException("The Electron process did not start within 10 seconds"); } Console.Error.WriteLine("[ElectronFixture] Runtime Ready"); // create hidden window for tests (avoid showing UI) this.MainWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = false, Width = 800, Height = 600, }, "about:blank"); await this.MainWindow.WebContents.Session.ClearCacheAsync(); } catch (Exception ex) { Console.Error.WriteLine("[ElectronFixture] InitializeAsync: exception"); Console.Error.WriteLine(ex.ToString()); throw; } } public async Task DisposeAsync() { var runtimeController = ElectronNetRuntime.RuntimeController; Console.Error.WriteLine("[ElectronFixture] Stopping Electron runtime..."); await runtimeController.Stop(); await runtimeController.WaitStoppedTask; Console.Error.WriteLine("[ElectronFixture] Runtime stopped"); } } [CollectionDefinition("ElectronCollection")] public class ElectronCollection : ICollectionFixture { } } ================================================ FILE: src/ElectronNET.IntegrationTests/ElectronNET.IntegrationTests.csproj ================================================  true net10.0 enable disable false true all runtime; build; native; contentfiles; analyzers; buildtransitive false PreserveNewest ================================================ FILE: src/ElectronNET.IntegrationTests/GlobalUsings.cs ================================================ global using Xunit; global using FluentAssertions; ================================================ FILE: src/ElectronNET.IntegrationTests/Properties/electron-builder.json ================================================ { "$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json", "compression": "maximum", "linux": { "target": [ "tar.xz" ], "executableArgs": [ "--no-sandbox" ], "artifactName": "${name}-${arch}-${version}.${ext}" }, "win": { "target": [ { "target": "portable", "arch": "x64" } ] } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/AppTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.API.Entities; using System; using System.IO; using System.Runtime.Versioning; using System.Threading.Tasks; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class AppTests : IntegrationTestBase { public AppTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Can_get_app_path() { var path = await Electron.App.GetAppPathAsync(); path.Should().NotBeNullOrWhiteSpace(); Directory.Exists(path).Should().BeTrue(); } [IntegrationFact] public async Task Can_get_version_and_locale() { var version = await Electron.App.GetVersionAsync(); version.Should().NotBeNullOrWhiteSpace(); var locale = await Electron.App.GetLocaleAsync(); locale.Should().NotBeNullOrWhiteSpace(); } [IntegrationFact] public async Task Can_get_special_paths() { var userData = await Electron.App.GetPathAsync(PathName.UserData); userData.Should().NotBeNullOrWhiteSpace(); Directory.Exists(Path.GetDirectoryName(userData) ?? userData).Should().BeTrue(); var temp = await Electron.App.GetPathAsync(PathName.Temp); temp.Should().NotBeNullOrWhiteSpace(); Directory.Exists(temp).Should().BeTrue(); } [IntegrationFact] public async Task Can_get_app_metrics() { var metrics = await Electron.App.GetAppMetricsAsync(); metrics.Should().NotBeNull(); metrics.Length.Should().BeGreaterThan(0); } [IntegrationFact] public async Task Can_get_gpu_feature_status() { var status = await Electron.App.GetGpuFeatureStatusAsync(); status.Should().NotBeNull(); } [IntegrationFact] [SupportedOSPlatform(MacOS)] [SupportedOSPlatform(Windows)] public async Task Can_get_login_item_settings() { var settings = await Electron.App.GetLoginItemSettingsAsync(); settings.Should().NotBeNull(); } [IntegrationFact] public async Task CommandLine_append_and_query_switch() { var switchName = "integration-switch"; Electron.App.CommandLine.AppendSwitch(switchName, "value123"); (await Electron.App.CommandLine.HasSwitchAsync(switchName)).Should().BeTrue(); (await Electron.App.CommandLine.GetSwitchValueAsync(switchName)).Should().Be("value123"); } [IntegrationFact] [SupportedOSPlatform(MacOS)] [SupportedOSPlatform(Windows)] public async Task Accessibility_support_toggle() { Electron.App.SetAccessibilitySupportEnabled(true); var enabled = await Electron.App.IsAccessibilitySupportEnabledAsync(); enabled.Should().BeTrue(); // API responded Electron.App.SetAccessibilitySupportEnabled(false); } [IntegrationFact] public async Task UserAgentFallback_roundtrip() { var original = await Electron.App.UserAgentFallbackAsync; Electron.App.UserAgentFallback = "ElectronIntegrationTest/1.0"; var updated = await Electron.App.UserAgentFallbackAsync; updated.Should().Be("ElectronIntegrationTest/1.0"); Electron.App.UserAgentFallback = original; // restore } [IntegrationFact] [SupportedOSPlatform(Linux)] [SupportedOSPlatform(MacOS)] public async Task BadgeCount_set_and_reset_where_supported() { await Electron.App.SetBadgeCountAsync(2); var count = await Electron.App.GetBadgeCountAsync(); // Some platforms may always return0; just ensure call didn't throw and is non-negative count.Should().BeGreaterThanOrEqualTo(0); await Electron.App.SetBadgeCountAsync(0); } [IntegrationFact] public async Task App_metrics_have_cpu_info() { var metrics = await Electron.App.GetAppMetricsAsync(); metrics[0].Cpu.Should().NotBeNull(); } [IntegrationFact] public async Task App_gpu_feature_status_has_some_fields() { var status = await Electron.App.GetGpuFeatureStatusAsync(); status.Should().NotBeNull(); status.Webgl.Should().NotBeNull(); status.VideoDecode.Should().NotBeNull(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/AutoUpdaterTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using API; using System.Threading.Tasks; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class AutoUpdaterTests : IntegrationTestBase { public AutoUpdaterTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task AutoDownload_check() { Electron.AutoUpdater.AutoDownload = false; var test1 = Electron.AutoUpdater.AutoDownload; Electron.AutoUpdater.AutoDownload = true; var test2 = Electron.AutoUpdater.AutoDownload; test1.Should().BeFalse(); test2.Should().BeTrue(); } [IntegrationFact] public async Task AutoInstallOnAppQuit_check() { Electron.AutoUpdater.AutoInstallOnAppQuit = false; var test1 = Electron.AutoUpdater.AutoInstallOnAppQuit; Electron.AutoUpdater.AutoInstallOnAppQuit = true; var test2 = Electron.AutoUpdater.AutoInstallOnAppQuit; test1.Should().BeFalse(); test2.Should().BeTrue(); } [IntegrationFact] public async Task AllowPrerelease_check() { Electron.AutoUpdater.AllowPrerelease = false; var test1 = Electron.AutoUpdater.AllowPrerelease; Electron.AutoUpdater.AllowPrerelease = true; var test2 = Electron.AutoUpdater.AllowPrerelease; test1.Should().BeFalse(); test2.Should().BeTrue(); } [IntegrationFact] public async Task FullChangelog_check() { Electron.AutoUpdater.FullChangelog = false; var test1 = Electron.AutoUpdater.FullChangelog; Electron.AutoUpdater.FullChangelog = true; var test2 = Electron.AutoUpdater.FullChangelog; test1.Should().BeFalse(); test2.Should().BeTrue(); } [IntegrationFact] public async Task AllowDowngrade_check() { Electron.AutoUpdater.AllowDowngrade = false; var test1 = Electron.AutoUpdater.AllowDowngrade; Electron.AutoUpdater.AllowDowngrade = true; var test2 = Electron.AutoUpdater.AllowDowngrade; test1.Should().BeFalse(); test2.Should().BeTrue(); } [IntegrationFact] public async Task UpdateConfigPath_check() { var test1 = Electron.AutoUpdater.UpdateConfigPath; test1.Should().Be(string.Empty); } [IntegrationFact] public async Task CurrentVersionAsync_check() { var semver = await Electron.AutoUpdater.CurrentVersionAsync; semver.Should().NotBeNull(); semver.Major.Should().BeGreaterThan(0); } [IntegrationFact] public async Task ChannelAsync_check() { var test = await Electron.AutoUpdater.ChannelAsync; test.Should().Be(string.Empty); Electron.AutoUpdater.SetChannel = "beta"; await Task.Delay(500.ms()); test = await Electron.AutoUpdater.ChannelAsync; test.Should().Be("beta"); } [IntegrationFact] public async Task RequestHeadersAsync_check() { var headers = new Dictionary { { "key1", "value1" }, }; var test = await Electron.AutoUpdater.RequestHeadersAsync; test.Should().BeNull(); Electron.AutoUpdater.RequestHeaders = headers; await Task.Delay(500.ms()); test = await Electron.AutoUpdater.RequestHeadersAsync; test.Should().NotBeNull(); test.Count.Should().Be(1); test["key1"].Should().Be("value1"); } [IntegrationFact] public async Task CheckForUpdatesAsync_check() { var test = await Electron.AutoUpdater.CheckForUpdatesAsync(); test.Should().BeNull(); } [IntegrationFact] public async Task CheckForUpdatesAndNotifyAsync_check() { var test = await Electron.AutoUpdater.CheckForUpdatesAsync(); test.Should().BeNull(); } [IntegrationFact] public async Task GetFeedURLAsync_check() { var test = await Electron.AutoUpdater.GetFeedURLAsync(); test.Should().Contain("Deprecated"); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/BrowserViewTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class BrowserViewTests : IntegrationTestBase { public BrowserViewTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Create_browser_view_and_adjust_bounds() { var view = await Electron.WindowManager.CreateBrowserViewAsync(new BrowserViewConstructorOptions()); this.MainWindow.SetBrowserView(view); view.Bounds = new Rectangle { X = 0, Y = 0, Width = 300, Height = 200 }; // Access bounds again (synchronous property fetch) var current = view.Bounds; current.Width.Should().Be(300); current.Height.Should().Be(200); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/BrowserWindowTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.Versioning; using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class BrowserWindowTests : IntegrationTestBase { public BrowserWindowTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Can_set_and_get_title() { const string title = "Integration Test Title"; this.MainWindow.SetTitle(title); await Task.Delay(500.ms()); var roundTrip = await this.MainWindow.GetTitleAsync(); roundTrip.Should().Be(title); } [IntegrationFact] public async Task Can_resize_and_get_size() { this.MainWindow.SetSize(643, 482); await Task.Delay(500.ms()); var size = await this.MainWindow.GetSizeAsync(); size.Should().HaveCount(2); size[0].Should().Be(643); size[1].Should().Be(482); } [IntegrationFact] public async Task Can_set_progress_bar_and_clear() { this.MainWindow.SetProgressBar(0.5); // No direct getter; rely on absence of error. Try changing again. this.MainWindow.SetProgressBar(-1); // clears await Task.Delay(50.ms()); } [IntegrationFact(SkipOnWsl = true)] public async Task Can_set_and_get_position() { this.MainWindow.SetPosition(134, 246); await Task.Delay(500.ms()); var pos = await this.MainWindow.GetPositionAsync(); pos.Should().BeEquivalentTo([134, 246]); } [IntegrationFact] public async Task Can_set_and_get_bounds() { var bounds = new Rectangle { X = 10, Y = 20, Width = 400, Height = 300 }; this.MainWindow.SetBounds(bounds); await Task.Delay(500.ms()); var round = await this.MainWindow.GetBoundsAsync(); round.Should().BeEquivalentTo(bounds); round.Width.Should().Be(400); round.Height.Should().Be(300); } [IntegrationFact] public async Task Can_set_and_get_content_bounds() { var bounds = new Rectangle { X = 0, Y = 0, Width = 300, Height = 200 }; this.MainWindow.SetContentBounds(bounds); await Task.Delay(500.ms()); var round = await this.MainWindow.GetContentBoundsAsync(); round.Width.Should().BeGreaterThan(0); round.Height.Should().BeGreaterThan(0); } [IntegrationFact] public async Task Show_hide_visibility_roundtrip() { BrowserWindow window = null; try { window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = true }, "about:blank"); await Task.Delay(100.ms()); window.Show(); await Task.Delay(500.ms()); (await window.IsVisibleAsync()).Should().BeTrue(); window.Hide(); await Task.Delay(500.ms()); (await window.IsVisibleAsync()).Should().BeFalse(); } finally { window?.Destroy(); } } [IntegrationFact] public async Task AlwaysOnTop_toggle_and_query() { this.MainWindow.SetAlwaysOnTop(true); await Task.Delay(500.ms()); (await this.MainWindow.IsAlwaysOnTopAsync()).Should().BeTrue(); this.MainWindow.SetAlwaysOnTop(false); await Task.Delay(500.ms()); (await this.MainWindow.IsAlwaysOnTopAsync()).Should().BeFalse(); } [IntegrationFact] [SupportedOSPlatform(Linux)] [SupportedOSPlatform(Windows)] public async Task MenuBar_auto_hide_and_visibility() { this.MainWindow.SetAutoHideMenuBar(true); await Task.Delay(500.ms()); (await this.MainWindow.IsMenuBarAutoHideAsync()).Should().BeTrue(); this.MainWindow.SetMenuBarVisibility(false); await Task.Delay(500.ms()); (await this.MainWindow.IsMenuBarVisibleAsync()).Should().BeFalse(); this.MainWindow.SetMenuBarVisibility(true); await Task.Delay(500.ms()); (await this.MainWindow.IsMenuBarVisibleAsync()).Should().BeTrue(); } [IntegrationFact] public async Task ReadyToShow_event_fires_after_content_ready() { BrowserWindow window = null; try { window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = false }, "about:blank"); var tcs = new TaskCompletionSource(); window.OnReadyToShow += () => tcs.TrySetResult(); // Trigger a navigation and wait for DOM ready so the renderer paints, which emits ready-to-show var domReadyTcs = new TaskCompletionSource(); window.WebContents.OnDomReady += () => domReadyTcs.TrySetResult(); await Task.Delay(500.ms()); await window.WebContents.LoadURLAsync("about:blank"); await domReadyTcs.Task; var completed = await Task.WhenAny(tcs.Task, Task.Delay(3.seconds())); completed.Should().Be(tcs.Task); } finally { window?.Destroy(); } } [IntegrationFact] public async Task PageTitleUpdated_event_fires_on_title_change() { var window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = true }, "about:blank"); var tcs = new TaskCompletionSource(); window.OnPageTitleUpdated += title => tcs.TrySetResult(title); // Navigate and wait for DOM ready, then change the document.title to trigger the event var domReadyTcs = new TaskCompletionSource(); window.WebContents.OnDomReady += () => domReadyTcs.TrySetResult(); await Task.Delay(500.ms()); await window.WebContents.LoadURLAsync("about:blank"); await domReadyTcs.Task; await window.WebContents.ExecuteJavaScriptAsync("document.title='NewTitle';"); // Wait for event up to a short timeout var completed2 = await Task.WhenAny(tcs.Task, Task.Delay(3.seconds())); completed2.Should().Be(tcs.Task); (await tcs.Task).Should().Be("NewTitle"); } [IntegrationFact] public async Task Resize_event_fires_on_size_change() { var window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = false }, "about:blank"); var resized = false; window.OnResize += () => resized = true; await Task.Delay(500.ms()); window.SetSize(500, 400); await Task.Delay(300.ms()); resized.Should().BeTrue(); } [IntegrationFact] public async Task Progress_bar_and_always_on_top_toggle() { var win = this.MainWindow; win.SetProgressBar(0.5); await Task.Delay(50.ms()); win.SetProgressBar(0.8, new ProgressBarOptions()); await Task.Delay(50.ms()); win.SetAlwaysOnTop(true); await Task.Delay(500.ms()); (await win.IsAlwaysOnTopAsync()).Should().BeTrue(); win.SetAlwaysOnTop(false); await Task.Delay(500.ms()); (await win.IsAlwaysOnTopAsync()).Should().BeFalse(); } [IntegrationFact] [SupportedOSPlatform(Linux)] [SupportedOSPlatform(Windows)] public async Task Menu_bar_visibility_and_auto_hide() { var win = this.MainWindow; win.SetAutoHideMenuBar(true); await Task.Delay(500.ms()); (await win.IsMenuBarAutoHideAsync()).Should().BeTrue(); win.SetMenuBarVisibility(true); await Task.Delay(500.ms()); (await win.IsMenuBarVisibleAsync()).Should().BeTrue(); } [IntegrationFact] public async Task Parent_child_relationship_roundtrip() { var child = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = false, Width = 300, Height = 200 }, "about:blank"); this.MainWindow.SetParentWindow(null); // ensure top-level child.SetParentWindow(this.MainWindow); await Task.Delay(500.ms()); var parent = await child.GetParentWindowAsync(); parent.Id.Should().Be(this.MainWindow.Id); var kids = await this.MainWindow.GetChildWindowsAsync(); kids.Select(k => k.Id).Should().Contain(child.Id); child.Destroy(); } [IntegrationFact] [SupportedOSPlatform(MacOS)] public async Task Represented_filename_and_edited_flags() { var win = this.MainWindow; var temp = Path.Combine(Path.GetTempPath(), "electronnet_test.txt"); File.WriteAllText(temp, "test"); win.SetRepresentedFilename(temp); await Task.Delay(500.ms()); var represented = await win.GetRepresentedFilenameAsync(); represented.Should().Be(temp); win.SetDocumentEdited(true); await Task.Delay(500.ms()); var edited = await win.IsDocumentEditedAsync(); edited.Should().BeTrue(); win.SetDocumentEdited(false); } [IntegrationFact] public async Task BoundsChanged_event_fires_with_updated_bounds() { BrowserWindow window = null; try { window = await Electron.WindowManager.CreateWindowAsync( new BrowserWindowOptions { Show = true, Width = 300, Height = 200 }, "about:blank"); await Task.Delay(5.seconds()); var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); window.OnBoundsChanged += bounds => tcs.TrySetResult(bounds); await Task.Delay(500.ms()); var target = new Rectangle { X = 25, Y = 35, Width = 420, Height = 310 }; window.SetBounds(target); var completed = await Task.WhenAny(tcs.Task, Task.Delay(3.seconds())); completed.Should().Be(tcs.Task); var observed = await tcs.Task; observed.Width.Should().Be(target.Width); observed.Height.Should().Be(target.Height); } finally { window?.Destroy(); } } [IntegrationFact] public async Task BoundsChanged_event_can_fire_on_resize_of_existing_window() { var win = this.MainWindow; var tcs = new TaskCompletionSource(TaskCreationOptions.RunContinuationsAsynchronously); win.OnBoundsChanged += bounds => tcs.TrySetResult(bounds); await Task.Delay(500.ms()); win.SetBounds(new Rectangle { X = 10, Y = 10, Width = 560, Height = 440 }); var completed = await Task.WhenAny(tcs.Task, Task.Delay(3.seconds())); completed.Should().Be(tcs.Task); var boundsObserved = await tcs.Task; boundsObserved.Width.Should().Be(560); boundsObserved.Height.Should().Be(440); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/ClipboardTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.Versioning; using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class ClipboardTests : IntegrationTestBase { public ClipboardTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Clipboard_text_roundtrip() { var text = $"Hello Electron {Guid.NewGuid()}"; Electron.Clipboard.WriteText(text); var read = await Electron.Clipboard.ReadTextAsync(); read.Should().Be(text); } [IntegrationFact] public async Task Available_formats_contains_text_after_write() { var text = "FormatsTest"; Electron.Clipboard.WriteText(text); var formats = await Electron.Clipboard.AvailableFormatsAsync(); formats.Should().Contain(f => f.Contains("text") || f.Contains("TEXT") || f.Contains("plain")); } [IntegrationFact] [SupportedOSPlatform(MacOS)] [SupportedOSPlatform(Windows)] public async Task Bookmark_write_and_read() { var url = "https://electron-test.com"; Electron.Clipboard.WriteBookmark("TitleTest", url); var bookmark = await Electron.Clipboard.ReadBookmarkAsync(); bookmark.Url.Should().Be(url); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/CookiesTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class CookiesTests : IntegrationTestBase { public CookiesTests(ElectronFixture fx) : base(fx) { } [IntegrationFact(Skip = "Cookie set/get requires navigation to domain; skipping until test harness serves page")] public async Task Cookie_set_get_remove_sequence() { var session = this.MainWindow.WebContents.Session; var changed = false; session.Cookies.OnChanged += (cookie, cause, removed) => changed = true; // Navigate to example.com so cookie domain matches await this.MainWindow.WebContents.LoadURLAsync("https://example.com"); // Set via renderer for now await this.MainWindow.WebContents.ExecuteJavaScriptAsync("document.cookie='integration_cookie=1;path=/';"); await Task.Delay(500.ms()); changed.Should().BeTrue(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/GlobalShortcutTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.InteropServices; using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class GlobalShortcutTests : IntegrationTestBase { public GlobalShortcutTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Can_register_and_unregister() { var accel = RuntimeInformation.IsOSPlatform(OSPlatform.OSX) ? "Cmd+Alt+G" : "Ctrl+Alt+G"; var tcs = new TaskCompletionSource(); Electron.GlobalShortcut.Register(accel, () => tcs.TrySetResult(true)); var isRegistered = await Electron.GlobalShortcut.IsRegisteredAsync(accel); isRegistered.Should().BeTrue(); Electron.GlobalShortcut.Unregister(accel); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/HostHookTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class HostHookTests : IntegrationTestBase { public HostHookTests(ElectronFixture fx) : base(fx) { } [IntegrationFact(Skip = "Requires HostHook setup; skipping")] public async Task HostHook_call_returns_value() { var result = await Electron.HostHook.CallAsync("create-excel-file", "."); result.Should().NotBeNull(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/IpcMainTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class IpcMainTests : IntegrationTestBase { public IpcMainTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Ipc_On_receives_message_from_renderer() { object received = null; var tcs = new TaskCompletionSource(); await Electron.IpcMain.On("ipc-on-test", obj => { received = obj; tcs.TrySetResult(obj as string); }); await this.MainWindow.WebContents.ExecuteJavaScriptAsync("require('electron').ipcRenderer.send('ipc-on-test','payload123')"); var result = await tcs.Task.WaitAsync(TimeSpan.FromSeconds(5)); received.Should().BeOfType(); received.Should().Be("payload123"); result.Should().Be("payload123"); } [IntegrationFact] public async Task Ipc_Once_only_fires_once() { var count = 0; Electron.IpcMain.Once("ipc-once-test", _ => count++); await this.MainWindow.WebContents.ExecuteJavaScriptAsync("const {ipcRenderer}=require('electron'); ipcRenderer.send('ipc-once-test','a'); ipcRenderer.send('ipc-once-test','b');"); await Task.Delay(500.ms()); count.Should().Be(1); } [IntegrationFact] public async Task Ipc_RemoveAllListeners_stops_receiving() { var fired = false; await Electron.IpcMain.On("ipc-remove-test", _ => fired = true); Electron.IpcMain.RemoveAllListeners("ipc-remove-test"); await this.MainWindow.WebContents.ExecuteJavaScriptAsync("require('electron').ipcRenderer.send('ipc-remove-test','x')"); await Task.Delay(400.ms()); fired.Should().BeFalse(); } [IntegrationFact] public async Task Ipc_OnSync_returns_value() { object received = null; Electron.IpcMain.OnSync("ipc-sync-test", (obj) => { received = obj; return "pong"; }); var ret = await this.MainWindow.WebContents.ExecuteJavaScriptAsync("require('electron').ipcRenderer.sendSync('ipc-sync-test','ping')"); received.Should().BeOfType(); received.Should().Be("ping"); ret.Should().Be("pong"); } [IntegrationFact] public async Task Ipc_Send_from_main_reaches_renderer() { // Listener: store raw arg; if Electron packs differently we will normalize later await this.MainWindow.WebContents.ExecuteJavaScriptAsync(@"(function(){ const {ipcRenderer}=require('electron'); ipcRenderer.once('main-to-render',(e,arg)=>{ globalThis.__mainToRender = arg;}); return 'ready'; })();"); Electron.IpcMain.Send(this.MainWindow, "main-to-render", "hello-msg"); string value = ""; for (int i = 0; i < 20; i++) { var jsVal = await this.MainWindow.WebContents.ExecuteJavaScriptAsync("globalThis.__mainToRender === undefined ? '' : (typeof globalThis.__mainToRender === 'string' ? globalThis.__mainToRender : JSON.stringify(globalThis.__mainToRender))"); value = jsVal?.ToString() ?? ""; if (!string.IsNullOrEmpty(value)) { break; } await Task.Delay(100.ms()); } // Normalize possible JSON array ["hello-msg"] case if (value.StartsWith("[\"") && value.EndsWith("\"]")) { // Extract first element between [" and "] value = value.Substring(2, value.Length - 4); } value.Should().Be("hello-msg"); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/MenuTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class MenuTests : IntegrationTestBase { public MenuTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task ApplicationMenu_click_invokes_handler() { var clicked = false; var items = new[] { new MenuItem { Label = "File", Submenu = new[] { new MenuItem { Label = "Ping", Click = () => clicked = true }, }, }, }; Electron.Menu.SetApplicationMenu(items); var targetId = items[0].Submenu[0].Id; await this.MainWindow.WebContents.ExecuteJavaScriptAsync($"require('electron').ipcRenderer.send('integration-click-application-menu','{targetId}')"); for (int i = 0; i < 20 && !clicked; i++) { await Task.Delay(100.ms()); } clicked.Should().BeTrue(); } [IntegrationFact] public async Task ContextMenu_popup_registers_items() { var win = this.MainWindow; var ctxClicked = false; var ctxItems = new[] { new MenuItem { Label = "Ctx", Click = () => ctxClicked = true } }; Electron.Menu.SetContextMenu(win, ctxItems); var ctxId = ctxItems[0].Id; // simulate popup then click Electron.Menu.ContextMenuPopup(win); await this.MainWindow.WebContents.ExecuteJavaScriptAsync($"require('electron').ipcRenderer.send('integration-click-context-menu',{win.Id},'{ctxId}')"); for (int i = 0; i < 20 && !ctxClicked; i++) { await Task.Delay(100.ms()); } ctxClicked.Should().BeTrue(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/MultiEventRegistrationTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class MultiEventRegistrationTests : IntegrationTestBase { public MultiEventRegistrationTests(ElectronFixture fx) : base(fx) { } private static async Task WaitAllOrTimeout(TimeSpan timeout, params Task[] tasks) { var all = Task.WhenAll(tasks); var completed = await Task.WhenAny(all, Task.Delay(timeout)); return ReferenceEquals(completed, all) && all.IsCompletedSuccessfully; } [IntegrationFact] public async Task BrowserWindow_OnResize_multiple_handlers_called() { var win = this.MainWindow; var h1 = new TaskCompletionSource(); var h2 = new TaskCompletionSource(); var h3 = new TaskCompletionSource(); win.OnResize += () => h1.TrySetResult(); win.OnResize += () => h2.TrySetResult(); win.OnResize += () => h3.TrySetResult(); var size = await win.GetSizeAsync(); // trigger resize win.SetSize(size[0] + 20, size[1] + 10); var ok = await WaitAllOrTimeout(TimeSpan.FromSeconds(5), h1.Task, h2.Task, h3.Task); if (!ok) { throw new Xunit.Sdk.XunitException($"Not all events were fired: \nEvent1 fired: {h1.Task.IsCompleted}\nEvent2 fired: {h2.Task.IsCompleted}\nEvent3 fired: {h3.Task.IsCompleted}"); } } [IntegrationFact] public async Task WebContents_OnDomReady_multiple_handlers_called() { var wc = this.MainWindow.WebContents; var r1 = new TaskCompletionSource(); var r2 = new TaskCompletionSource(); wc.OnDomReady += () => r1.TrySetResult(); wc.OnDomReady += () => r2.TrySetResult(); await wc.LoadURLAsync("about:blank"); var ok = await WaitAllOrTimeout(TimeSpan.FromSeconds(2), r1.Task, r2.Task); if (!ok) { throw new Xunit.Sdk.XunitException($"Not all events were fired: \nEvent1 fired: {r1.Task.IsCompleted}\nEvent2 fired: {r2.Task.IsCompleted}"); } } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/NativeImageTests.cs ================================================ using System.Drawing; using ElectronNET.API.Entities; using ElectronNET.IntegrationTests.Common; using System.Runtime.Versioning; using RectangleEntity = ElectronNET.API.Entities.Rectangle; namespace ElectronNET.IntegrationTests.Tests { [Collection("ElectronCollection")] [SupportedOSPlatform(Windows)] public class NativeImageTests : IntegrationTestBase { public NativeImageTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Create_from_bitmap_and_to_png() { using var bmp = new Bitmap(10, 10); using (var g = Graphics.FromImage(bmp)) { g.Clear(Color.Red); } var native = NativeImage.CreateFromBitmap(bmp); var size = native.GetSize(); size.Width.Should().Be(10); size.Height.Should().Be(10); var png = native.ToPNG(new ToPNGOptions { ScaleFactor = 1.0f }); png.Should().NotBeNull(); png!.Length.Should().BeGreaterThan(0); } [IntegrationFact] public async Task Create_from_buffer_and_to_data_url() { // Prepare PNG bytes using var bmp = new Bitmap(8, 8); using (var g = Graphics.FromImage(bmp)) { g.Clear(Color.Blue); } using var ms = new MemoryStream(); bmp.Save(ms, System.Drawing.Imaging.ImageFormat.Png); var bytes = ms.ToArray(); var native = NativeImage.CreateFromBuffer(bytes); var dataUrl = native.ToDataURL(new ToDataUrlOptions { ScaleFactor = 1.0f }); dataUrl.Should().NotBeNullOrWhiteSpace(); dataUrl!.StartsWith("data:image/", StringComparison.Ordinal).Should().BeTrue(); } [IntegrationFact] public async Task Resize_and_crop_produce_expected_sizes() { using var bmp = new Bitmap(12, 10); using (var g = Graphics.FromImage(bmp)) { g.Clear(Color.Green); } var native = NativeImage.CreateFromBitmap(bmp); var resized = native.Resize(new ResizeOptions { Width = 6, Height = 5 }); var rsize = resized.GetSize(); rsize.Width.Should().Be(6); rsize.Height.Should().Be(5); var cropped = native.Crop(new RectangleEntity { X = 2, Y = 2, Width = 4, Height = 3 }); var csize = cropped.GetSize(); csize.Width.Should().Be(4); csize.Height.Should().Be(3); } [IntegrationFact] public async Task Add_representation_for_scale_factor() { using var bmp = new Bitmap(5, 5); using (var g = Graphics.FromImage(bmp)) { g.Clear(Color.Black); } using var ms = new MemoryStream(); bmp.Save(ms, System.Drawing.Imaging.ImageFormat.Png); var buffer = ms.ToArray(); var native = NativeImage.CreateFromBitmap(bmp); native.AddRepresentation(new AddRepresentationOptions { Buffer = buffer, ScaleFactor = 2.0f }); var size2X = native.GetSize(2.0f); size2X.Should().NotBeNull(); size2X.Width.Should().Be(5); size2X.Height.Should().Be(5); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/NativeThemeTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.Versioning; using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class NativeThemeTests : IntegrationTestBase { public NativeThemeTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task ThemeSource_roundtrip() { // Capture initial _ = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); // Force light await Task.Delay(50.ms()); Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Light); await Task.Delay(500.ms()); var useDarkAfterLight = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); var themeSourceLight = await Electron.NativeTheme.GetThemeSourceAsync(); // Force dark Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Dark); await Task.Delay(500.ms()); var useDarkAfterDark = await Electron.NativeTheme.ShouldUseDarkColorsAsync(); var themeSourceDark = await Electron.NativeTheme.GetThemeSourceAsync(); // Restore system Electron.NativeTheme.SetThemeSource(ThemeSourceMode.System); await Task.Delay(500.ms()); var themeSourceSystem = await Electron.NativeTheme.GetThemeSourceAsync(); // Assertions are tolerant (platform dependent) useDarkAfterLight.Should().BeFalse("forcing Light should result in light colors"); useDarkAfterDark.Should().BeTrue("forcing Dark should result in dark colors"); themeSourceLight.Should().Be(ThemeSourceMode.Light); themeSourceDark.Should().Be(ThemeSourceMode.Dark); themeSourceSystem.Should().Be(ThemeSourceMode.System); } [IntegrationFact] public async Task Updated_event_fires_on_change() { var fired = false; Electron.NativeTheme.Updated += () => fired = true; Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Dark); await Task.Delay(400.ms()); Electron.NativeTheme.SetThemeSource(ThemeSourceMode.Light); for (int i = 0; i < 10 && !fired; i++) { await Task.Delay(100.ms()); } fired.Should().BeTrue(); } [IntegrationFact] [SupportedOSPlatform(MacOS)] [SupportedOSPlatform(Windows)] public async Task Should_use_high_contrast_colors_check() { var metrics = await Electron.NativeTheme.ShouldUseHighContrastColorsAsync(); metrics.Should().Be(false); } [IntegrationFact] [SupportedOSPlatform(MacOS)] [SupportedOSPlatform(Windows)] public async Task Should_use_inverted_colors_check() { var metrics = await Electron.NativeTheme.ShouldUseInvertedColorSchemeAsync(); metrics.Should().Be(false); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/NotificationTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.InteropServices; using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class NotificationTests : IntegrationTestBase { public NotificationTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Notification_create_check() { Skip.If(RuntimeInformation.IsOSPlatform(OSPlatform.Linux), "Always returns false. Might need full-blown desktop environment"); var tcs = new TaskCompletionSource(); var options = new NotificationOptions("Notification Title", "Notification test 123"); options.OnShow = () => tcs.SetResult(); await Task.Delay(500.ms()); Electron.Notification.Show(options); await Task.WhenAny(tcs.Task, Task.Delay(5.seconds())); tcs.Task.IsCompletedSuccessfully.Should().BeTrue(); } [IntegrationFact] public async Task Notification_is_supported_check() { Skip.If(RuntimeInformation.IsOSPlatform(OSPlatform.Linux), "Always returns false. Might need full-blown desktop environment"); var supported = await Electron.Notification.IsSupportedAsync(); supported.Should().BeTrue(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/ProcessTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class ProcessTests : IntegrationTestBase { public ProcessTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Process_info_is_accessible() { // Use renderer to fetch process info and round-trip var execPath = await Electron.WindowManager.CreateWindowAsync(new API.Entities.BrowserWindowOptions { Show = false }, "about:blank"); var result = await execPath.WebContents.ExecuteJavaScriptAsync("process.execPath && process.platform ? 'ok' : 'fail'"); result.Should().Be("ok"); } [IntegrationFact] public async Task Process_properties_are_populated() { var execPath = await Electron.Process.ExecPathAsync; execPath.Should().NotBeNullOrWhiteSpace(); var pid = await Electron.Process.PidAsync; pid.Should().BeGreaterThan(0); var platform = await Electron.Process.PlatformAsync; platform.Should().NotBeNullOrWhiteSpace(); var argv = await Electron.Process.ArgvAsync; argv.Should().NotBeNull(); argv.Length.Should().BeGreaterThan(0); var type = await Electron.Process.TypeAsync; type.Should().NotBeNullOrWhiteSpace(); var version = await Electron.Process.VersionsAsync; version.Should().NotBeNull(); version.Chrome.Should().NotBeNullOrWhiteSpace(); version.Electron.Should().NotBeNullOrWhiteSpace(); var defaultApp = await Electron.Process.DefaultAppAsync; defaultApp.Should().BeTrue(); var isMainFrame = await Electron.Process.IsMainFrameAsync; isMainFrame.Should().BeFalse(); var resourcePath = await Electron.Process.ResourcesPathAsync; resourcePath.Should().NotBeNullOrWhiteSpace(); var upTime = await Electron.Process.UpTimeAsync; upTime.Should().BeGreaterThan(0); var arch = await Electron.Process.ArchAsync; arch.Should().NotBeNullOrWhiteSpace(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/ScreenTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.Versioning; using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class ScreenTests : IntegrationTestBase { public ScreenTests(ElectronFixture fx) : base(fx) { } [IntegrationFact(SkipOnWsl = true)] public async Task Primary_display_has_positive_dimensions() { var display = await Electron.Screen.GetPrimaryDisplayAsync(); display.Size.Width.Should().BeGreaterThan(0); display.Size.Height.Should().BeGreaterThan(0); } [IntegrationFact(SkipOnWsl = true)] public async Task GetAllDisplays_returns_at_least_one() { var displays = await Electron.Screen.GetAllDisplaysAsync(); displays.Should().NotBeNull(); displays.Length.Should().BeGreaterThan(0); } [IntegrationFact] public async Task GetCursorScreenPoint_check() { var point = await Electron.Screen.GetCursorScreenPointAsync(); point.Should().NotBeNull(); } [IntegrationFact] [SupportedOSPlatform(MacOS)] public async Task GetMenuBarWorkArea_check() { var area = await Electron.Screen.GetMenuBarWorkAreaAsync(); area.Should().NotBeNull(); area.X.Should().BeGreaterThanOrEqualTo(0); area.Y.Should().BeGreaterThanOrEqualTo(0); area.Height.Should().BeGreaterThan(0); area.Width.Should().BeGreaterThan(0); } [IntegrationFact(SkipOnWsl = true)] public async Task GetDisplayNearestPoint_check() { var point = new Point { X = 100, Y = 100 }; var display = await Electron.Screen.GetDisplayNearestPointAsync(point); display.Should().NotBeNull(); display.Size.Width.Should().BeGreaterThan(0); display.Size.Height.Should().BeGreaterThan(0); } [IntegrationFact(SkipOnWsl = true)] public async Task GetDisplayMatching_check() { var rectangle = new Rectangle { X = 100, Y = 100, Width = 100, Height = 100 }; var display = await Electron.Screen.GetDisplayMatchingAsync(rectangle); display.Should().NotBeNull(); display.Size.Width.Should().BeGreaterThan(0); display.Size.Height.Should().BeGreaterThan(0); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/SessionTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API.Entities; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class SessionTests : IntegrationTestBase { public SessionTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Session_preloads_roundtrip() { var session = this.MainWindow.WebContents.Session; _ = await session.GetPreloadsAsync(); // Use a dummy path; API should store value session.SetPreloads(new[] { "/tmp/preload_dummy.js" }); var preloadsAfter = await session.GetPreloadsAsync(); preloadsAfter.Should().Contain("/tmp/preload_dummy.js"); } [IntegrationFact] public async Task Session_proxy_set_and_resolve() { var session = this.MainWindow.WebContents.Session; // Provide all ctor args (pacScript empty to ignore, proxyRules direct, bypass empty) await session.SetProxyAsync(new ProxyConfig("", "direct://", "")); var proxy = await session.ResolveProxyAsync("https://example.com"); proxy.Should().NotBeNull(); } [IntegrationFact] public async Task Session_clear_cache_and_storage_completes() { var session = this.MainWindow.WebContents.Session; await session.ClearCacheAsync(); await session.ClearStorageDataAsync(); await session.ClearHostResolverCacheAsync(); // Ensure still can query user agent after clears var ua = await session.GetUserAgent(); ua.Should().NotBeNullOrWhiteSpace(); } [IntegrationFact] public async Task Session_preloads_set_multiple_and_clear() { var session = this.MainWindow.WebContents.Session; session.SetPreloads(new[] { "/tmp/a.js", "/tmp/b.js" }); var after = await session.GetPreloadsAsync(); after.Should().Contain("/tmp/a.js").And.Contain("/tmp/b.js"); // Reset to empty session.SetPreloads(Array.Empty()); var empty = await session.GetPreloadsAsync(); empty.Should().NotContain("/tmp/a.js"); } [IntegrationFact] public async Task Clear_auth_cache_overloads() { var session = this.MainWindow.WebContents.Session; await session.ClearAuthCacheAsync(); await session.ClearAuthCacheAsync(new RemovePassword("password") { Origin = "https://example.com", Username = "user", Password = "pw", Realm = "realm", Scheme = Scheme.basic }); } [IntegrationFact] public async Task Clear_storage_with_options() { var session = this.MainWindow.WebContents.Session; await session.ClearStorageDataAsync(new ClearStorageDataOptions { Storages = new[] { "cookies" }, Quotas = new[] { "temporary" } }); } [IntegrationFact] public async Task Enable_disable_network_emulation() { var session = this.MainWindow.WebContents.Session; session.EnableNetworkEmulation(new EnableNetworkEmulationOptions { Offline = false, Latency = 10, DownloadThroughput = 50000, UploadThroughput = 20000 }); session.DisableNetworkEmulation(); } [IntegrationFact] public async Task Flush_storage_data_does_not_throw() { var session = this.MainWindow.WebContents.Session; session.FlushStorageData(); } [IntegrationFact] public async Task Set_user_agent_affects_new_navigation() { var session = this.MainWindow.WebContents.Session; // Set UA and verify via session API (navigator.userAgent on existing WebContents may not reflect the override) session.SetUserAgent("IntegrationAgent/1.0"); var ua = await session.GetUserAgent(); ua.Should().NotBeNullOrWhiteSpace(); ua.Should().Contain("IntegrationAgent/1.0"); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/ShellTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class ShellTests : IntegrationTestBase { public ShellTests(ElectronFixture fx) : base(fx) { } [IntegrationFact(Skip = "This can keep the test process hanging until the e-mail window is closed")] public async Task OpenExternal_invalid_scheme_returns_error_or_empty() { var error = await Electron.Shell.OpenExternalAsync("mailto:test@example.com"); (error == string.Empty || error.Contains("@") || error.Length > 0).Should().BeTrue(); // call succeeded } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/ThumbarButtonTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using System.Runtime.Versioning; using ElectronNET.API.Entities; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class ThumbarButtonTests : IntegrationTestBase { public ThumbarButtonTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] [SupportedOSPlatform(Windows)] public async Task SetThumbarButtons_returns_success() { var btn = new ThumbarButton("icon.png") { Tooltip = "Test" }; var success = await this.MainWindow.SetThumbarButtonsAsync(new[] { btn }); success.Should().BeTrue(); } [IntegrationFact] [SupportedOSPlatform(Windows)] public async Task Thumbar_button_click_invokes_callback() { var icon = Path.Combine(Directory.GetCurrentDirectory(), "ElectronNET.WebApp", "wwwroot", "icon.png"); if (!File.Exists(icon)) { return; // skip if icon missing } var tcs = new TaskCompletionSource(); var btn = new ThumbarButton(icon) { Tooltip = "Test", Flags = new[] { ThumbarButtonFlag.enabled }, Click = () => tcs.TrySetResult(true) }; var ok = await this.MainWindow.SetThumbarButtonsAsync(new[] { btn }); ok.Should().BeTrue(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/TrayTests.cs ================================================ namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class TrayTests : IntegrationTestBase { public TrayTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Can_create_tray_and_destroy() { //await Electron.Tray.Show("assets/icon.png"); await Electron.Tray.Show(null); var isDestroyed = await Electron.Tray.IsDestroyedAsync(); isDestroyed.Should().BeFalse(); await Electron.Tray.Destroy(); (await Electron.Tray.IsDestroyedAsync()).Should().BeTrue(); } } } ================================================ FILE: src/ElectronNET.IntegrationTests/Tests/WebContentsTests.cs ================================================ using System.Runtime.InteropServices; namespace ElectronNET.IntegrationTests.Tests { using ElectronNET.API; using ElectronNET.API.Entities; using ElectronNET.Common; using ElectronNET.IntegrationTests.Common; [Collection("ElectronCollection")] public class WebContentsTests : IntegrationTestBase { public WebContentsTests(ElectronFixture fx) : base(fx) { } [IntegrationFact] public async Task Can_get_url_after_navigation() { var wc = this.MainWindow.WebContents; await wc.LoadURLAsync("https://example.com"); var url = await wc.GetUrl(); url.Should().Contain("example.com"); } [IntegrationFact] public async Task ExecuteJavaScript_returns_title() { var wc = this.MainWindow.WebContents; await wc.LoadURLAsync("https://example.com"); var title = await wc.ExecuteJavaScriptAsync("document.title"); title.Should().NotBeNull(); } [IntegrationFact] public async Task DomReady_event_fires() { var wc = this.MainWindow.WebContents; var fired = false; wc.OnDomReady += () => fired = true; await wc.LoadURLAsync("https://example.com"); await Task.Delay(500.ms()); fired.Should().BeTrue(); } [IntegrationFact] public async Task Can_print_to_pdf() { var html = "data:text/html,

PDF Test

Electron.NET

"; await this.MainWindow.WebContents.LoadURLAsync(html); var tmp = Path.Combine(Path.GetTempPath(), $"electronnet_pdf_{Guid.NewGuid():N}.pdf"); try { var ok = await this.MainWindow.WebContents.PrintToPDFAsync(tmp); ok.Should().BeTrue(); File.Exists(tmp).Should().BeTrue(); new FileInfo(tmp).Length.Should().BeGreaterThan(0); } finally { if (File.Exists(tmp)) { File.Delete(tmp); } } } [IntegrationFact] public async Task Can_basic_print() { var html = "data:text/html,

Print Test

"; await this.MainWindow.WebContents.LoadURLAsync(html); var ok = await this.MainWindow.WebContents.PrintAsync(new PrintOptions { Silent = true, PrintBackground = true }); ok.Should().BeTrue(); } [IntegrationFact] public async Task GetPrintersAsync_check() { var info = await this.MainWindow.WebContents.GetPrintersAsync(); info.Should().NotBeNull(); } [IntegrationFact] public async Task GetSetZoomFactor_check() { await this.MainWindow.WebContents.GetZoomFactorAsync(); var ok = await this.MainWindow.WebContents.GetZoomFactorAsync(); ok.Should().BeGreaterThan(0.0); this.MainWindow.WebContents.SetZoomFactor(2.0); await Task.Delay(500.ms()); ok = await this.MainWindow.WebContents.GetZoomFactorAsync(); ok.Should().Be(2.0); } [IntegrationFact] public async Task GetSetZoomLevel_check() { BrowserWindow window = null; try { window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = true }, "about:blank"); await Task.Delay(100.ms()); window.WebContents.SetZoomLevel(0); await Task.Delay(500.ms()); var ok = await window.WebContents.GetZoomLevelAsync(); ok.Should().Be(0); window.WebContents.SetZoomLevel(2); await Task.Delay(500.ms()); ok = await window.WebContents.GetZoomLevelAsync(); ok.Should().Be(2); } finally { window?.Destroy(); } } [IntegrationFact] public async Task DevTools_check() { BrowserWindow window = null; try { window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = true }, "about:blank"); await Task.Delay(3.seconds()); window.WebContents.IsDevToolsOpened().Should().BeFalse(); window.WebContents.OpenDevTools(); await Task.Delay(5.seconds()); window.WebContents.IsDevToolsOpened().Should().BeTrue(); window.WebContents.CloseDevTools(); await Task.Delay(2.seconds()); window.WebContents.IsDevToolsOpened().Should().BeFalse(); } finally { window?.Destroy(); } } [IntegrationFact] public async Task GetSetAudioMuted_check() { this.MainWindow.WebContents.SetAudioMuted(true); await Task.Delay(500.ms()); var ok = await this.MainWindow.WebContents.IsAudioMutedAsync(); ok.Should().BeTrue(); this.MainWindow.WebContents.SetAudioMuted(false); await Task.Delay(500.ms()); ok = await this.MainWindow.WebContents.IsAudioMutedAsync(); ok.Should().BeFalse(); // Assuming no audio is playing, IsCurrentlyAudibleAsync should return false // there is no way to play audio in this test ok = await this.MainWindow.WebContents.IsCurrentlyAudibleAsync(); ok.Should().BeFalse(); } [IntegrationFact] public async Task GetSetUserAgent_check() { BrowserWindow window = null; try { await Task.Delay(1.seconds()); window = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Show = true }, "about:blank"); await Task.Delay(5.seconds()); window.WebContents.SetUserAgent("MyUserAgent/1.0"); await Task.Delay(2.seconds()); var ok = await window.WebContents.GetUserAgentAsync(); ok.Should().Be("MyUserAgent/1.0"); } finally { window?.Destroy(); } } } } ================================================ FILE: src/ElectronNET.IntegrationTests/xunit.runner.json ================================================ { "$schema": "https://xunit.net/schema/current/xunit.runner.schema.json", "methodDisplay": "method", "diagnosticMessages": true, "parallelizeTestCollections": false, "longRunningTestSeconds": 60 } ================================================ FILE: src/ElectronNET.Lean.sln ================================================ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.12.35707.178 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElectronNET.API", "ElectronNET.API\ElectronNET.API.csproj", "{A78157BA-B754-45F1-969F-D6A513CA0E72}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.Build", "ElectronNET.Build\ElectronNET.Build.csproj", "{829FC339-4785-4229-ABA5-53ADB544DA00}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET", "ElectronNET\ElectronNET.csproj", "{8860606D-6847-F22A-5AED-DF4E0984DD24}" ProjectSection(ProjectDependencies) = postProject {829FC339-4785-4229-ABA5-53ADB544DA00} = {829FC339-4785-4229-ABA5-53ADB544DA00} EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "!Config", "!Config", "{02EA681E-C7D8-13C7-8484-4AC65E1B71E8}" ProjectSection(SolutionItems) = preProject ..\Changelog.md = ..\Changelog.md common.props = common.props global.json = global.json ..\NuGet.config = ..\NuGet.config EndProjectSection EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.AspNet", "ElectronNET.AspNet\ElectronNET.AspNet.csproj", "{DD10D21A-D131-1D9C-33F9-406046E0C5B0}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{1BB6F634-2831-4496-83A6-BC6761DCEC8D}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {A78157BA-B754-45F1-969F-D6A513CA0E72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Debug|Any CPU.Build.0 = Debug|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Release|Any CPU.ActiveCfg = Release|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Release|Any CPU.Build.0 = Release|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Debug|Any CPU.Build.0 = Debug|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Release|Any CPU.ActiveCfg = Release|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Release|Any CPU.Build.0 = Release|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Debug|Any CPU.Build.0 = Debug|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Release|Any CPU.ActiveCfg = Release|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Release|Any CPU.Build.0 = Release|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Debug|Any CPU.Build.0 = Debug|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Release|Any CPU.ActiveCfg = Release|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {A78157BA-B754-45F1-969F-D6A513CA0E72} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {829FC339-4785-4229-ABA5-53ADB544DA00} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {8860606D-6847-F22A-5AED-DF4E0984DD24} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {DD10D21A-D131-1D9C-33F9-406046E0C5B0} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {81A62E71-9E04-4EFE-AD5C-23165375F8EF} EndGlobalSection EndGlobal ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/Controllers/HomeController.cs ================================================ using ElectronNET.API; using Microsoft.AspNetCore.Mvc; using System.Threading.Tasks; namespace ElectronNET.Samples.ElectronHostHook.Controllers { public class HomeController : Controller { public async Task Index() { string message = "Electron not active"; if (HybridSupport.IsElectronActive) { // Call the HostHook defined in ElectronHostHook/index.ts var result = await Electron.HostHook.CallAsync("ping", "Hello from C#"); message = $"Sent 'Hello from C#', Received: '{result}'"; } return View("Index", message); } } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronHostHook/.gitignore ================================================ node_modules *.js *.js.map ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronHostHook/connector.ts ================================================ import { Socket } from "socket.io"; export class Connector { constructor(private socket: Socket, public app: any) { } on(key: string, javaScriptCode: Function): void { this.socket.on(key, (...args: any[]) => { const id: string = args.pop(); try { javaScriptCode(...args, (data) => { if (data) { this.socket.emit(`${key}Complete${id}`, data); } }); } catch (error) { this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error); } }); } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronHostHook/index.ts ================================================ import { Connector } from "./connector"; import { Socket } from "socket.io"; export class HookService extends Connector { constructor(socket: Socket, public app: any) { super(socket, app); } onHostReady(): void { // execute your own JavaScript Host logic here this.on("ping", (msg, done) => { console.log("Received ping from C#:", msg); done("pong: " + msg); }); } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronHostHook/package.json ================================================ { "name": "electron-host-hook", "version": "1.0.0", "description": "Connector for Electron.NET projects.", "main": "index.js", "dependencies": { "socket.io": "^4.8.1" }, "devDependencies": { "typescript": "^5.9.3" } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronHostHook/tsconfig.json ================================================ { "compilerOptions": { "module": "commonjs", "target": "ES2019", "sourceMap": true, "skipLibCheck": true }, "exclude": ["node_modules"] } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/ElectronNET.Samples.ElectronHostHook.csproj ================================================ true net10.0 OutOfProcess AspNetCoreModule false commonjs true ElectronHostHook/tsconfig.json true true ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/Program.cs ================================================ using ElectronNET.API; using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; namespace ElectronNET.Samples.ElectronHostHook { public class Program { public static void Main(string[] args) { var builder = WebApplication.CreateBuilder(args); builder.WebHost.UseElectron(args, async () => { var window = await Electron.WindowManager.CreateWindowAsync(); }); builder.Services.AddElectron(); builder.Services.AddControllersWithViews(); var app = builder.Build(); app.UseStaticFiles(); app.UseRouting(); app.MapControllerRoute( name: "default", pattern: "{controller=Home}/{action=Index}/{id?}"); app.Run(); } } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/Properties/electron-builder.json ================================================ { "$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json", "compression": "maximum", "linux": { "target": [ "tar.xz" ], "executableArgs": [ "--no-sandbox" ], "artifactName": "${name}-${arch}-${version}.${ext}" }, "win": { "target": [ { "target": "portable", "arch": "x64" } ] } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/Properties/launchSettings.json ================================================ { "profiles": { "ElectronNET.Samples.ElectronHostHook": { "commandName": "Project", "launchBrowser": false, "applicationUrl": "http://localhost:5000", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } } } } ================================================ FILE: src/ElectronNET.Samples.ElectronHostHook/Views/Home/Index.cshtml ================================================ @model string @{ Layout = null; } ElectronHostHook Sample

ElectronHostHook Sample

This sample demonstrates bidirectional communication between C# and the Electron Host process.

Result: @Model
================================================ FILE: src/ElectronNET.WebApp/Controllers/AboutController.cs ================================================ using Microsoft.AspNetCore.Mvc; namespace ElectronNET.WebApp.Controllers { public class AboutController : Controller { public IActionResult Index() { return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/AppSysInformationController.cs ================================================ using System.Linq; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class AppSysInformationController : Controller { public IActionResult Index() { if(HybridSupport.IsElectronActive) { Electron.IpcMain.On("app-info", async (args) => { string appPath = await Electron.App.GetAppPathAsync(); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "got-app-path", appPath); }); Electron.IpcMain.On("sys-info", async (args) => { string homePath = await Electron.App.GetPathAsync(PathName.Home); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "got-sys-info", homePath); }); Electron.IpcMain.On("screen-info", async (args) => { var display = await Electron.Screen.GetPrimaryDisplayAsync(); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "got-screen-info", display.Size); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/ClipboardController.cs ================================================ using System; using System.Drawing; using System.IO; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using System.Linq; using ElectronNET.API.Entities; using System.Text.Json; namespace ElectronNET.WebApp.Controllers { public class ClipboardController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("copy-to", (text) => { Electron.Clipboard.WriteText(text.ToString()); }); Electron.IpcMain.On("paste-to", async (text) => { Electron.Clipboard.WriteText(text.ToString()); string pasteText = await Electron.Clipboard.ReadTextAsync(); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "paste-from", pasteText); }); Electron.IpcMain.On("copy-image-to", (test) => { var nativeImage = NativeImage.CreateFromDataURL(test.ToString()); Electron.Clipboard.WriteImage(nativeImage); }); Electron.IpcMain.On("paste-image-to", async test => { var nativeImage = await Electron.Clipboard.ReadImageAsync(); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "paste-image-from", JsonSerializer.Serialize(nativeImage)); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/CrashHangController.cs ================================================ using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class CrashHangController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("process-crash", async (args) => { string viewPath = $"http://localhost:{ElectronNetRuntime.AspNetWebPort}/crashhang/processcrash"; var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.WebContents.OnCrashed += async (killed) => { var options = new MessageBoxOptions("This process has crashed.") { Type = MessageBoxType.info, Title = "Renderer Process Crashed", Buttons = new string[] { "Reload", "Close" } }; var result = await Electron.Dialog.ShowMessageBoxAsync(options); if (result.Response == 0) { browserWindow.Reload(); } else { browserWindow.Close(); } }; }); Electron.IpcMain.On("process-hang", async (args) => { string viewPath = $"http://localhost:{ElectronNetRuntime.AspNetWebPort}/crashhang/processhang"; var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.OnUnresponsive += async () => { var options = new MessageBoxOptions("This process is hanging.") { Type = MessageBoxType.info, Title = "Renderer Process Hanging", Buttons = new string[] { "Reload", "Close" } }; var result = await Electron.Dialog.ShowMessageBoxAsync(options); if (result.Response == 0) { browserWindow.Reload(); } else { browserWindow.Close(); } }; }); } return View(); } public IActionResult ProcessCrash() { return View(); } public IActionResult ProcessHang() { return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/DesktopCapturerController.cs ================================================ using Microsoft.AspNetCore.Mvc; namespace ElectronNET.WebApp.Controllers { public class DesktopCapturerController : Controller { public IActionResult Index() { return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/DialogsController.cs ================================================ using System.Linq; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class DialogsController : Controller { public IActionResult Index() { if(HybridSupport.IsElectronActive) { Electron.IpcMain.On("select-directory", async (args) => { var mainWindow = Electron.WindowManager.BrowserWindows.First(); var options = new OpenDialogOptions { Properties = new OpenDialogProperty[] { OpenDialogProperty.openFile, OpenDialogProperty.openDirectory } }; string[] files = await Electron.Dialog.ShowOpenDialogAsync(mainWindow, options); Electron.IpcMain.Send(mainWindow, "select-directory-reply", files); }); Electron.IpcMain.On("error-dialog", (args) => { Electron.Dialog.ShowErrorBox("An Error Message", "Demonstrating a really great message."); }); Electron.IpcMain.On("information-dialog", async (args) => { var options = new MessageBoxOptions("This is an information dialog. Isn't it nice?") { Type = MessageBoxType.info, Title = "Information", Buttons = new string[] { "Yes", "No" } }; var result = await Electron.Dialog.ShowMessageBoxAsync(options); var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "information-dialog-reply", result.Response); }); Electron.IpcMain.On("save-dialog", async (args) => { var mainWindow = Electron.WindowManager.BrowserWindows.First(); var options = new SaveDialogOptions { Title = "Save an Image", Filters = new FileFilter[] { new FileFilter { Name = "Images", Extensions = new string[] {"jpg", "png", "gif" } } } }; var result = await Electron.Dialog.ShowSaveDialogAsync(mainWindow, options); Electron.IpcMain.Send(mainWindow, "save-dialog-reply", result); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/HomeController.cs ================================================ using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using System; namespace ElectronNET.WebApp.Controllers { public class HomeController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { if (OperatingSystem.IsMacOS() || OperatingSystem.IsWindows()) { Electron.PowerMonitor.OnLockScreen += () => { Console.WriteLine("Screen Locked detected from C#"); }; Electron.PowerMonitor.OnUnLockScreen += () => { Console.WriteLine("Screen unlocked detected from C# "); }; Electron.PowerMonitor.OnSuspend += () => { Console.WriteLine("The system is going to sleep"); }; Electron.PowerMonitor.OnResume += () => { Console.WriteLine("The system is resuming"); }; Electron.PowerMonitor.OnAC += () => { Console.WriteLine("The system changes to AC power"); }; Electron.PowerMonitor.OnBattery += () => { Console.WriteLine("The system is about to change to battery power"); }; } } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/HostHookController.cs ================================================ using ElectronNET.API; using ElectronNET.API.Entities; using Microsoft.AspNetCore.Mvc; using System.Linq; namespace ElectronNET.WebApp.Controllers { public class HostHookController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("start-hoosthook", async (args) => { var mainWindow = Electron.WindowManager.BrowserWindows.First(); var options = new OpenDialogOptions { Properties = new OpenDialogProperty[] { OpenDialogProperty.openDirectory } }; var folderPath = await Electron.Dialog.ShowOpenDialogAsync(mainWindow, options); var resultFromTypeScript = await Electron.HostHook.CallAsync("create-excel-file", folderPath); Electron.IpcMain.Send(mainWindow, "excel-file-created", resultFromTypeScript); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/IpcController.cs ================================================ using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using System.Linq; namespace ElectronNET.WebApp.Controllers { public class IpcController : Controller { public IActionResult Index() { if(HybridSupport.IsElectronActive) { Electron.IpcMain.On("async-msg", (args) => { var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "asynchronous-reply", "pong"); }); Electron.IpcMain.OnSync("sync-msg", (args) => { return "pong"; }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/ManageWindowsController.cs ================================================ using System; using System.Collections.Generic; using System.Linq; using System.Threading.Tasks; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class WindowsController : Controller { public IActionResult Index() { string viewPath = $"http://localhost:{BridgeSettings.WebPort}/windows/demowindow"; Electron.IpcMain.On("new-window", async (args) => { await Electron.WindowManager.CreateWindowAsync(viewPath); }); Electron.IpcMain.On("manage-window", async (args) => { var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.OnMove += UpdateReply; browserWindow.OnResize += UpdateReply; }); Electron.IpcMain.On("listen-to-window", async (args) => { var mainBrowserWindow = Electron.WindowManager.BrowserWindows.First(); var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.OnFocus += () => Electron.IpcMain.Send(mainBrowserWindow, "listen-to-window-focus"); browserWindow.OnBlur += () => Electron.IpcMain.Send(mainBrowserWindow, "listen-to-window-blur"); Electron.IpcMain.On("listen-to-window-set-focus", (x) => browserWindow.Focus()); }); Electron.IpcMain.On("frameless-window", async (args) => { var options = new BrowserWindowOptions { Frame = false }; await Electron.WindowManager.CreateWindowAsync(options, viewPath); }); return View(); } private async void UpdateReply() { var browserWindow = Electron.WindowManager.BrowserWindows.Last(); var size = await browserWindow.GetSizeAsync(); var position = await browserWindow.GetPositionAsync(); string message = $"Size: {size[0]},{size[1]} Position: {position[0]},{position[1]}"; var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "manage-window-reply", message); } public IActionResult DemoWindow() { return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/MenusController.cs ================================================ using System.Linq; using Microsoft.AspNetCore.Mvc; using ElectronNET.API.Entities; using ElectronNET.API; namespace ElectronNET.WebApp.Controllers { public class MenusController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.App.Ready += () => CreateContextMenu(); var menu = new MenuItem[] { new MenuItem { Label = "Edit", Submenu = new MenuItem[] { new MenuItem { Label = "Undo", Accelerator = "CmdOrCtrl+Z", Role = MenuRole.undo }, new MenuItem { Label = "Redo", Accelerator = "Shift+CmdOrCtrl+Z", Role = MenuRole.redo }, new MenuItem { Type = MenuType.separator }, new MenuItem { Label = "Cut", Accelerator = "CmdOrCtrl+X", Role = MenuRole.cut }, new MenuItem { Label = "Copy", Accelerator = "CmdOrCtrl+C", Role = MenuRole.copy }, new MenuItem { Label = "Paste", Accelerator = "CmdOrCtrl+V", Role = MenuRole.paste }, new MenuItem { Label = "Select All", Accelerator = "CmdOrCtrl+A", Role = MenuRole.selectall } } }, new MenuItem { Label = "View", Submenu = new MenuItem[] { new MenuItem { Label = "Reload", Accelerator = "CmdOrCtrl+R", Click = () => { // on reload, start fresh and close any old // open secondary windows var mainWindowId = Electron.WindowManager.BrowserWindows.ToList().First().Id; Electron.WindowManager.BrowserWindows.ToList().ForEach(browserWindow => { if(browserWindow.Id != mainWindowId) { browserWindow.Close(); } else { browserWindow.Reload(); } }); } }, new MenuItem { Label = "Toggle Full Screen", Accelerator = "CmdOrCtrl+F", Click = async () => { bool isFullScreen = await Electron.WindowManager.BrowserWindows.First().IsFullScreenAsync(); Electron.WindowManager.BrowserWindows.First().SetFullScreen(!isFullScreen); } }, new MenuItem { Label = "Open Developer Tools", Accelerator = "CmdOrCtrl+I", Click = () => Electron.WindowManager.BrowserWindows.First().WebContents.OpenDevTools() }, new MenuItem { Type = MenuType.separator }, new MenuItem { Label = "App Menu Demo", Click = async () => { var options = new MessageBoxOptions("This demo is for the Menu section, showing how to create a clickable menu item in the application menu."); options.Type = MessageBoxType.info; options.Title = "Application Menu Demo"; await Electron.Dialog.ShowMessageBoxAsync(options); } } } }, new MenuItem { Label = "Window", Role = MenuRole.window, Submenu = new MenuItem[] { new MenuItem { Label = "Minimize", Accelerator = "CmdOrCtrl+M", Role = MenuRole.minimize }, new MenuItem { Label = "Close", Accelerator = "CmdOrCtrl+W", Role = MenuRole.close } } }, new MenuItem { Label = "Help", Role = MenuRole.help, Submenu = new MenuItem[] { new MenuItem { Label = "Learn More", Click = async () => await Electron.Shell.OpenExternalAsync("https://github.com/ElectronNET") } } } }; Electron.Menu.SetApplicationMenu(menu); } return View(); } private void CreateContextMenu() { var menu = new MenuItem[] { new MenuItem { Label = "Hello", Click = async () => await Electron.Dialog.ShowMessageBoxAsync("Electron.NET rocks!") }, new MenuItem { Type = MenuType.separator }, new MenuItem { Label = "Electron.NET", Type = MenuType.checkbox, Checked = true } }; var mainWindow = Electron.WindowManager.BrowserWindows.FirstOrDefault(); Electron.Menu.SetContextMenu(mainWindow, menu); Electron.IpcMain.On("show-context-menu", (args) => { var mainWindow = Electron.WindowManager.BrowserWindows.FirstOrDefault(); Electron.Menu.ContextMenuPopup(mainWindow); }); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/NotificationsController.cs ================================================ using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class NotificationsController : Controller { public IActionResult Index() { if(HybridSupport.IsElectronActive) { Electron.IpcMain.On("basic-noti", (args) => { var options = new NotificationOptions("Basic Notification", "Short message part") { OnClick = async () => await Electron.Dialog.ShowMessageBoxAsync("Notification clicked") }; Electron.Notification.Show(options); }); Electron.IpcMain.On("advanced-noti", (args) => { var options = new NotificationOptions("Notification with image", "Short message plus a custom image") { OnClick = async () => await Electron.Dialog.ShowMessageBoxAsync("Notification clicked"), Icon = "/assets/img/programming.png" }; Electron.Notification.Show(options); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/PdfController.cs ================================================ using System.Linq; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class PdfController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("print-pdf", async (args) => { BrowserWindow mainWindow = Electron.WindowManager.BrowserWindows.First(); var saveOptions = new SaveDialogOptions { Title = "Save an PDF-File", DefaultPath = await Electron.App.GetPathAsync(PathName.Documents), Filters = new FileFilter[] { new FileFilter { Name = "PDF", Extensions = new string[] { "pdf" } } } }; var path = await Electron.Dialog.ShowSaveDialogAsync(mainWindow, saveOptions); if (await mainWindow.WebContents.PrintToPDFAsync(path)) { await Electron.Shell.OpenExternalAsync("file://" + path); } else { Electron.Dialog.ShowErrorBox("Error", "Failed to create pdf file."); } }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/ShellController.cs ================================================ using ElectronNET.API; using ElectronNET.API.Entities; using Microsoft.AspNetCore.Mvc; namespace ElectronNET.WebApp.Controllers { public class ShellController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("open-file-manager", async (args) => { string path = await Electron.App.GetPathAsync(PathName.Home); await Electron.Shell.ShowItemInFolderAsync(path); }); Electron.IpcMain.On("open-ex-links", async (args) => { await Electron.Shell.OpenExternalAsync("https://github.com/ElectronNET"); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/ShortcutsController.cs ================================================ using ElectronNET.API; using ElectronNET.API.Entities; using Microsoft.AspNetCore.Mvc; using System.Threading.Tasks; namespace ElectronNET.WebApp.Controllers { public class ShortcutsController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.GlobalShortcut.Register("CommandOrControl+Alt+K", async () => { var options = new MessageBoxOptions("You pressed the registered global shortcut keybinding.") { Type = MessageBoxType.info, Title = "Success!" }; await Electron.Dialog.ShowMessageBoxAsync(options); }); Electron.App.WillQuit += arg => Task.Run(() => Electron.GlobalShortcut.UnregisterAll()); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/TrayController.cs ================================================ using System.IO; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; using Microsoft.AspNetCore.Hosting; namespace ElectronNET.WebApp.Controllers { public class TrayController : Controller { private readonly IWebHostEnvironment _env; public TrayController(IWebHostEnvironment env) { _env = env; } public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.IpcMain.On("put-in-tray", (args) => { if (Electron.Tray.MenuItems.Count == 0) { var menu = new MenuItem { Label = "Remove", Click = () => Electron.Tray.Destroy() }; Electron.Tray.Show(Path.Combine(_env.ContentRootPath, "Assets/electron_32x32.png"), menu); Electron.Tray.SetToolTip("Electron Demo in the tray."); } else { Electron.Tray.Destroy(); } }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/UpdateController.cs ================================================ using System.Linq; using ElectronNET.API; using Microsoft.AspNetCore.Mvc; namespace ElectronNET.WebApp.Controllers { public class UpdateController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { Electron.AutoUpdater.OnError += (message) => Electron.Dialog.ShowErrorBox("Error", message); Electron.AutoUpdater.OnCheckingForUpdate += async () => await Electron.Dialog.ShowMessageBoxAsync("Checking for Update"); Electron.AutoUpdater.OnUpdateNotAvailable += async (info) => await Electron.Dialog.ShowMessageBoxAsync("Update not available"); Electron.AutoUpdater.OnUpdateAvailable += async (info) => await Electron.Dialog.ShowMessageBoxAsync("Update available" + info.Version); Electron.AutoUpdater.OnDownloadProgress += (info) => { var message1 = "Download speed: " + info.BytesPerSecond + "\n
"; var message2 = "Downloaded " + info.Percent + "%" + "\n
"; var message3 = $"({info.Transferred}/{info.Total})" + "\n
"; var message4 = "Progress: " + info.Progress + "\n
"; var information = message1 + message2 + message3 + message4; var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "auto-update-reply", information); }; Electron.AutoUpdater.OnUpdateDownloaded += async (info) => await Electron.Dialog.ShowMessageBoxAsync("Update complete!" + info.Version); Electron.IpcMain.On("auto-update", async (args) => { // Electron.NET CLI Command for deploy: // electronize build /target win /electron-params --publish=always var currentVersion = await Electron.App.GetVersionAsync(); var updateCheckResult = await Electron.AutoUpdater.CheckForUpdatesAndNotifyAsync(); var availableVersion = updateCheckResult.UpdateInfo.Version; string information = $"Current version: {currentVersion} - available version: {availableVersion}"; var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "auto-update-reply", information); }); } return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/Controllers/WindowsController.cs ================================================ using System.Linq; using Microsoft.AspNetCore.Mvc; using ElectronNET.API; using ElectronNET.API.Entities; namespace ElectronNET.WebApp.Controllers { public class WindowsController : Controller { public IActionResult Index() { if (HybridSupport.IsElectronActive) { string viewPath = $"http://localhost:{ElectronNetRuntime.AspNetWebPort}/windows/demowindow"; Electron.IpcMain.On("new-window", async (args) => { await Electron.WindowManager.CreateWindowAsync(viewPath); }); Electron.IpcMain.On("manage-window", async (args) => { var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.OnMove += UpdateReply; browserWindow.OnResize += UpdateReply; }); Electron.IpcMain.On("listen-to-window", async (args) => { var mainBrowserWindow = Electron.WindowManager.BrowserWindows.First(); var browserWindow = await Electron.WindowManager.CreateWindowAsync(viewPath); browserWindow.OnFocus += () => Electron.IpcMain.Send(mainBrowserWindow, "listen-to-window-focus"); browserWindow.OnBlur += () => Electron.IpcMain.Send(mainBrowserWindow, "listen-to-window-blur"); _ = Electron.IpcMain.On("listen-to-window-set-focus", (x) => browserWindow.Focus()); }); Electron.IpcMain.On("frameless-window", async (args) => { var options = new BrowserWindowOptions { Frame = false }; await Electron.WindowManager.CreateWindowAsync(options, viewPath); }); } return View(); } private async void UpdateReply() { var browserWindow = Electron.WindowManager.BrowserWindows.Last(); var size = await browserWindow.GetSizeAsync(); var position = await browserWindow.GetPositionAsync(); string message = $"Size: {size[0]},{size[1]} Position: {position[0]},{position[1]}"; var mainWindow = Electron.WindowManager.BrowserWindows.First(); Electron.IpcMain.Send(mainWindow, "manage-window-reply", message); } public IActionResult DemoWindow() { return View(); } } } ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/.gitignore ================================================ # Created by https://www.gitignore.io/api/node # Edit at https://www.gitignore.io/?templates=node ### Node ### # Logs logs *.log npm-debug.log* yarn-debug.log* yarn-error.log* lerna-debug.log* # Diagnostic reports (https://nodejs.org/api/report.html) report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json # Runtime data pids *.pid *.seed *.pid.lock # Directory for instrumented libs generated by jscoverage/JSCover lib-cov # Coverage directory used by tools like istanbul coverage # nyc test coverage .nyc_output # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) .grunt # Bower dependency directory (https://bower.io/) bower_components # node-waf configuration .lock-wscript # Compiled binary addons (https://nodejs.org/api/addons.html) build/Release # Dependency directories node_modules/ jspm_packages/ # TypeScript v1 declaration files typings/ # Optional npm cache directory .npm # Optional eslint cache .eslintcache # Optional REPL history .node_repl_history # Output of 'npm pack' *.tgz # Yarn Integrity file .yarn-integrity # dotenv environment variables file .env .env.test # parcel-bundler cache (https://parceljs.org/) .cache # next.js build output .next # nuxt.js build output .nuxt # vuepress build output .vuepress/dist # Serverless directories .serverless/ # FuseBox cache .fusebox/ # DynamoDB Local files .dynamodb/ # End of https://www.gitignore.io/api/node ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/connector.js ================================================ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.Connector = void 0; class Connector { constructor(socket, app) { this.socket = socket; this.app = app; } on(key, javaScriptCode) { this.socket.on(key, (...args) => { const id = args.pop(); try { javaScriptCode(...args, (data) => { if (data) { this.socket.emit(`${key}Complete${id}`, data); } }); } catch (error) { this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error); } }); } } exports.Connector = Connector; //# sourceMappingURL=connector.js.map ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/connector.ts ================================================ import { Socket } from 'socket.io'; export class Connector { constructor(private socket: Socket, public app: any) { } on(key: string, javaScriptCode: Function): void { this.socket.on(key, (...args: any[]) => { const id: string = args.pop(); try { javaScriptCode(...args, (data) => { if (data) { this.socket.emit(`${key}Complete${id}`, data); } }); } catch (error) { this.socket.emit(`${key}Error${id}`, `Host Hook Exception`, error); } }); } } ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/excelCreator.js ================================================ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.ExcelCreator = void 0; const exceljs_1 = require("exceljs"); class ExcelCreator { async create(path) { const workbook = new exceljs_1.Workbook(); const worksheet = workbook.addWorksheet("My Sheet"); worksheet.columns = [ { header: "Id", key: "id", width: 10 }, { header: "Name", key: "name", width: 32 }, { header: "Birthday", key: "birthday", width: 10, outlineLevel: 1 } ]; worksheet.addRow({ id: 1, name: "John Doe", birthday: new Date(1970, 1, 1) }); worksheet.addRow({ id: 2, name: "Jane Doe", birthday: new Date(1965, 1, 7) }); await workbook.xlsx.writeFile(path + "\\sample.xlsx"); return "Excel file created YAY YAY!"; } } exports.ExcelCreator = ExcelCreator; //# sourceMappingURL=excelCreator.js.map ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/excelCreator.ts ================================================ import { Workbook, Worksheet } from "exceljs"; export class ExcelCreator { async create(path: string): Promise { const workbook: Workbook = new Workbook(); const worksheet: Worksheet = workbook.addWorksheet("My Sheet"); worksheet.columns = [ { header: "Id", key: "id", width: 10 }, { header: "Name", key: "name", width: 32 }, { header: "Birthday", key: "birthday", width: 10, outlineLevel: 1 } ]; worksheet.addRow({ id: 1, name: "John Doe", birthday: new Date(1970, 1, 1) }); worksheet.addRow({ id: 2, name: "Jane Doe", birthday: new Date(1965, 1, 7) }); await workbook.xlsx.writeFile(path + "\\sample.xlsx"); return "Excel file created YAY YAY!"; } } ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/index.js ================================================ "use strict"; Object.defineProperty(exports, "__esModule", { value: true }); exports.HookService = void 0; const connector_1 = require("./connector"); const excelCreator_1 = require("./excelCreator"); class HookService extends connector_1.Connector { constructor(socket, app) { super(socket, app); this.app = app; } onHostReady() { // execute your own JavaScript Host logic here this.on("create-excel-file", async (path, done) => { const excelCreator = new excelCreator_1.ExcelCreator(); const result = await excelCreator.create(path); done(result); }); } } exports.HookService = HookService; //# sourceMappingURL=index.js.map ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/index.ts ================================================ import { Connector } from "./connector"; import { Socket } from "socket.io"; import { ExcelCreator } from './excelCreator'; export class HookService extends Connector { constructor(socket: Socket, public app: any) { super(socket, app); } onHostReady(): void { // execute your own JavaScript Host logic here this.on("create-excel-file", async (path, done) => { const excelCreator: ExcelCreator = new ExcelCreator(); const result: string = await excelCreator.create(path); done(result); }); } } ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/package.json ================================================ { "name": "electron-host-hook", "version": "1.0.0", "description": "Connector for Electron.NET projects.", "repository": { "url": "https://github.com/ElectronNET/Electron.NET" }, "main": "index.js", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], "author": "Gregor Biswanger", "license": "MIT", "devDependencies": { "eslint": "^9.37.0", "typescript": "^5.9.3" }, "dependencies": { "archiver-utils": "^2.1.0", "socket.io": "^4.8.1", "exceljs": "^1.10.0" } } ================================================ FILE: src/ElectronNET.WebApp/ElectronHostHook/tsconfig.json ================================================ { "compilerOptions": { "module": "commonjs", "target": "ES2019", "sourceMap": true, "skipLibCheck": true }, "exclude": [ "node_modules" ] } ================================================ FILE: src/ElectronNET.WebApp/ElectronNET.WebApp.csproj ================================================ true net10.0 OutOfProcess AspNetCoreModule false false false false 128.png wwwroot\assets\app-icon\win\app.ico true wwwroot\assets\app-icon\win\app.ico ElectronNET API Demo1 1.0.2 com.electronnet-apisamples.app Electron.NET Demo Application Electron.Net Copyright © 2025, Electron.NET Electron;.NET;ASP;NET;Sample;App 30.4.0 wwwroot\assets\img\about@2x.png MIT false win-x64 26.0 commonjs true ElectronHostHook/tsconfig.json true true disable PreserveNewest PreserveNewest ================================================ FILE: src/ElectronNET.WebApp/Program.cs ================================================ using ElectronNET.API; using Microsoft.AspNetCore; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Logging; namespace ElectronNET.WebApp { using System.Threading.Tasks; using ElectronNET.API.Entities; public class Program { public static void Main(string[] args) { CreateWebHostBuilder(args).Build().Run(); } public static IWebHostBuilder CreateWebHostBuilder(string[] args) { return WebHost.CreateDefaultBuilder(args) .ConfigureLogging((hostingContext, logging) => { logging.AddConsole(); }) .UseElectron(args, ElectronBootstrap) .UseStartup(); } public static async Task ElectronBootstrap() { //AddDevelopmentTests(); var browserWindow = await Electron.WindowManager.CreateWindowAsync(new BrowserWindowOptions { Width = 1152, Height = 940, Show = false }); await browserWindow.WebContents.Session.ClearCacheAsync(); browserWindow.OnReadyToShow += () => browserWindow.Show(); } private static void AddDevelopmentTests() { // NOTE: on mac you will need to allow the app to post notifications when asked. _ = Electron.App.On("activate", (obj) => { // obj should be a boolean that represents where there are active windows or not. var hasWindows = (bool)obj; Electron.Notification.Show( new NotificationOptions("Activate", $"activate event has been captured. Active windows = {hasWindows}") { Silent = false, }); }); if (System.OperatingSystem.IsMacOS()) { Electron.Dock.SetMenu(new[] { new MenuItem { Type = MenuType.normal, Label = "MenuItem", Click = () => { Electron.Notification.Show(new NotificationOptions( "Dock MenuItem Click", "A menu item added to the Dock was selected;")); }, }, new MenuItem { Type = MenuType.submenu, Label = "SubMenu", Submenu = new[] { new MenuItem { Type = MenuType.normal, Label = "Sub MenuItem", Click = () => { Electron.Notification.Show(new NotificationOptions( "Dock Sub MenuItem Click", "A menu item added to the Dock was selected;")); }, }, } } }); } } } } ================================================ FILE: src/ElectronNET.WebApp/Properties/PublishProfiles/linux-x64.pubxml ================================================  true false true Release FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 linux-x64 6ea447d9-343f-46b8-b456-66557bddbb9f true Any CPU ================================================ FILE: src/ElectronNET.WebApp/Properties/PublishProfiles/win-x64.pubxml ================================================  true false true Release FileSystem publish\$(Configuration)\$(TargetFramework)\$(RuntimeIdentifier)\ FileSystem <_TargetId>Folder net10.0 win-x64 6ea447d9-343f-46b8-b456-66557bddbb9f true Any CPU ================================================ FILE: src/ElectronNET.WebApp/Properties/electron-builder.json ================================================ { "$schema": "https://raw.githubusercontent.com/electron-userland/electron-builder/refs/heads/master/packages/app-builder-lib/scheme.json", "compression": "maximum", //"afterPack": "bin/Assets/afterPack.js", //"beforePack": "bin/Assets/beforePack.js", "buildNumber": "", "linux": { "target": [ "tar.xz" //"AppImage", //"rpm", //"deb", //"pacman" ], "executableArgs": [ "--no-sandbox" ], "icon": "bin/Assets/icon.png", "artifactName": "${name}-${arch}-${version}.${ext}" }, "win": { "target": [ { "target": "portable", "arch": "x64" } ], "icon": "bin/Assets/icon.ico" }, "mac": { "icon": "bin/Assets/icon.icns" } } ================================================ FILE: src/ElectronNET.WebApp/Properties/launchSettings.json ================================================ { "profiles": { "ASP.Net (unpackaged)": { "commandName": "Project", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" }, "applicationUrl": "http://localhost:8001/" }, "Electron (unpackaged)": { "commandName": "Executable", "executablePath": "node", "commandLineArgs": "node_modules/electron/cli.js main.js -unpackedelectron", "workingDirectory": "$(TargetDir).electron", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development" } }, "WSL": { "commandName": "WSL2", "launchUrl": "http://localhost:8001/", "environmentVariables": { "ASPNETCORE_ENVIRONMENT": "Development", "ASPNETCORE_URLS": "http://localhost:8001/" }, "distributionName": "" } } } ================================================ FILE: src/ElectronNET.WebApp/Startup.cs ================================================ using Microsoft.AspNetCore.Builder; using Microsoft.AspNetCore.Hosting; using Microsoft.Extensions.Configuration; using Microsoft.Extensions.DependencyInjection; using Microsoft.Extensions.Hosting; namespace ElectronNET.WebApp { public class Startup { public IConfiguration Configuration { get; } public Startup(IConfiguration configuration) { Configuration = configuration; } // This method gets called by the runtime. Use this method to add services to the container. // For more information on how to configure your application, visit https://go.microsoft.com/fwlink/?LinkID=398940 public void ConfigureServices(IServiceCollection services) { services.AddMvc(); } // This method gets called by the runtime. Use this method to configure the HTTP request pipeline. public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { if (env.IsDevelopment()) { app.UseDeveloperExceptionPage(); } app.UseStaticFiles(); app.UseRouting(); app.UseEndpoints(endpoints => { endpoints.MapControllerRoute("default", "{controller=Home}/{action=Index}/{id?}"); }); } } } ================================================ FILE: src/ElectronNET.WebApp/Views/About/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/AppSysInformation/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Clipboard/Index.cshtml ================================================ ================================================ FILE: src/ElectronNET.WebApp/Views/CrashHang/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/CrashHang/ProcessCrash.cshtml ================================================ 

Click the text below to crash and then reload this process.

Crash this process ================================================ FILE: src/ElectronNET.WebApp/Views/CrashHang/ProcessHang.cshtml ================================================ 

Click the text below to hang and then reload this process.

(This will take up to 30 seconds.) Hang this process ================================================ FILE: src/ElectronNET.WebApp/Views/DesktopCapturer/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Dialogs/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Home/Index.cshtml ================================================ 
================================================ FILE: src/ElectronNET.WebApp/Views/HostHook/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Ipc/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Menus/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Notifications/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Pdf/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Shell/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Shortcuts/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Tray/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Update/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Windows/DemoWindow.cshtml ================================================ 

Hello World!

Close this Window ================================================ FILE: src/ElectronNET.WebApp/Views/Windows/HandleErrorCrashes.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/Views/Windows/Index.cshtml ================================================  ================================================ FILE: src/ElectronNET.WebApp/appsettings.Development.json ================================================ { "Logging": { "LogLevel": { "Default": "Debug", "System": "Information", "Microsoft": "Information" } } } ================================================ FILE: src/ElectronNET.WebApp/appsettings.json ================================================ { "Logging": { "LogLevel": { "Default": "Warning" } }, "DemoTitleInSettings": "Electron.NET API Demos" } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/code-blocks.js ================================================ document.addEventListener('DOMContentLoaded', function () { setTimeout(() => { const codeBlocks = document.querySelectorAll('pre code'); Array.prototype.forEach.call(codeBlocks, function (code) { hljs.highlightBlock(code) }); }, 1000); }) ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/about.css ================================================ /* Welcome ------------------------ */ .about { --about-space: 2rem; position: absolute; display: flex; top: 0; left: 0; right: 0; bottom: 0; z-index: 1; overflow-x: hidden; overflow-y: auto; padding: 0; background-color: hsl(0,0%,98%); pointer-events: none; visibility: hidden; opacity: 0; transform: scale(1.1); transition: visibility 0s .12s linear , opacity .12s ease-in, transform .12s ease-in; } .about.is-shown { pointer-events: auto; visibility: visible; opacity: 1; transform: scale(1); transition: visibility 0s 0s linear , opacity .24s ease-out, transform .24s ease-out; } .about-wrapper { margin: auto; } .about-header { padding: var(--about-space) 0; border-bottom: 1px solid hsl(0,0%,88%); } .about-logo { display: block; margin: 0 auto; width: 320px; /* TODO: Adjust asset to this size */ max-width: 100%; } .about-sections { max-width: 680px; padding: 0 var(--about-space); } .about-section { margin: var(--about-space) 0; } .about h2 { text-align: center; margin: 0 0 1em 0; font-size: 1.5em; color: hsl(0, 0%, 55%); } .about .about-code h2 { color: hsl(330, 65%, 55%); } .about .play-along h2 { color: hsl(222, 53%, 50%); } .about-button { display: block; margin: 0 auto; padding: .4em 1.2em; font: inherit; font-size: 1.6em; color: inherit; border: 2px solid; border-radius: 4px; background-color: transparent; } .about-button:focus { outline: none; border-color: hsl(0,0%,88%); } footer.about-section { text-align: center; } .rainbow-button-wrapper { --rainbow-button-width: 170px; --rainbow-button-height: 50px; --rainbow-button-width-inner: 164px; --rainbow-button-height-inner: 44px; --rainbow-color-1: hsl(116, 30%, 36%); --rainbow-color-2: hsl(194, 60%, 36%); --rainbow-color-3: hsl(222, 53%, 50%); --rainbow-color-4: hsl(285, 47%, 46%); --rainbow-color-5: hsl(330, 65%, 48%); --rainbow-color-6: hsl(32, 79%, 49%); --rainbow-color-7: hsl(53, 84%, 50%); display: inline-block; width: var(--rainbow-button-width); height: var(--rainbow-button-height); position: relative; overflow: hidden; border-radius: 5px; } .rainbow-button-wrapper:before { display: block; position: absolute; z-index: 2; top: 0; left: 0; width: 600px; height: var(--rainbow-button-height); background: #CCC; background: linear-gradient(to right, var(--rainbow-color-1) 0%, var(--rainbow-color-2) 14%, var(--rainbow-color-3) 28%, var(--rainbow-color-4) 42%, var(--rainbow-color-5) 56%, var(--rainbow-color-6) 70%, var(--rainbow-color-7) 84%, var(--rainbow-color-1) 100%); background-position: -200px 0; transition: all 0.5s; content: ""; } .rainbow-button-wrapper button { display: block; width: var(--rainbow-button-width-inner); height: var(--rainbow-button-height-inner); position: absolute; z-index: 3; top: 3px; left: 3px; border: none; background: white; color: black; font-size: 1.3rem; } .rainbow-button-wrapper:hover:before { background-position: 200px 0; } @media (min-width: 940px) { .about-header { align-self: center; padding: var(--about-space); border-right: 1px solid hsl(0,0%,88%); border-bottom: none; } .about-wrapper { display: flex; } } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/demo.css ================================================ /* Demo */ .demo:first-of-type { margin-top: 2rem; } .demo:last-of-type { margin-bottom: 2rem; } @media (min-width: 940px) { .demo:last-of-type { margin-bottom: 4rem; } } .demo-wrapper { position: relative; max-width: 740px; margin: 0 auto; padding: 0 2rem; } /* Toggle Button ----------------------------- */ .demo-toggle-button { position: relative; display: block; margin: 0; padding: .5em 1.5em; line-height: 1.5; font: inherit; font-weight: 600; font-size: 1.2em; text-align: left; border: none; color: inherit; background-color: transparent; transition: border-color .12s; outline: none; } .demo-toggle-button:before, .demo-toggle-button:after { content: ""; position: absolute; left: 0; width: 2px; height: 50%; background-color: hsl(0,0%,88%); transition: transform .2s cubic-bezier(.4,.1,0,1); } .demo-toggle-button:before { top: 0; transform-origin: bottom center; transform: translateX(.7em) rotate(-30deg) scale(.75); } .demo-toggle-button:after { bottom: 0; transform-origin: top center; transform: translateX(.7em) rotate(30deg) scale(.75); } .is-open .demo-toggle-button:before, .is-open .demo-toggle-button:after { transform: rotate(0deg); } .demo-toggle-button:focus:before, .demo-toggle-button:focus:after { background-color: currentColor; } /* Meta info */ .demo-meta { margin-top: .2em; font-size: 11px; font-weight: 300; text-transform: uppercase; color: var(--color-subtle); } .demo-meta-divider { margin: 0 .5em; } /* Demo Box ----------------------------- */ .demo-box { display: none; position: relative; padding: 2em; margin-top: 1em; margin-bottom: 2em; border-radius: 6px; border: 1px solid var(--color-border); background-color: var(--color-bg); } .demo-box:before { content: ""; position: absolute; top: -11px; width: 20px; height: 20px; background-color: inherit; border-top: inherit; border-right: inherit; border-top-right-radius: 3px; transform: rotate(-45deg); } .is-open .demo-box { display: block; animation: demo-box-fade-in .2s cubic-bezier(0, .20, .20, .96); } @keyframes demo-box-fade-in { 0% { opacity: 0; transform: translateY(-20px); } 100% { opacity: 1; transform: translateY(0); } } .demo-box > p:first-child { margin-top: 0; } .demo-box h5 { font-size: 1em; margin-bottom: .6em; } /* Demo Controls ----------------------------- */ .demo-controls { display: flex; align-items: center; } .demo-button { align-self: flex-start; margin-right: 1em; border: 2px solid; border-radius: 4px; font: inherit; font-size: 1.2em; padding: .4em 1.2em; color: inherit; background-color: transparent; } .demo-button:focus { outline: none; background-color: white; } .demo-button:active { border-color: var(--color-border); } .demo-input { flex: 1; border: 2px solid var(--color-border); border-radius: 4px; font: inherit; font-size: 1.2em; padding: .4em .8em; color: inherit; background-color: transparent; } .demo-input:focus { outline: none; border-color: hsl(0,0%,80%); background-color: white; } .demo-response { flex: 1; word-break: break-word; } .smooth-appear { opacity: 1; transition: opacity .5s ease-in-out; } .disappear { opacity: 0; } .demo-button.smooth-disappear:focus { outline: inherit; border-color: inherit; background-color: inherit; } /* ProTip ----------------------------- */ .demo-protip { margin-top: 2rem; padding: 1.5rem 2rem 2rem 2rem; border: 1px solid hsla(0,0%,0%,.06); border-radius: 6px; background: var(--color-accent) linear-gradient(hsla(0,0%,100%,.85), hsla(0,0%,100%,.85)); } .demo-protip h2 { margin: 0 0 .5rem 0; } .demo-protip strong { font-weight: 600; } /* Clipboard paste image ------------------ */ .demo-image-box { padding-left: 15px; } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/github.css ================================================ /* github.com style (c) Vasily Polovnyov */ .hljs { display: block; overflow-x: auto; padding: 0.5em; color: #333; background: #f8f8f8; } .hljs-comment, .hljs-quote { color: #998; font-style: italic; } .hljs-keyword, .hljs-selector-tag, .hljs-subst { color: #333; font-weight: bold; } .hljs-number, .hljs-literal, .hljs-variable, .hljs-template-variable, .hljs-tag .hljs-attr { color: #008080; } .hljs-string, .hljs-doctag { color: #d14; } .hljs-title, .hljs-section, .hljs-selector-id { color: #900; font-weight: bold; } .hljs-subst { font-weight: normal; } .hljs-type, .hljs-class .hljs-title { color: #458; font-weight: bold; } .hljs-tag, .hljs-name, .hljs-attribute { color: #000080; font-weight: normal; } .hljs-regexp, .hljs-link { color: #009926; } .hljs-symbol, .hljs-bullet { color: #990073; } .hljs-built_in, .hljs-builtin-name { color: #0086b3; } .hljs-meta { color: #999; font-weight: bold; } .hljs-deletion { background: #fdd; } .hljs-addition { background: #dfd; } .hljs-emphasis { font-style: italic; } .hljs-strong { font-weight: bold; } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/global.css ================================================ /* Fonts ---------------------------- */ @font-face { font-family: 'Source Code Pro'; font-style: normal; font-weight: 400; src: local('Source Code Pro'), local('SourceCodePro'), url(fonts/SourceCodePro-Regular.ttf) format('truetype'); } /* Global ---------------------------- */ * { box-sizing: border-box; } html { height: 100%; font-family: 'BlinkMacSystemFont', 'Lucida Grande', 'Segoe UI', Ubuntu, Cantarell, sans-serif; font-size: 14px; line-height: 1.5; overflow: hidden; /* Prevents rubber-band scrolling of the whole "page" */ color: var(--color); background-color: #fff; /* To cover OSes with no default background color */ } body { margin: 0; height: 100%; display: flex; } a { color: var(--color-link); } h1, h2, h3 { margin-top: 0; line-height: 1.5; } h1 { font-size: 1.5em; font-weight: 600; } h2 { font-size: 1.3em; font-weight: normal; } h3 { font-size: 1.12em; font-weight: 600; } table { width: 100%; border-spacing: 0; border: 1px solid hsla(0,0%,0%,.08); border-width: 0 1px 1px 0; } th { background-color: hsla(0,0%,50%,.06); } th, td { text-align: center; border: 1px solid hsla(0,0%,0%,.08); border-width: 1px 0 0 1px; } svg { fill: currentColor; } /* Code */ code, kbd { font-family: 'Source Code Pro', monospace; border-radius: 4px; padding: 1px 4px; white-space: nowrap; color: hsl(0,0%,36%); background-color: hsla(0,0%,60%,.15); } pre, kbd { font-size: 13px; overflow: auto; padding: 1em; margin: 0; border-radius: 4px; border: 1px solid; border-color: var(--color-border); background-color: white; } pre code { white-space: pre; } pre > .hljs { color: var(--color-subtle); background-color: white; } kbd { padding: 0.5em; } /* Utilities ---------------------------- */ .u-avoid-clicks { pointer-events: none; } /* Visually hidden, but will be read by screen readers */ .u-visible-to-screen-reader { position: absolute; width: 1px; height: 1px; padding: 0; margin: -1px; overflow: hidden; clip: rect(0, 0, 0, 0); border: 0; } .no-display { display: none; } /* Content ------------------ */ .content { flex: 1; position: relative; overflow: hidden; visibility: hidden; opacity: 0; } .content.is-shown { visibility: visible;; opacity: 1; } /* Hacks ---------------------------- */ /* Fixes horizontal scrolling in code blocks on OS X El Cap (10.11.3), retina screen * * By adding an invisible outline property, it will force a repaint * which enables the scrolling. */ .hljs:hover, .hljs:active { outline: 1px solid transparent; } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/nativize.css ================================================ /* ** nativize.css ** Makes the UI feel more native */ html { font-family: sans-serif; -webkit-user-select: none; /* disable selection */ -webkit-user-drag: none; /* disable dragging */ cursor: default; /* use default cursor */ } body { margin: 0; /* remove default margin */ } /* enable text selection */ /*.is-selectable,*/ pre, code { -webkit-user-select: auto; user-select: text; cursor: auto; } /* Buttons and links */ button{ cursor: default; } /* Internal links */ a { cursor: pointer; text-decoration: none; border-bottom: 1px dashed; outline: none; } /* New window (target) + external links */ a[target], a[href^="https://"], a[href^="http://"] { border-bottom: 1px solid; } a:hover, a:focus { border-bottom: none; } /* Images */ img { -webkit-user-drag: none; /* disable dragging */ } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/nav.css ================================================ /* Nav */ .nav { width: 340px; overflow-x: hidden; overflow-y: auto; color: var(--color-subtle); border-right: 1px solid var(--color-border); background-color: var(--color-bg); visibility: hidden; opacity: 0; } .nav.is-shown { visibility: visible;; opacity: 1; } .nav-header { position: relative; padding: 2rem; margin-bottom: 1rem; border-bottom: 1px solid var(--color-border); } .nav-title { text-transform: uppercase; font-weight: 300; line-height: 1; margin: 0; } .nav-title strong { font-weight: 600; color: var(--color-strong); } .nav-header-icon { position: absolute; width: 36px; height: 36px; top: 1.5rem; /* magic */ right: 1.75rem; /* magic */ } .nav-item { padding: .5em 0; } .nav-icon { width: 16px; height: 16px; vertical-align: top; margin-right: .25rem; } .nav-category { margin: .2em 0; padding-left: 2rem; font-size: 11px; font-weight: normal; text-transform: uppercase; } .nav-button { display: block; width: 100%; padding: .3rem; padding-left: calc(2rem + 16px + .5rem); /* padding + icon + magic */ line-height: 2; text-align: left; font: inherit; font-size: 13px; color: inherit; border: none; background-color: transparent; cursor: default; outline: none; } .nav-button:hover, .nav-button:focus:not(.is-selected) { background-color: hsla(0,0%,0%,.1); } .nav-button.is-selected { background-color: var(--color-accent); } .nav-button.is-selected, .nav-button.is-selected em { color: #fff; } .nav-button.is-selected:focus { opacity: .8; } .nav-button em { font-style: normal; font-weight: 600; color: var(--color-strong); pointer-events: none; /* makes it invisible to clicks */ } .nav-footer { margin-top: 1rem; padding: 2rem; border-top: 1px solid var(--color-border); text-align: center; } .nav-footer-icon { width: calc(770px / 6.5); height: calc(88px / 6.5); } .nav-footer a { outline: none; } .nav-footer-button { display: block; width: 100%; padding: 0; margin-bottom: .75rem; line-height: 2; text-align: left; font: inherit; font-size: 13px; color: inherit; border: none; background-color: transparent; cursor: default; outline: none; text-align: center; } .nav-footer-button:focus { color: var(--color-strong); } .nav-footer-logo { color: hsl(0,0%,66%); } .nav-footer-logo:focus { color: hsl(0,0%,33%); } /* Remove border on the logo */ .nav-footer-logo.nav-footer-logo { border-bottom: none; } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/print.css ================================================ @media print { body { background: none; color: black !important; font-size: 70%; margin: 0; padding: 0; } h1 { font-size: 22px; } .nav, button, .demo-box:before, #pdf-path, header p { display: none; } .demo-box, h2, pre, code { padding: 0 !important; margin: 0 !important; } header { padding: 0 0 10px 0; } code, .support { font-size: 10px; } } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/section.css ================================================ /* Section ------------------ */ .section { position: absolute; top: 0; left: 0; right: 0; bottom: 0; overflow-x: hidden; overflow-y: auto; color: var(--color-accent); /* Hide */ pointer-events: none; visibility: hidden; opacity: 0; transform: translateX(-20px); transition: visibility 0s .12s linear , opacity .12s ease-in, transform .12s ease-in; } .section.is-shown { pointer-events: auto; visibility: visible; opacity: 1; transform: translateX(0); transition: visibility 0s 0s linear , opacity .36s ease-out, transform .36s ease-out; } .section h3, .section p { color: var(--color); } .section-wrapper { position: relative; max-width: 740px; margin: 0 auto; padding: 2rem 2rem 1rem 2rem; border-bottom: 1px solid var(--color-border); } @media (min-width: 940px) { .section-wrapper { padding-top: 4rem; } } .section-icon { width: 32px; height: 32px; vertical-align: middle; margin-right: .5em; } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/css/variables.css ================================================ /* Custom Properties */ :root { --color: hsl(0,0%,22%); --color-subtle: hsl(0,0%,44%); --color-strong: hsl(0,0%,11%); --color-link: hsl(0,0%,22%); --color-border: hsl(0,0%,88%); --color-bg: hsl(0,0%,96%); --color-accent: black; /* Fallback */ } /* Category Colors */ .u-category-windows { --color-accent: hsl(116, 30%, 36%); } .u-category-menu { --color-accent: hsl(194, 60%, 36%); } .u-category-native-ui { --color-accent: hsl(222, 53%, 50%); } .u-category-communication { --color-accent: hsl(285, 47%, 46%); } .u-category-system { --color-accent: hsl(330, 65%, 48%); } .u-category-update { --color-accent: hsl(0, 92%, 43%); } .u-category-media { --color-accent: hsl( 36, 77%, 34%); } ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/demo-btns.js ================================================ setTimeout(() => { const demoBtns = document.querySelectorAll('.js-container-target'); // Listen for demo button clicks Array.prototype.forEach.call(demoBtns, function (btn) { btn.addEventListener('click', function (event) { const parent = event.target.parentElement; // Toggles the "is-open" class on the demo's parent element. parent.classList.toggle('is-open'); }) }) }, 3000); ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/ex-links.js ================================================ (function () { const shell = require('electron').shell const links = document.querySelectorAll('a[href]') Array.prototype.forEach.call(links, function (link) { const url = link.getAttribute('href') if (url.indexOf('http') === 0) { link.addEventListener('click', function (e) { e.preventDefault() shell.openExternal(url) }) } }) }) ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/imports.js ================================================ const links = ["windows", "crashhang", "menus", "shortcuts", "shell", "notifications", "dialogs", "tray", "ipc", "hosthook", "appsysinformation", "clipboard", "pdf", "desktopcapturer", "update"]; fetch('about').then((aboutPage) => { aboutPage.text().then(pageContent => { const template = document.createRange().createContextualFragment(pageContent); document.querySelector('body').appendChild(template.firstElementChild.content); }); }); links.forEach(async pageName => { const page = await fetch(pageName); const pageContent = await page.text(); const template = document.createRange().createContextualFragment(pageContent); document.querySelector('.content').appendChild(template.firstElementChild.content); }); ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/mac/child.plist ================================================ com.apple.security.app-sandbox com.apple.security.inherit ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/mac/info.plist ================================================ CFBundleURLTypes CFBundleURLSchemes electron-api-demos CFBundleURLName Electron API Demos Protocol ElectronTeamID VEKTX9H2N7 ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/mac/parent.plist ================================================ com.apple.security.app-sandbox com.apple.security.application-groups VEKTX9H2N7.com.github.electron-api-demos com.apple.security.files.user-selected.read-write ================================================ FILE: src/ElectronNET.WebApp/wwwroot/assets/nav.js ================================================ document.body.addEventListener('click', function (event) { if (event.target.dataset.section) { handleSectionTrigger(event) } else if (event.target.dataset.modal) { handleModalTrigger(event) } else if (event.target.classList.contains('modal-hide')) { hideAllModals() } }); function handleSectionTrigger(event) { hideAllSectionsAndDeselectButtons(); // Highlight clicked button and show view event.target.classList.add('is-selected'); // Display the current section const sectionId = event.target.dataset.section + '-section' document.getElementById(sectionId).classList.add('is-shown'); } function activateDefaultSection() { document.getElementById('button-windows').click() } function showMainContent() { showNav(); document.querySelector('.js-content').classList.add('is-shown'); } function handleModalTrigger(event) { hideAllModals(); const modalId = event.target.dataset.modal + '-modal'; if (modalId === 'about-modal') { hideNav(); } document.getElementById(modalId).classList.add('is-shown'); } function hideAllModals() { const modals = document.querySelectorAll('.modal.is-shown') Array.prototype.forEach.call(modals, function (modal) { modal.classList.remove('is-shown') }) showMainContent() } function hideAllSectionsAndDeselectButtons() { const sections = document.querySelectorAll('.js-section.is-shown') Array.prototype.forEach.call(sections, function (section) { section.classList.remove('is-shown') }) const buttons = document.querySelectorAll('.nav-button.is-selected') Array.prototype.forEach.call(buttons, function (button) { button.classList.remove('is-selected') }) } function displayAbout() { hideNav(); document.querySelector('#about-modal').classList.add('is-shown') } function hideNav() { document.querySelector('.js-nav').classList.remove('is-shown'); document.querySelector('.js-nav').style.display = 'none'; } function showNav() { document.querySelector('.js-nav').style.display = null; document.querySelector('.js-nav').classList.add('is-shown'); } setTimeout(() => { activateDefaultSection(); displayAbout(); }, 1000); ================================================ FILE: src/ElectronNET.sln ================================================ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 18 VisualStudioVersion = 18.0.11205.157 MinimumVisualStudioVersion = 10.0.40219.1 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElectronNET.WebApp", "ElectronNET.WebApp\ElectronNET.WebApp.csproj", "{7C048379-401C-4345-B5E7-BE232DEA8157}" ProjectSection(ProjectDependencies) = postProject {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} = {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} {8860606D-6847-F22A-5AED-DF4E0984DD24} = {8860606D-6847-F22A-5AED-DF4E0984DD24} EndProjectSection EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElectronNET.API", "ElectronNET.API\ElectronNET.API.csproj", "{A78157BA-B754-45F1-969F-D6A513CA0E72}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.Build", "ElectronNET.Build\ElectronNET.Build.csproj", "{829FC339-4785-4229-ABA5-53ADB544DA00}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET", "ElectronNET\ElectronNET.csproj", "{8860606D-6847-F22A-5AED-DF4E0984DD24}" ProjectSection(ProjectDependencies) = postProject {829FC339-4785-4229-ABA5-53ADB544DA00} = {829FC339-4785-4229-ABA5-53ADB544DA00} EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "!Config", "!Config", "{02EA681E-C7D8-13C7-8484-4AC65E1B71E8}" ProjectSection(SolutionItems) = preProject ..\Changelog.md = ..\Changelog.md common.props = common.props ..\global.json = ..\global.json ..\NuGet.config = ..\NuGet.config ..\publish.cmd = ..\publish.cmd ..\README.md = ..\README.md EndProjectSection EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.AspNet", "ElectronNET.AspNet\ElectronNET.AspNet.csproj", "{DD10D21A-D131-1D9C-33F9-406046E0C5B0}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.ConsoleApp", "ElectronNET.ConsoleApp\ElectronNET.ConsoleApp.csproj", "{EE38A326-5DE8-AF09-9EB9-DF0878938783}" ProjectSection(ProjectDependencies) = postProject {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} = {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} {8860606D-6847-F22A-5AED-DF4E0984DD24} = {8860606D-6847-F22A-5AED-DF4E0984DD24} EndProjectSection EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{1BB6F634-2831-4496-83A6-BC6761DCEC8D}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test Apps", "Test Apps", "{EDCBFC49-2AEE-4BAF-9368-4409298C52FC}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{985D39A7-5216-4945-8167-2FD0CB387BD8}" ProjectSection(SolutionItems) = preProject ..\.github\workflows\Build and Publish.yml = ..\.github\workflows\Build and Publish.yml ..\.github\workflows\integration-tests.yml = ..\.github\workflows\integration-tests.yml ..\.github\workflows\PR Validation.yml = ..\.github\workflows\PR Validation.yml ..\.github\workflows\pr-comment.yml = ..\.github\workflows\pr-comment.yml ..\.github\workflows\publish-wiki.yml = ..\.github\workflows\publish-wiki.yml ..\.github\workflows\retry-test-jobs.yml = ..\.github\workflows\retry-test-jobs.yml ..\.github\workflows\trailing-whitespace-check.yml = ..\.github\workflows\trailing-whitespace-check.yml EndProjectSection EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "_build", "..\nuke\_build.csproj", "{015CB06B-6CAE-209F-E050-21C3ACA5FE9F}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "!Docs", "!Docs", "{D36CDFFD-3438-42E4-A7FF-88BA19AC4964}" ProjectSection(SolutionItems) = preProject ..\.github\workflows\publish-wiki.yml = ..\.github\workflows\publish-wiki.yml EndProjectSection EndProject Project("{D954291E-2A0B-460D-934E-DC6B0785DB48}") = "Docs", "..\docs\Docs.shproj", "{06CAADC7-DE5B-47B4-AB2A-E9501459A2D1}" EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Test Projects", "Test Projects", "{75129C45-FC6F-41B0-A485-07F4A7E031ED}" EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "ElectronNET.IntegrationTests", "ElectronNET.IntegrationTests\ElectronNET.IntegrationTests.csproj", "{AE877E48-6B44-63C2-8EA0-DB58D096B553}" ProjectSection(ProjectDependencies) = postProject {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} = {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} EndProjectSection EndProject Project("{54A90642-561A-4BB1-A94E-469ADEE60C69}") = "ElectronNET.Host", "ElectronNET.Host\ElectronNET.Host.esproj", "{1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}" EndProject Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ElectronNET.Samples.ElectronHostHook", "ElectronNET.Samples.ElectronHostHook\ElectronNET.Samples.ElectronHostHook.csproj", "{B8D65F3A-7E54-4632-9F1C-46679237B312}" ProjectSection(ProjectDependencies) = postProject {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} = {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} {8860606D-6847-F22A-5AED-DF4E0984DD24} = {8860606D-6847-F22A-5AED-DF4E0984DD24} EndProjectSection EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Any CPU = Debug|Any CPU Release|Any CPU = Release|Any CPU EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {7C048379-401C-4345-B5E7-BE232DEA8157}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {7C048379-401C-4345-B5E7-BE232DEA8157}.Debug|Any CPU.Build.0 = Debug|Any CPU {7C048379-401C-4345-B5E7-BE232DEA8157}.Release|Any CPU.ActiveCfg = Release|Any CPU {7C048379-401C-4345-B5E7-BE232DEA8157}.Release|Any CPU.Build.0 = Release|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Debug|Any CPU.Build.0 = Debug|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Release|Any CPU.ActiveCfg = Release|Any CPU {A78157BA-B754-45F1-969F-D6A513CA0E72}.Release|Any CPU.Build.0 = Release|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Release|Any CPU.ActiveCfg = Release|Any CPU {829FC339-4785-4229-ABA5-53ADB544DA00}.Release|Any CPU.Build.0 = Release|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Debug|Any CPU.Build.0 = Debug|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Release|Any CPU.ActiveCfg = Release|Any CPU {8860606D-6847-F22A-5AED-DF4E0984DD24}.Release|Any CPU.Build.0 = Release|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Debug|Any CPU.Build.0 = Debug|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Release|Any CPU.ActiveCfg = Release|Any CPU {DD10D21A-D131-1D9C-33F9-406046E0C5B0}.Release|Any CPU.Build.0 = Release|Any CPU {EE38A326-5DE8-AF09-9EB9-DF0878938783}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {EE38A326-5DE8-AF09-9EB9-DF0878938783}.Debug|Any CPU.Build.0 = Debug|Any CPU {EE38A326-5DE8-AF09-9EB9-DF0878938783}.Release|Any CPU.ActiveCfg = Release|Any CPU {EE38A326-5DE8-AF09-9EB9-DF0878938783}.Release|Any CPU.Build.0 = Release|Any CPU {015CB06B-6CAE-209F-E050-21C3ACA5FE9F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {015CB06B-6CAE-209F-E050-21C3ACA5FE9F}.Release|Any CPU.ActiveCfg = Release|Any CPU {06CAADC7-DE5B-47B4-AB2A-E9501459A2D1}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {06CAADC7-DE5B-47B4-AB2A-E9501459A2D1}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE877E48-6B44-63C2-8EA0-DB58D096B553}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {AE877E48-6B44-63C2-8EA0-DB58D096B553}.Debug|Any CPU.Build.0 = Debug|Any CPU {AE877E48-6B44-63C2-8EA0-DB58D096B553}.Release|Any CPU.ActiveCfg = Release|Any CPU {AE877E48-6B44-63C2-8EA0-DB58D096B553}.Release|Any CPU.Build.0 = Release|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Debug|Any CPU.Build.0 = Debug|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Debug|Any CPU.Deploy.0 = Debug|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Release|Any CPU.ActiveCfg = Release|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Release|Any CPU.Build.0 = Release|Any CPU {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6}.Release|Any CPU.Deploy.0 = Release|Any CPU {B8D65F3A-7E54-4632-9F1C-46679237B312}.Debug|Any CPU.ActiveCfg = Debug|Any CPU {B8D65F3A-7E54-4632-9F1C-46679237B312}.Debug|Any CPU.Build.0 = Debug|Any CPU {B8D65F3A-7E54-4632-9F1C-46679237B312}.Release|Any CPU.ActiveCfg = Release|Any CPU {B8D65F3A-7E54-4632-9F1C-46679237B312}.Release|Any CPU.Build.0 = Release|Any CPU EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection GlobalSection(NestedProjects) = preSolution {7C048379-401C-4345-B5E7-BE232DEA8157} = {EDCBFC49-2AEE-4BAF-9368-4409298C52FC} {A78157BA-B754-45F1-969F-D6A513CA0E72} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {829FC339-4785-4229-ABA5-53ADB544DA00} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {8860606D-6847-F22A-5AED-DF4E0984DD24} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {DD10D21A-D131-1D9C-33F9-406046E0C5B0} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {EE38A326-5DE8-AF09-9EB9-DF0878938783} = {EDCBFC49-2AEE-4BAF-9368-4409298C52FC} {015CB06B-6CAE-209F-E050-21C3ACA5FE9F} = {985D39A7-5216-4945-8167-2FD0CB387BD8} {06CAADC7-DE5B-47B4-AB2A-E9501459A2D1} = {D36CDFFD-3438-42E4-A7FF-88BA19AC4964} {AE877E48-6B44-63C2-8EA0-DB58D096B553} = {75129C45-FC6F-41B0-A485-07F4A7E031ED} {1C5FD66E-A1C6-C436-DF7C-3ECE4FEDDFE6} = {1BB6F634-2831-4496-83A6-BC6761DCEC8D} {B8D65F3A-7E54-4632-9F1C-46679237B312} = {EDCBFC49-2AEE-4BAF-9368-4409298C52FC} EndGlobalSection GlobalSection(ExtensibilityGlobals) = postSolution SolutionGuid = {81A62E71-9E04-4EFE-AD5C-23165375F8EF} EndGlobalSection EndGlobal ================================================ FILE: src/ElectronNET.sln.DotSettings ================================================  DO_NOT_SHOW False False CI True True True True ================================================ FILE: src/common.props ================================================ 0.4.1 ElectronNET.Core Gregor Biswanger, Florian Rappl, softworkz Electron.NET MIT https://github.com/ElectronNET/Electron.NET/ $(PackageProjectUrl) git true electron aspnetcore README.md Changelog: https://github.com/ElectronNET/Electron.NET/blob/main/Changelog.md PackageIcon.png Building cross platform electron based desktop apps with .NET Core and - optionally - ASP.NET Core. $(Version) $(Version) $(Version)$(VersionPostFix) $(Version) ================================================ FILE: src/testEnvironments.json ================================================ { "version": "1", "environments": [ // See https://aka.ms/remotetesting for more details // about how to configure remote environments. { "name": "WSL Ubuntu", "type": "wsl", "wslDistribution": "UbuFresh" } //{ // "name": "Docker dotnet/sdk", // "type": "docker", // "dockerImage": "mcr.microsoft.com/dotnet/sdk" //} ] }