Interface ISill
- Namespace
- WindowSill.API
- Assembly
- WindowSill.API.dll
Represents the declaration of a sill.
public interface ISill- Extension Methods
Remarks
<pre><code class="lang-csharp">[(typeof())]
[("My Sill")]
[()] // Optional. Default is .
[(Before = "OtherSill", After = "AnotherSill")] // Optional. Use to tied break ordering of sills when conflicting properties are set.
internal sealed class MySill:
{
}</code></pre>
Properties
DisplayName
Gets the name of the sill to be displayed in the Settings dialog and other places.
string DisplayName { get; }Property Value
SettingsViews
Gets a list of settings views that this sill provides.
SillSettingsView[]? SettingsViews { get; }Property Value
Remarks
When null or empty, the sill will not have any settings views in the Settings dialog. When multiple views are provided, they will appear as sub item or a root item that is named after the DisplayName property.
Methods
CreateIcon()
Invoked when WindowSill needs to display the icon of this sill in the UI. The icon will be displayed in the Settings dialog, in the Sill bar when implementing ISillListView, and other places where the icon is needed.
IconElement CreateIcon()Returns
Remarks
Do NOT cache the icon element. WindowSill cache it already and may request the icon multiple time depending on how many places will display the icon.
OnDeactivatedAsync()
Invoked when the sill is deactivated and gets removed from the sill bar.
ValueTask OnDeactivatedAsync()Returns
Remarks
This method is not awaited for completion.