alexrg/SGU-CredentialProvider
1
0
Fork 0
Code Issues 1 Pull Requests Actions Packages Projects Releases 25 Wiki Activity

Document bitmap transparency and public API

Browse Source 
Explain image behavior for each credential tile version, package the README and XML documentation, and complete the public API comments.
This commit is contained in:
Ryan Newington
2026-08-30 08:10:32 +10:00
parent 8b12b4d078
commit b0d6ccc702
37 changed files with 350 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Lithnet.CredentialProvider/Controls/CredentialProviderLogoControl.cs
+12 -11
View File
@@ -3,29 +3,30 @@
namespace Lithnet.CredentialProvider
{
/// <summary>
/// Represents a control that provides the credential UI with the logo of this credential provider
/// Represents a control that provides the credential UI with the logo of this credential provider.
/// </summary>
/// <remarks>See <see cref="BitmapControl.BackgroundColor"/> for the image transparency behaviour of each credential tile version.</remarks>
public class CredentialProviderLogoControl : BitmapControl
{
/// <summary>
/// Creates a new <c ref="CredentialProviderLogoControl"/> control
/// Creates a new <see cref="CredentialProviderLogoControl"/> control.
/// </summary>
/// <param name="key">The unique key for this control</param>
/// <param name="key">The unique key for this control.</param>
public CredentialProviderLogoControl(string key) : this(key, null, null) { }
/// <summary>
/// Creates a new <c ref="CredentialProviderLogoControl"/> control
/// Creates a new <see cref="CredentialProviderLogoControl"/> control.
/// </summary>
/// <param name="key">The unique key for this control</param>
/// <param name="label">The label associated with the control. This value is not displayed to the user</param>
/// <param name="key">The unique key for this control.</param>
/// <param name="label">The label associated with the control. This value is not displayed to the user.</param>
public CredentialProviderLogoControl(string key, string label) : this(key, label, null) { }
/// <summary>
/// Creates a new <c ref="CredentialProviderLogoControl"/> control
/// Creates a new <see cref="CredentialProviderLogoControl"/> control.
/// </summary>
/// <param name="key">The unique key for this control</param>
/// <param name="label">The label associated with the control</param>
/// <param name="bitmap">The bitmap to use as the logo</param>
/// <param name="key">The unique key for this control.</param>
/// <param name="label">The label associated with the control.</param>
/// <param name="bitmap">The bitmap to use as the logo.</param>
public CredentialProviderLogoControl(string key, string label, Bitmap bitmap) : base(key, label, true, bitmap)
{
this.State = FieldState.DisplayInDeselectedTile;
@@ -38,4 +39,4 @@ namespace Lithnet.CredentialProvider
return new CredentialProviderLogoControl(this);
}
}
}
}