AuthenticationProviderExtensionsLoadIcon Method

Loads an icon from embedded resources associated with the authentication provider.

Definition

Namespace: Gemstone.Security.AuthenticationProviders
Assembly: Gemstone.Security (in Gemstone.Security.dll) Version: 1.0.170 -- Release Build+ca3065dc8f8b84c59ee38bd3367c3e71f3818071

C#View Source Request Example

public static (string MediaType, Stream Data)? LoadIcon(
	this IAuthenticationProvider provider
)

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function LoadIcon ( 
	provider As IAuthenticationProvider
) As (MediaType As String, Data As Stream)?

C++View Source Request Example

public:
[ExtensionAttribute]
static Nullable<ValueTuple<String^, Stream^>> LoadIcon(
	IAuthenticationProvider^ provider
)

JavaScriptView Source Request Example

Gemstone.Security.AuthenticationProviders.AuthenticationProviderExtensions.LoadIcon = function(provider);

Parameters

provider IAuthenticationProvider: The provider which is visually represented by the icon

Return Value

NullableValueTupleString, Stream
The icon associated with the provider.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IAuthenticationProvider. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Remarks

Supported file types are jpg, png, gif, svg, and webp.

For a hypothetical ExampleProvider in the Gemstone.Example namespace, the embedded resource name for a jpg icon would be Gemstone.Example.ExampleProvider.jpg.

Expect that icons will be rendered in an approximately square space, 32 pixels tall. Therefore, a good target size would be 32x32, but it can be a bit wider or narrower.