Skip to content

Overview

github-actions[bot] edited this page Oct 31, 2025 · 1 revision

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

System Monitoring

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

📚 Additional Resources

Clone this wiki locally