1

Overview

github-actions[bot] edited this page 2025-10-31 16:53:39 +00:00

Table of Contents

• API Classes
• Core Application Management
• User Interface & Interaction
• System Integration
• Communication & Automation
• System Monitoring
• API Relationships
• Window and Dialog Integration
• IPC Communication
• System Integration
• 🚀 Next Steps
• 📚 Additional Resources

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 - Control your application's event lifecycle, manage app metadata, and handle system-level operations
• Electron.WindowManager - Create and manage browser windows, control window behavior and appearance
• Electron.Menu - Create application menus, context menus, and menu items with full keyboard shortcut support

User Interface & Interaction

• Electron.Dialog - Display native system dialogs for opening/saving files, showing messages and alerts
• Electron.Notification - Show native desktop notifications with custom content and actions
• Electron.Tray - Create system tray icons with context menus and tooltip support
• Electron.Dock - macOS dock integration for bounce effects and badge counts

System Integration

• Electron.Shell - Desktop integration for opening files, URLs, and accessing system paths
• Electron.Clipboard - Read from and write to the system clipboard with multiple data formats
• Electron.Screen - Access display and screen information for responsive layouts
• Electron.NativeTheme - Detect and respond to system theme changes (light/dark mode)

Communication & Automation

• Electron.IpcMain - Inter-process communication between main process and renderer processes
• Electron.HostHook - Custom host hook functionality for advanced integration scenarios
• Electron.GlobalShortcut - Register global keyboard shortcuts that work even when app is not focused
• Electron.AutoUpdater - Handle application updates and installation processes

System Monitoring

• Electron.PowerMonitor - 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 - Start with application lifecycle management
• Electron.WindowManager - Learn window creation and management
• Electron.Dialog - Add file operations and user interactions
• Electron.Menu - Implement application menus and shortcuts

📚 Additional Resources

• Electron Documentation - Official Electron API reference
• Getting Started - Development setup guides
• Migration Guide - Moving from previous versions

• Home
• About this Project

• What's new?
• Migration Guide
• Migration Checks
• Advanced Migration

• System Requirements
• With ASP.Net
• With a Console App

• Configuration
• Startup-Methods
• Debugging
• Package Building
• Adding a custom_main.js

• API Overview
• Electron.App
• Electron.Dialog
• Electron.Menu
• Electron.WindowManager
• Electron.Shell
• Electron.Screen
• Electron.Notification
• Electron.Tray
• Electron.Clipboard
• Electron.Dock
• Electron.HostHook
• Electron.IpcMain
• Electron.GlobalShortcut
• Electron.AutoUpdater
• Electron.NativeTheme
• Electron.PowerMonitor

• Package Description
• Changelog

Want to contribute to this documentation? Please fork and create a PR! The Wiki is autogenerated from the /docs content in the repository.