### Get Window Manager Instance Source: https://dotmorten.github.io/WinUIEx/concepts/WindowManager.html Use the Get method to create or retrieve the Window Manager instance for a given window. ```csharp var manager = WinUIEx.WindowManager.Get(window); ``` -------------------------------- ### Initialize WindowEx Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.-ctor.html Initializes a new instance of the WindowEx class. No specific setup or constraints are mentioned. ```csharp public WindowEx() ``` -------------------------------- ### Implement OnLoading for SplashScreen Source: https://dotmorten.github.io/WinUIEx/concepts/Splashscreen.html Override OnLoading to perform asynchronous setup tasks while the splash screen is visible. ```csharp protected override async Task OnLoading() { //TODO: Do some actual work for (int i = 0; i < 100; i+=5) { statusText.Text = $"Loading {i}%..."; progressBar.Value = i; await Task.Delay(50); } } ``` -------------------------------- ### OnTargetConnected Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.CompositionBrushBackdrop.html Called when this object is attached to a valid container, for example, when set on Window.SystemBackdrop. Override to perform setup when the backdrop is applied. ```csharp protected virtual void OnTargetConnected(ICompositionSupportsSystemBackdrop target, XamlRoot xamlRoot) ``` -------------------------------- ### WindowContent Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.WindowContent.html Gets or sets the Window content. ```APIDOC ## WindowContent Property ### Description Gets or sets the Window content. ### Declaration ```csharp public object? WindowContent { get; set; } ``` ### Property Value | Type | Description | |---|---| | object | The window content. | ``` -------------------------------- ### WindowState Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowManager.WindowState.html Gets or sets the current window state. ```APIDOC ## WindowState Property ### Description Gets or sets the current window state. ### Declaration ```csharp public WindowState WindowState { get; set; } ``` ### Property Value - **WindowState** (WindowState) - A WindowState that determines whether a window is restored, minimized, or maximized. The default is Normal (restored). ### Remarks When the WindowState property is changed, WindowStateChanged is raised. ### Note This property only has affect when using the OverlappedPresenter. ### See Also - WindowStateChanged - PresenterKind ``` -------------------------------- ### Register and Authenticate for Protocol Activation (Unpackaged Apps) Source: https://dotmorten.github.io/WinUIEx/concepts/WebAuthenticator.html For unpackaged applications, register for protocol activation before initiating the authentication flow. Ensure to unregister after the process is complete. This example demonstrates registering, authenticating, and then unregistering the protocol. ```csharp try { Microsoft.Windows.AppLifecycle.ActivationRegistrationManager.RegisterForProtocolActivation("myscheme", "Assets\\Square150x150Logo.scale-100", "My App Name", null); var result = await WebAuthenticator.AuthenticateAsync(authorizeUri, callbackUri, cancellationToken); } finally { Microsoft.Windows.AppLifecycle.ActivationRegistrationManager.UnregisterForProtocolActivation("myscheme", null); } ``` -------------------------------- ### Property Width Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.Width.html Gets or sets the width of the window. ```APIDOC ## Property Width ### Description Gets or sets the width of the window. ### Declaration ```csharp public double Width { get; set; } ``` ### Property Value | Type | Description | |--------|-------------| | double | | ``` -------------------------------- ### Initialize NumberBox Instance Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.-ctor.html Initializes a new instance of the NumberBox class. No specific setup is required beyond standard class instantiation. ```csharp public NumberBox() ``` -------------------------------- ### GET TemplateSettings Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.TemplateSettings.html Retrieves the template settings associated with the title bar. ```APIDOC ## GET TemplateSettings ### Description Gets the template settings for the titlebar. ### Declaration `public TitleBarTemplateSettings TemplateSettings { get; }` ### Property Value - **Type**: TitleBarTemplateSettings ``` -------------------------------- ### Initialize TitleBarTemplateSettings Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBarTemplateSettings.-ctor.html Initializes a new instance of the TitleBar class. No specific setup or constraints are mentioned. ```csharp public TitleBarTemplateSettings() ``` -------------------------------- ### ShowWindow Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.HwndExtensions.ShowWindow.html Activates the window and displays it in its current size and position. ```APIDOC ## ShowWindow(nint hWnd) ### Description Activates the window and displays it in its current size and position. ### Method static bool ### Parameters #### Path Parameters - **hWnd** (nint) - Required - Window handle ### Returns #### Success Response (bool) - `true` if the window was previously visible, or `false` if the window was previously hidden. ### Request Example ```csharp ShowWindow(handle); ``` ### Response Example ```json { "result": true } ``` ``` -------------------------------- ### GetExtendedWindowStyle Method Declaration Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.HwndExtensions.GetExtendedWindowStyle.html Use this method to get the current window style for a given window handle. No specific setup is required beyond having a valid window handle. ```csharp public static ExtendedWindowStyle GetExtendedWindowStyle(nint hWnd) ``` -------------------------------- ### Initialize SplashScreen with Window instance Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.-ctor.html Creates and activates a splash screen that opens the provided Window instance when finished. ```csharp public SplashScreen(Window window) ``` -------------------------------- ### Get or Set Window Title Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Title.html Use this property to retrieve or modify the text displayed in the window's title bar. No specific setup is required beyond having a Window instance. ```csharp public string Title { get; set; } ``` -------------------------------- ### Show(Window) Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.Show.html Activates the window and displays it in its current size and position. ```APIDOC ## Show(Window) ### Description Activates the window and displays it in its current size and position. ### Method Static Extension Method ### Parameters #### Path Parameters - **window** (Window) - Required - The window to be displayed. ### Returns - **bool** - true if the window was previously visible, or false if the window was previously hidden. ### Declaration ```csharp public static bool Show(this Window window) ``` ``` -------------------------------- ### Get or Set Titlebar Footer Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Footer.html Use this property to get or set the footer content of the titlebar. The footer can be any object. ```csharp public object? Footer { get; set; } ``` -------------------------------- ### Initialize TrayIcon with file path Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.-ctor.html Use this constructor to create a tray icon by providing a path to a valid .ico file. The tooltip is limited to 128 characters. ```csharp public TrayIcon(uint trayiconId, string iconPath, string tooltip) ``` -------------------------------- ### Get or Set TitleBar Content Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Content.html Use this property to get or set the content displayed in the titlebar. The content can be any object. ```csharp public object? Content { get; set; } ``` -------------------------------- ### WindowEx Constructor Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.-ctor.html Initializes a new instance of the WindowEx class. ```APIDOC ## Constructor WindowEx ### Description Initializes a new instance of the WindowEx class. ### Declaration public WindowEx() ``` -------------------------------- ### Get and Set ValidationMode Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.ValidationMode.html This property gets or sets the input validation behavior for invalid input. The default value is InvalidInputOverwritten. ```csharp public NumberBoxValidationMode ValidationMode { get; set; } ``` -------------------------------- ### Get or Set TextReadingOrder Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.TextReadingOrder.html Use this property to get or set the reading order for a NumberBox. The value must be a TextReadingOrder enumeration. ```csharp public TextReadingOrder TextReadingOrder { get; set; } ``` -------------------------------- ### Initialize SimpleSplashScreen in App.xaml.cs Source: https://dotmorten.github.io/WinUIEx/concepts/Splashscreen.html Create and show a SimpleSplashScreen instance within the App constructor. ```csharp private SimpleSplashScreen fss { get; set; } public App() { fss = SimpleSplashScreen.ShowDefaultSplashScreen(); // Shows the splash screen you already defined in your app manifest. For unpackaged apps use .ShowSplashScreenImage(imagepath): // fss = SimpleSplashScreen.ShowSplashScreenImage(full_path_to_image_); // Shows a custom splash screen image. Must be a full-path (no relative paths) this.InitializeComponent(); } ``` -------------------------------- ### Initialize SplashScreen with Window Type Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.-ctor.html Creates and activates a splash screen that instantiates and opens the specified window type. The target type must have an empty constructor. ```csharp public SplashScreen(Type window) ``` -------------------------------- ### Get or Set IsMaximizable Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.IsMaximizable.html Use this property to get or set a value indicating whether the maximize button is visible. It is a boolean type. ```csharp public bool IsMaximizable { get; set; } ``` -------------------------------- ### Get or Set Tooltip Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.Tooltip.html Use this property to get or set the tooltip text for a callout. The maximum length for the tooltip is 128 characters. ```csharp public string Tooltip { get; set; } ``` -------------------------------- ### Center, Resize, and Move Window Source: https://dotmorten.github.io/WinUIEx/concepts/WindowExtensions.html Methods for positioning and sizing the window. `CenterOnScreen` positions the window in the center, `SetWindowSize` resizes it, and `MoveAndResize` allows precise control over position and dimensions. ```csharp myWindow.CenterOnScreen(); myWindow.SetWindowSize(1024, 768); myWindow.MoveAndResize(100, 100, 1024, 768); ``` -------------------------------- ### GetDesktopWindow() - C# Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.HwndExtensions.GetDesktopWindow.html Retrieves a handle to the desktop window. The desktop window covers the entire screen and is the area on top of which other windows are painted. No setup or imports are required beyond the standard WinUIEx library. ```csharp public static nint GetDesktopWindow() ``` -------------------------------- ### DotMorten OmdGenerator Tool Source: https://dotmorten.github.io/WinUIEx/api/omd.html Command to install and use the DotMorten OmdGenerator tool for generating API documentation. ```APIDOC ## DotMorten OmdGenerator Tool ### Description This section provides information on how to use the DotMorten OmdGenerator tool to generate API documentation from .NET code. ### Installation ```bash dotnet tool install --global dotMorten.OmdGenerator ``` ### Usage ```bash generateomd D:\a\WinUIEx\WinUIEx\.tools\omd\.store\dotmorten.omdgenerator\1.4.0\dotmorten.omdgenerator\1.4.0\tools\net5.0\any\generateomd.dll /source=src/WinUIEx/. /output=artifacts/docs/api/omd.html ``` ### Tool Description .NET Object Model Diagram Generator ``` -------------------------------- ### Bring Window to Front Source: https://dotmorten.github.io/WinUIEx/concepts/WindowExtensions.html Use `BringToFront()` to ensure the window is visible and active, bringing it to the foreground. ```csharp myWindow.BringToFront(); ``` -------------------------------- ### Get or Set IsBackButtonVisible Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.IsBackButtonVisible.html Use this property to get or set a value indicating whether the back button is visible. It returns a boolean value. ```csharp public bool IsBackButtonVisible { get; set; } ``` -------------------------------- ### Property Width Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.Width.html Gets or sets the width of the splash screen. Set to NaN to size for content. ```APIDOC ## Property Width ### Description Gets or sets the width of the splash screen. Set to NaN to size for content. ### Declaration ```csharp public double Width { get; set; } ``` ### Property Value | Type | Description | |--------|-------------| | double | | ``` -------------------------------- ### Get or Set Window Minimum Width Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.MinWidth.html Use this property to get or set the minimum width of a window. The value is in device-independent pixels. A default minimum of 139 pixels is noted. ```csharp public double MinWidth { get; set; } ``` -------------------------------- ### Manual Application Startup with SimpleSplashScreen Source: https://dotmorten.github.io/WinUIEx/concepts/Splashscreen.html Use the DISABLE_XAML_GENERATED_MAIN directive to display the splash screen before the application is fully initialized. ```csharp #if DISABLE_XAML_GENERATED_MAIN public static class Program { [System.STAThreadAttribute] static void Main(string[] args) { // If you're using the WebAuthenticator, make sure you call this method first before the splashscreen shows if (WebAuthenticator.CheckOAuthRedirectionActivation(true)) return; var fss = SimpleSplashScreen.ShowDefaultSplashScreen(); WinRT.ComWrappersSupport.InitializeComWrappers(); Microsoft.UI.Xaml.Application.Start((p) => { var context = new Microsoft.UI.Dispatching.DispatcherQueueSynchronizationContext(Microsoft.UI.Dispatching.DispatcherQueue.GetForCurrentThread()); System.Threading.SynchronizationContext.SetSynchronizationContext(context); new App(fss); // Pass the splash screen to your app so it can close it on activation }); } } #endif ``` -------------------------------- ### Get or Set MaxWidth Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.MaxWidth.html Gets or sets the maximum width of this window. The default is 0, which means no limit. If the value is less than MinWidth, the MinWidth will also be used as the maximum width. ```csharp public double MaxWidth { get; set; } ``` -------------------------------- ### SystemBackdrop Methods Source: https://dotmorten.github.io/WinUIEx/api/omd.html Methods for managing system backdrop controllers and configurations. ```APIDOC ## SystemBackdrop Methods ### Description Methods for applying, creating, and updating system backdrop controllers. ### Methods * **ApplyController(ISystemBackdropController controller, ICompositionSupportsSystemBackdrop target, SystemBackdropConfiguration configuration)**: Applies the specified controller to the target with the given configuration. * **CreateController()**: Creates a new system backdrop controller. * **NotifyDirty()**: Notifies the system that the backdrop properties have changed. * **ResetProperties()**: Resets the backdrop properties to their default values. * **UpdateController(ISystemBackdropController controller, SystemBackdropTheme theme)**: Updates the specified controller with the given theme. ``` -------------------------------- ### WindowEx Constructor Source: https://dotmorten.github.io/WinUIEx/api/omd.html Constructor for WindowEx. ```APIDOC ## WindowEx Constructor ### Description Initializes a new instance of the WindowEx class. ### Constructors * **WindowEx()**: Initializes a new instance of the WindowEx class. ``` -------------------------------- ### Get Display Monitor Rectangle Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.MonitorInfo.RectMonitor.html Access the RectMonitor property to get the display monitor's rectangle in virtual-screen coordinates. If the monitor is not the primary display, some coordinates may be negative. ```csharp public Rect RectMonitor { get; } ``` -------------------------------- ### Get or Set PersistenceId Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.PersistenceId.html This property is used to get or set a unique ID for saving and restoring window size and position. The ID must be set before the window activates. It uses ApplicationData storage and is only functional for packaged applications. ```csharp public string? PersistenceId { get; set; } ``` -------------------------------- ### Initialize WindowMessageMonitor with Window object Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.Messaging.WindowMessageMonitor.-ctor.html Initializes the monitor using a Window instance to listen for messages. ```csharp public WindowMessageMonitor(Window window) ``` -------------------------------- ### Minimize, Maximize, Restore, and Hide Window Source: https://dotmorten.github.io/WinUIEx/concepts/WindowExtensions.html Use these methods to control the basic visibility and state of a window. Ensure `using WinUIEx;` is included. ```csharp myWindow.Minimize(); myWindow.Maximize(); myWindow.Restore(); myWindow.Hide(); ``` -------------------------------- ### Get or Set Window Content Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.WindowContent.html Use this property to retrieve or define the content displayed within a window. The content can be any object. ```csharp public object? WindowContent { get; set; } ``` -------------------------------- ### IconElement Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBarTemplateSettings.IconElement.html Gets or sets the IconElement property. ```APIDOC ## IconElement Property ### Description Gets or sets the IconElement property. ### Declaration ```csharp public IconElement? IconElement { get; set; } ``` ### Property Value Type | Description ---|--- IconElement | ``` -------------------------------- ### TitleBarTemplateSettings() Constructor Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBarTemplateSettings.-ctor.html Initializes a new instance of the TitleBar class. ```APIDOC ## TitleBarTemplateSettings() ### Description Initializes a new instance of the TitleBar class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### Subtitle Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Subtitle.html Gets or sets the Subtitle for the titlebar. ```APIDOC ## Subtitle Property ### Description Gets or sets the Subtitle for the titlebar. ### Declaration ```csharp public string Subtitle { get; set; } ``` ### Property Value - **Type**: string - **Description**: ``` -------------------------------- ### CreateFolderPicker Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.CreateFolderPicker.html Provides documentation for the static CreateFolderPicker method, which is used to instantiate a FolderPicker. ```APIDOC ## CreateFolderPicker ### Description Creates a new instance of a FolderPicker with the provided window as a parent. ### Method `public static FolderPicker CreateFolderPicker(this Window window)` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **FolderPicker** (FolderPicker) - The newly created FolderPicker instance. #### Response Example None ``` -------------------------------- ### Show method declaration Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.Show.html This static extension method activates and displays the specified window. ```csharp public static bool Show(this Window window) ``` -------------------------------- ### GetIsMinimizable Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.GetIsMinimizable.html Gets a value indicating whether this window is minimizeable or not. ```APIDOC ## GET /websites/dotmorten_github_io_winuiex/GetIsMinimizable ### Description Gets a value indicating whether this window is minimizeable or not. ### Method GET ### Endpoint /websites/dotmorten_github_io_winuiex/GetIsMinimizable ### Parameters #### Path Parameters - **window** (Window) - Required - The window object to check. ### Response #### Success Response (200) - **result** (bool) - True if the overlapped presenter is on minimizable, otherwise false. ``` -------------------------------- ### BringToFront() Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.BringToFront.html Brings the window to the front. ```APIDOC ## BringToFront() ### Description Brings the window to the front. ### Method N/A (This appears to be a method call within a C# context, not a REST API endpoint). ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Success Response (bool) - **bool** - Indicates success or failure of the operation (specifics not detailed). #### Response Example ```json { "example": "true or false" } ``` ``` -------------------------------- ### Get or Set IsAlwaysOnTop Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.IsAlwaysOnTop.html Use this property to determine if the splash screen should always be visible on top of other applications. Set to true to enable, false to disable. ```csharp public bool IsAlwaysOnTop { get; set; } ``` -------------------------------- ### TrayIconId Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.TrayIconId.html Gets the unique identifier for the tray icon. ```APIDOC ## TrayIconId Property ### Description Gets the unique identifier for the tray icon. ### Declaration ```csharp public uint TrayIconId { get; } ``` ### Property Value - **Type**: uint - **Description**: The unique identifier for the tray icon. ``` -------------------------------- ### WindowEx Class Overview Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.html Provides an overview of the WindowEx class, including its inheritance hierarchy, implemented interfaces, and namespace. ```APIDOC ## Class WindowEx A custom WinUI Window with more convenience methods ### Inheritance object Window WindowEx ### Implements IWinRTObject IDynamicInterfaceCastable IEquatable ### Namespace WinUIEx ### Assembly WinUIEx.dll ### Syntax ```csharp [ContentProperty(Name = "WindowContent")] public class WindowEx : Window, IWinRTObject, IDynamicInterfaceCastable, IEquatable ``` ``` -------------------------------- ### Window Restore Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.Restore.html Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. ```APIDOC ## Restore(Window) ### Description Activates and displays the window. If the window is minimized or maximized, the system restores it to its original size and position. ### Method static void ### Parameters #### Path Parameters - **window** (Window) - Required - The window to restore. ### Remarks The presenter must be an overlapped presenter. ### Exceptions - **NotSupportedException**: Thrown if the AppWindow Presenter isn't an overlapped presenter. ``` -------------------------------- ### Property: Title Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Title.html Allows you to get or set the title of the window. ```APIDOC ## Property: Title ### Description Gets or sets the Window title. ### Declaration ```csharp public string Title { get; set; } ``` ### Property Value - **Type**: string - **Description**: The title of the window. ``` -------------------------------- ### TransparentTintBackdrop() Constructor Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TransparentTintBackdrop.-ctor.html Initializes a new instance of the TransparentTintBackdrop class with default settings. ```APIDOC ## TransparentTintBackdrop() ### Description Initializes a new instance of the TransparentTintBackdrop class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example ```csharp var backdrop = new TransparentTintBackdrop(); ``` ### Response N/A ``` -------------------------------- ### Property Header Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Header.html Gets or sets the Header content for the titlebar. ```APIDOC ## Property Header ### Description Gets or sets the Header content for the titlebar. ### Declaration ```csharp public object? Header { get; set; } ``` ### Property Value | Type | Description | |--------|-------------| | object | | ``` -------------------------------- ### Constructor TitleBarAutomationPeer Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBarAutomationPeer.-ctor.html Initializes a new instance of the TitleBar class. ```APIDOC ## TitleBarAutomationPeer(TitleBar) ### Description Initializes a new instance of the TitleBar class. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (N/A) None #### Response Example None ``` -------------------------------- ### Declaration of IsZOrderAtBottom Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.ZOrderInfo.IsZOrderAtBottom.html Defines the property as a read-only get and init-only setter. ```csharp public bool IsZOrderAtBottom { readonly get; init; } ``` -------------------------------- ### GetIsResizable(Window) Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.GetIsResizable.html Gets a value indicating whether the window is resizable or not. ```APIDOC ## GetIsResizable(Window) ### Description Gets a value indicating whether this resizable or not. ### Method GET ### Endpoint /websites/dotmorten_github_io_winuiex/GetIsResizable ### Parameters #### Path Parameters - **window** (Window) - Required - The window object to check. ### Response #### Success Response (200) - **bool** (bool) - True if the overlapped presenter is resizeable, otherwise false. ``` -------------------------------- ### Configure Window Manager Properties Source: https://dotmorten.github.io/WinUIEx/concepts/WindowManager.html Set properties such as minimum size, persistence ID, and backdrop for the window manager. ```csharp manager.PersistenceId = "MainWindowPersistanceId"; manager.MinWidth = 640; manager.MinHeight = 480; manager.Backdrop = new WinUIEx.MicaSystemBackdrop(); ``` -------------------------------- ### Initialize WindowMessageMonitor with window handle Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.Messaging.WindowMessageMonitor.-ctor.html Initializes the monitor using a window handle (nint) to listen for messages. ```csharp public WindowMessageMonitor(nint hwnd) ``` -------------------------------- ### PresenterKind Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.PresenterKind.html Gets or sets the presenter kind for the current window. ```APIDOC ## PresenterKind Property ### Description Gets or sets the presenter kind for the current window. ### Declaration ```csharp public AppWindowPresenterKind PresenterKind { get; set; } ``` ### Property Value | Type | |------------------| | AppWindowPresenterKind | ``` -------------------------------- ### Get Window Presenter Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.Presenter.html Retrieves the presenter object for the current window. ```APIDOC ## GET /websites/dotmorten_github_io_winuiex/Presenter ### Description Gets the presenter for the current window. ### Method GET ### Endpoint /websites/dotmorten_github_io_winuiex/Presenter ### Response #### Success Response (200) - **Presenter** (AppWindowPresenter) - The presenter object for the current window. #### Response Example ```json { "Presenter": { "//": "AppWindowPresenter object details would go here" } } ``` ``` -------------------------------- ### TransparentTintBackdrop Constructors Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TransparentTintBackdrop.html Details on how to initialize new instances of the TransparentTintBackdrop class. ```APIDOC ### Constructors #### TransparentTintBackdrop() Initializes a new instance of the TransparentTintBackdrop class. #### TransparentTintBackdrop(Color) Initializes a new instance of the TransparentTintBackdrop class with a specified color. ``` -------------------------------- ### SetWindowSize Method Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.HwndExtensions.SetWindowSize.html Allows setting the width and height of a window. ```APIDOC ## SetWindowSize ### Description Sets the width and height of the window in device-independent pixels. ### Method `public static void SetWindowSize(nint hwnd, double width, double height)` ### Parameters #### Path Parameters - **hwnd** (nint) - Required - The window handle. - **width** (double) - Required - The desired width of the window. - **height** (double) - Required - The desired height of the window. ### Request Example ```csharp // Example usage: WindowHelper.SetWindowSize(myWindowHandle, 800.0, 600.0); ``` ### Response This method does not return a value. ``` -------------------------------- ### Property Flyout Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIconEventArgs.Flyout.html Gets or sets the flyout to be shown when this event triggers. ```APIDOC ## Property Flyout ### Description Gets or sets the flyout to be shown when this event triggers. ### Method GET/SET ### Endpoint N/A (This is a property, not an endpoint) ### Parameters N/A ### Request Body N/A ### Response #### Success Response (200) - **Flyout** (FlyoutBase?) - The flyout object. #### Response Example ```json { "Flyout": null // or an instance of FlyoutBase } ``` ``` -------------------------------- ### Initialize Window Message Monitor Source: https://dotmorten.github.io/WinUIEx/concepts/WindowMessageMonitor.html Instantiate the WindowMessageMonitor and subscribe to the WindowMessageReceived event. Ensure the monitor is associated with the correct window context. ```csharp var monitor = new WindowMessageMonitor(this); monitor.WindowMessageReceived += OnWindowMessageReceived; ``` -------------------------------- ### IconSource Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.IconSource.html Provides information on how to get or set the IconSource for the titlebar. ```APIDOC ## IconSource Property ### Description Gets or sets the Icon for the titlebar. ### Declaration ```csharp public IconSource IconSource { get; set; } ``` ### Property Value | Type | |------------| | IconSource | ``` -------------------------------- ### Static Method FromFile Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.Icon.FromFile.html Loads an icon from an .ico file path. ```APIDOC ## FromFile(string) ### Description Loads an icon from an .ico file. ### Method Static Method ### Parameters #### Path Parameters - **filename** (string) - Required - Path to file ### Returns - **Icon** (Icon) - The loaded icon object ### Declaration ```csharp public static Icon FromFile(string filename) ``` ``` -------------------------------- ### Get TitleBarTemplateSettings Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.TemplateSettings.html Retrieves the template settings for the titlebar. This property is read-only. ```csharp public TitleBarTemplateSettings TemplateSettings { get; } ``` -------------------------------- ### TextAlignment Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.TextAlignment.html Gets or sets the text alignment of the text in the control. ```APIDOC ## TextAlignment Property ### Description Gets or sets the text alignment of the text in the control. ### Declaration ```csharp public TextAlignment TextAlignment { get; set; } ``` ### Property Value Type | Description ---|--- TextAlignment | ``` -------------------------------- ### Initialize WebAuthenticatorResult with Dictionary Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WebAuthenticatorResult.-ctor.html Creates a new instance using a dictionary of values extracted from an authentication callback. ```csharp public WebAuthenticatorResult(Dictionary values) ``` -------------------------------- ### Initialize WebAuthenticatorResult with Uri Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WebAuthenticatorResult.-ctor.html Creates a new instance using a callback URI. ```csharp public WebAuthenticatorResult(Uri callbackUrl) ``` -------------------------------- ### Get RefreshToken Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WebAuthenticatorResult.RefreshToken.html Retrieves the value for the 'refresh_token' key from the callback URI. ```csharp public string RefreshToken { get; } ``` -------------------------------- ### Declare TintColor Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TransparentTintBackdrop.TintColor.html Defines the TintColor property with get and set accessors. ```csharp public Color TintColor { get; set; } ``` -------------------------------- ### Initialize TransparentTintBackdrop Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TransparentTintBackdrop.-ctor.html Initializes a new instance of the TransparentTintBackdrop class without a specific tint color. ```csharp public TransparentTintBackdrop() ``` -------------------------------- ### SplashScreen(Window) Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.-ctor.html Constructor that creates and activates a new splashscreen, opening the specified window instance once complete. ```APIDOC ## SplashScreen(Window) ### Description Creates and activates a new splashscreen, and opens the specified window once complete. ### Parameters #### Path Parameters - **window** (Window) - Required - Window to open once splash screen is complete ### Request Example SplashScreen splash = new SplashScreen(myWindow); ``` -------------------------------- ### Property Footer API Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.Footer.html Provides methods to get or set the footer of the titlebar. ```APIDOC ## Property Footer ### Description Gets or sets the footer of the titlebar. ### Method GET, SET ### Endpoint N/A (This is a property, not a REST endpoint) ### Parameters N/A ### Request Body N/A ### Request Example ```csharp // To get the footer var footer = titlebar.Footer; // To set the footer titlebar.Footer = new FooterObject(); ``` ### Response #### Success Response (200) - **object** - The footer object. #### Response Example ```json { "footer": "object" } ``` ``` -------------------------------- ### TitleBar() Constructor Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.-ctor.html Initializes a new instance of the TitleBar class. ```APIDOC ## TitleBar() ### Description Initializes a new instance of the TitleBar class. ### Method Constructor ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### SelectionHighlightColor Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.SelectionHighlightColor.html Gets or sets the brush used to highlight the selected text. ```APIDOC ## SelectionHighlightColor Property ### Description Gets or sets the brush used to highlight the selected text. ### Declaration ```csharp public SolidColorBrush? SelectionHighlightColor { get; set; } ``` ### Property Value - **Type**: SolidColorBrush - **Description**: The brush used to highlight the selected text. The practical default is a brush using the theme resource `TextSelectionHighlightThemeColor`. ``` -------------------------------- ### RectMonitor Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.MonitorInfo.RectMonitor.html Gets the display monitor rectangle, expressed in virtual-screen coordinates. ```APIDOC ## RectMonitor Property ### Description Gets the display monitor rectangle, expressed in virtual-screen coordinates. ### Declaration ```csharp public Rect RectMonitor { get; } ``` ### Property Value - **Rect** (Rect) - The rectangle representing the display monitor in virtual-screen coordinates. ### Remarks If the monitor is not the primary display monitor, some of the rectangle's coordinates may be negative values. ``` -------------------------------- ### Register and Authenticate with WebAuthenticator Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WebAuthenticator.html This snippet demonstrates how to register a protocol for activation, initiate an OAuth authentication flow using WebAuthenticator, and then unregister the protocol. Ensure your app is configured for OAuth with a custom schema. ```csharp try { Microsoft.Windows.AppLifecycle.ActivationRegistrationManager.RegisterForProtocolActivation("myappscheme", "Assets\\Square150x150Logo.scale-100", "My App Name", null); var result = await WebAuthenticator.AuthenticateAsync(authorizeUri, callbackUri, cancellationToken); } finally { Microsoft.Windows.AppLifecycle.ActivationRegistrationManager.UnregisterForProtocolActivation("myappscheme", null); } ``` -------------------------------- ### GET GetWindowStyle Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.HwndExtensions.GetWindowStyle.html Retrieves the current window style for a given window handle. ```APIDOC ## GET GetWindowStyle ### Description Gets the current window style for the specified window handle. ### Method GET ### Parameters #### Path Parameters - **hWnd** (nint) - Required - The handle to the window. ### Response #### Success Response (200) - **WindowStyle** (WindowStyle) - The current style of the window. ``` -------------------------------- ### Initialize TitleBar Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.-ctor.html Initializes a new instance of the TitleBar class. ```csharp public TitleBar() ``` -------------------------------- ### AppWindow Property Access Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.AppWindow.html This snippet shows how to get a reference to the AppWindow for the current application. ```APIDOC ## AppWindow Property ### Description Gets a reference to the AppWindow for the app. ### Method GET ### Endpoint Not applicable (property access) ### Property Value - **Type**: AppWindow - **Description**: A reference to the application's main window. ``` -------------------------------- ### Property IsMinimizable Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.IsMinimizable.html Gets or sets a value indicating whether the minimize button is visible. ```APIDOC ## Property IsMinimizable ### Description Gets or sets a value indicating whether the minimize button is visible. ### Declaration ```csharp public bool IsMinimizable { get; set; } ``` ### Property Value Type | Description ---|--- bool | Indicates if the minimize button is visible. ``` -------------------------------- ### TitleBar Class Overview Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.html Overview of the TitleBar class, its inheritance, and available dependency properties. ```APIDOC ## TitleBar Class ### Description The TitleBar class is a control provided by the WinUIEx library. It is currently marked as obsolete; developers should migrate to the Windows App SDK's native TitleBar control. ### Syntax ```csharp [Obsolete("Use Windows App SDK's TitleBar control instead.")] public class TitleBar : Control, ... ``` ### Dependency Properties - **ContentProperty** - Identifies the Content dependency property. - **FooterProperty** - Identifies the Footer dependency property. - **HeaderProperty** - Identifies the Header dependency property. - **IconSourceProperty** - Identifies the IconSource dependency property. - **IsBackButtonVisibleProperty** - Identifies the IsBackButtonVisible dependency property. - **IsBackEnabledProperty** - Identifies the IsBackEnabled dependency property. - **IsPaneToggleButtonVisibleProperty** - Identifies the IsPaneToggleButtonVisible dependency property. - **SubtitleProperty** - Identifies the Subtitle dependency property. - **TemplateSettingsProperty** - Identifies the TemplateSettings dependency property. - **TitleProperty** - Identifies the Title dependency property. ``` -------------------------------- ### Property: IsTitleBarVisible Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.IsTitleBarVisible.html Provides information on how to get or set the visibility of the default title bar. ```APIDOC ## Property: IsTitleBarVisible ### Description Gets or sets a value indicating whether the default title bar is visible or not. ### Declaration ```csharp public bool IsTitleBarVisible { get; set; } ``` ### Property Value Type | Description ---|--- bool | ``` -------------------------------- ### TransparentTintBackdrop(Color) Constructor Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TransparentTintBackdrop.-ctor.html Initializes a new instance of the TransparentTintBackdrop class with a specified tint color. ```APIDOC ## TransparentTintBackdrop(Color tintColor) ### Description Initializes a new instance of the TransparentTintBackdrop class with a specified tint color. ### Method Constructor ### Endpoint N/A ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **tintColor** (Color) - Required - Color for the background. The Alpha value defines the opacity of the window. ### Request Example ```csharp Color myColor = Color.FromArgb(128, 255, 0, 0); // Semi-transparent red var backdrop = new TransparentTintBackdrop(myColor); ``` ### Response N/A ``` -------------------------------- ### SystemBackdrop Properties Source: https://dotmorten.github.io/WinUIEx/api/omd.html Properties for configuring system backdrop appearance. ```APIDOC ## SystemBackdrop Properties ### Description Properties that define the appearance and behavior of the system backdrop. ### Properties * **DarkFallbackColor { get; set; }**: Gets or sets the fallback color for dark mode. * **DarkLuminosityOpacity { get; set; }**: Gets or sets the luminosity opacity for dark mode. * **DarkTintColor { get; set; }**: Gets or sets the tint color for dark mode. * **DarkTintOpacity { get; set; }**: Gets or sets the tint opacity for dark mode. * **IsSupported { get; }**: Gets a value indicating whether the system backdrop is supported. * **LightFallbackColor { get; set; }**: Gets or sets the fallback color for light mode. * **LightLuminosityOpacity { get; set; }**: Gets or sets the luminosity opacity for light mode. * **LightTintColor { get; set; }**: Gets or sets the tint color for light mode. * **LightTintOpacity { get; set; }**: Gets or sets the tint opacity for light mode. ``` -------------------------------- ### IsBackButtonVisible Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TitleBar.IsBackButtonVisible.html Gets or sets a value indicating whether the back button is visible. ```APIDOC ## IsBackButtonVisible Property ### Description Gets or sets a value indicating whether the back button is visible. ### Declaration ```csharp public bool IsBackButtonVisible { get; set; } ``` ### Property Value Type | Description ---|--- bool | ``` -------------------------------- ### Create SplashScreen with Window Type Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.html Use this constructor to create and activate a new splash screen. It will automatically create and open an instance of the specified Window type once its loading process is complete. ```csharp public SplashScreen(Type type) ``` -------------------------------- ### TextReadingOrder Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.TextReadingOrder.html Gets or sets a value that indicates how the reading order is determined for the NumberBox. ```APIDOC ## TextReadingOrder Property ### Description Gets or sets a value that indicates how the reading order is determined for the NumberBox. ### Declaration ```csharp public TextReadingOrder TextReadingOrder { get; set; } ``` ### Property Value Type | Description ---|--- TextReadingOrder | A value of the enumeration that specifies how the reading order is determined for the NumberBox. ``` -------------------------------- ### TrayIcon Constructor with Icon Path Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.-ctor.html Initializes a new instance of the TrayIcon class using a file path to an icon image and tooltip text. ```APIDOC ## TrayIcon(uint, string, string) ### Description Initializes a new instance of the TrayIcon class with the specified icon file path and tooltip text. ### Method Constructor ### Parameters #### Path Parameters - **trayiconId** (uint) - Required - A unique identifier for the tray icon. - **iconPath** (string) - Required - The file path to the icon image to display in the system tray. Must refer to a valid .ico image file. - **tooltip** (string) - Required - The tooltip text to display when the user hovers over the tray icon. Maximum length: 128 characters. ### Request Example ```csharp // Example usage: TrayIcon myIcon = new TrayIcon(2, "C:\\path\\to\\my\\icon.ico", "My Application Status"); ``` ### Response #### Success Response (200) - **TrayIcon** (TrayIcon) - The newly created TrayIcon instance. #### Response Example ```json { "message": "TrayIcon initialized successfully" } ``` ``` -------------------------------- ### Maximum Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.NumberBox-1.Maximum.html Provides details on how to get or set the numerical maximum for the Value property. ```APIDOC ## Maximum Property ### Description Gets or sets the numerical maximum for Value. ### Declaration ```csharp public T Maximum { get; set; } ``` ### Property Value | Type | Description | |---|---| | T | The numerical maximum for Value. | ``` -------------------------------- ### Get Message ID - C# Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.Messaging.Message.MessageId.html Retrieves the unique identifier for a message. This property is read-only. ```csharp public readonly uint MessageId { get; } ``` -------------------------------- ### WindowEx Constructors Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.html Details the constructors available for the WindowEx class. ```APIDOC ## Constructors ### WindowEx() Initializes a new instance of the WindowEx class. ``` -------------------------------- ### Window Styling and Customization Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowExtensions.html Methods for setting window styles, icons, and title bar appearance. ```APIDOC ## Window Styling and Customization ### Description Methods for setting window styles, icons, and title bar appearance. ### Methods - **SetExtendedWindowStyle(Window, ExtendedWindowStyle)**: Sets the current window style. - **SetForegroundWindow(Window)**: Brings the thread that created the specified window into the foreground and activates the window. - **SetIcon(Window, IconId)**: Sets the icon for the window, using the specified icon ID. - **SetIcon(Window, string)**: Sets the icon for the window, using the specified icon path. - **SetTaskBarIcon(Window, Icon?)**: Sets the task bar icon to the provided icon. - **SetTitleBarBackgroundColors(Window, Color)**: Gets the background color for the title bar and all its buttons and their states. - **SetWindowPresenter(Window, AppWindowPresenterKind)**: Sets the window presenter kind used. - **SetWindowStyle(Window, WindowStyle)**: Sets the current window style. ``` -------------------------------- ### IsZOrderAtBottom Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.ZOrderInfo.IsZOrderAtBottom.html Gets a value indicating whether the window's Z Order is at the bottom. ```APIDOC ## IsZOrderAtBottom Property ### Description Gets a value indicating whether the window's Z Order is at the bottom. ### Declaration ```csharp public bool IsZOrderAtBottom { readonly get; init; } ``` ### Property Value - **Type**: bool - **Description**: Indicates if the window's Z Order is at the bottom. ``` -------------------------------- ### Initialize WebAuthenticator in App constructor Source: https://dotmorten.github.io/WinUIEx/concepts/Maui.html Add the OAuth redirection check to the App constructor in App.xaml.cs. ```csharp public App() { if (WinUIEx.WebAuthenticator.CheckOAuthRedirectionActivation()) return; this.InitializeComponent(); } ``` -------------------------------- ### Get Window Manager Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowManager.Get.html Retrieves the window manager for a given window, creating it if it doesn't exist. ```APIDOC ## GET /windows/{windowId}/manager ### Description Gets (or creates) a window manager for the specific window. ### Method GET ### Endpoint /windows/{windowId}/manager ### Parameters #### Path Parameters - **window** (Window) - Required - The window for which to get the window manager. ### Response #### Success Response (200) - **WindowManager** (WindowManager) - The window manager instance. #### Response Example ```json { "message": "WindowManager retrieved successfully" } ``` ``` -------------------------------- ### TaskBarIcon Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.TaskBarIcon.html Gets or sets the task bar icon. This property is obsolete and should be replaced with AppWindow.SetTaskbarIcon. ```APIDOC ## TaskBarIcon Property ### Description Gets or sets the task bar icon. ### Declaration ```csharp [Obsolete("Use AppWindow.SetTaskbarIcon")] public Icon? TaskBarIcon { get; set; } ``` ### Property Value | Type | Description | |---|---| | Icon | | ``` -------------------------------- ### Window Properties and Configuration Source: https://dotmorten.github.io/WinUIEx/api/omd.html Defines the core properties available for configuring window behavior, appearance, and state. ```APIDOC ## Window Properties ### Description Properties used to configure window dimensions, visibility, state, and system integration features. ### Properties - **Backdrop** (SystemBackdrop?) - Optional - The system backdrop controller. - **Height/Width** (double) - Required - Window dimensions. - **IsAlwaysOnTop** (bool) - Required - Determines if the window stays above others. - **IsMaximizable/IsMinimizable/IsResizable** (bool) - Required - Window interaction capabilities. - **PersistenceId** (String?) - Optional - Identifier for state persistence. - **Title** (string) - Required - The window title text. - **WindowState** (WindowState) - Required - Current state of the window. ``` -------------------------------- ### Property MaxHeight Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.MaxHeight.html Documentation for the MaxHeight property used to set or get the maximum height of a window. ```APIDOC ## Property MaxHeight ### Description Gets or sets the maximum height of this window. ### Declaration `public double MaxHeight { get; set; }` ### Property Value - **Type**: double - **Description**: The maximum window height in device independent pixels. ### Remarks The default is 0, which means no limit. If the value is less than MinHeight, the MinHeight will also be used as the maximum height. ``` -------------------------------- ### TrayIcon Class Reference Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.html Overview of the TrayIcon class, its constructors, properties, methods, and events for managing system tray icons. ```APIDOC ## Class: TrayIcon ### Description Represents an application icon displayed in the Windows system tray. It allows applications to show, update, and interact with a tray icon, its tooltip, and associated events. ### Namespace WinUIEx ### Constructors - **TrayIcon(uint, IconId, string)**: Initializes a new instance with the specified icon and tooltip text. - **TrayIcon(uint, string, string)**: Initializes a new instance with the specified icon and tooltip text. ### Properties - **IsVisible** (bool): Gets or sets a value indicating whether this instance is visible in the tray. - **Tooltip** (string): Gets or sets the tooltip displayed when hovering. Max length: 128 characters. - **TrayIconId** (uint): Gets the unique identifier for the tray icon. ### Methods - **CloseFlyout()**: Force-closes the flyout if it is visible. - **Dispose()**: Frees unmanaged resources. - **SetIcon(IconId)**: Sets the icon displayed for the application's taskbar window. - **SetIcon(string)**: Sets the icon displayed for the application's taskbar button. ### Events - **ContextMenu**: Occurs on right-click or keyboard context menu selection. - **LeftDoubleClick**: Occurs on left mouse double-click. - **RightDoubleClick**: Occurs on right mouse double-click. - **Selected**: Occurs on left mouse click or keyboard selection. ``` -------------------------------- ### Method OnLoading Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.SplashScreen.OnLoading.html Documentation for the OnLoading method used to display loading progress or delay main window initialization. ```APIDOC ## OnLoading() ### Description Override this method to display loading progress or to delay the loading of the main window. ### Declaration `protected virtual Task OnLoading()` ### Returns - **Task** - Represents the asynchronous operation. ``` -------------------------------- ### Property Height Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WindowEx.Height.html Provides information on how to get or set the height of a window using the Height property. ```APIDOC ## Property Height ### Description Gets or sets the height of the window. ### Declaration ```csharp public double Height { get; set; } ``` ### Property Value | Type | Description | |--------|-------------| | double | | ``` -------------------------------- ### SystemBackdrop Class Source: https://dotmorten.github.io/WinUIEx/api/omd.html Represents a system backdrop. ```APIDOC ## SystemBackdrop Class ### Description Provides functionality for system-level backdrops. ### Constructors * **SystemBackdrop()**: Initializes a new instance of the SystemBackdrop class. ``` -------------------------------- ### Get AccessToken Property Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.WebAuthenticatorResult.AccessToken.html Retrieves the value for the 'access_token' key from the callback URI. This property is read-only. ```csharp public string AccessToken { get; } ``` -------------------------------- ### Get Tray Icon Identifier Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.TrayIconId.html Retrieves the unique identifier for the tray icon. This property is read-only. ```csharp public uint TrayIconId { get; } ``` -------------------------------- ### Initialize TrayIcon with IconId Source: https://dotmorten.github.io/WinUIEx/api/WinUIEx.TrayIcon.-ctor.html Use this constructor to create a tray icon using a predefined IconId. The tooltip is limited to 128 characters. ```csharp public TrayIcon(uint trayiconId, IconId iconId, string tooltip) ```