Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

UIRendererManager Class

Namespace:
ActiproSoftware.UI.WinForms.Controls
Assembly:
ActiproSoftware.Shared.WinForms.dll

Managers the renderers used to render Actipro control products and controls the global theme for those products.

[ToolboxBitmap(typeof(UIRendererManager))]
public class UIRendererManager : Component, IDisposable
Inheritance:
object MarshalByRefObject Component object
Implements:
IDisposable

Constructors

UIRendererManager()

Initializes an instance of the class.

public UIRendererManager()

Properties

ColorScheme

The IWindowsColorScheme currently in use by the renderer manager.

public static IWindowsColorScheme ColorScheme { get; set; }

Property Value

IWindowsColorScheme

ColorSchemeType

A WindowsColorSchemeType that indicates the color scheme type to use for the renderers.

public WindowsColorSchemeType ColorSchemeType { get; set; }

Property Value

WindowsColorSchemeType

Methods

DecrementUsageCount(Type)

Flags that a renderer instance is no longer required for the specified renderer Type.

public static UIRendererManager.RendererData? DecrementUsageCount(Type rendererType)
Parameter Type Description
rendererType Type

The Type of renderer that is no longer needed.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

DecrementUsageCount<T>()

Flags that a renderer instance is no longer required for the specified renderer Type.

public static UIRendererManager.RendererData? DecrementUsageCount<T>() where T : IUIRenderer
Type Parameters:
T -

The Type of renderer.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

GetRendererData(Type)

Returns the UIRendererManager.RendererData for the specified renderer Type, if there is data available.

public static UIRendererManager.RendererData? GetRendererData(Type rendererType)
Parameter Type Description
rendererType Type

The Type of renderer to look for.

Returns

UIRendererManager.RendererData

GetRendererData<T>()

Returns the UIRendererManager.RendererData for the specified renderer Type, if there is data available.

public static UIRendererManager.RendererData? GetRendererData<T>() where T : IUIRenderer
Type Parameters:
T -

The Type of renderer.

Returns

UIRendererManager.RendererData

GetRenderer<T>()

Returns the renderer for the specified type.

public static T GetRenderer<T>() where T : IUIRenderer
Type Parameters:
T -

The Type of renderer.

Returns

T

Remarks

An ArgumentException is thrown if a IUIRenderer is not available for the given type, which can happen when a matching IUIRendererFactory has not being registered.

Exceptions

Type Condition
ArgumentException

See Also

IncrementUsageCount(Type, IUIRendererFactory)

Flags that a new renderer instance is requested for the specified renderer Type.

public static UIRendererManager.RendererData IncrementUsageCount(Type rendererType, IUIRendererFactory rendererFactory)
Parameter Type Description
rendererType Type

The Type of renderer that is needed.
rendererFactory IUIRendererFactory

The IUIRendererFactory that will be used to create renderers.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

IncrementUsageCount<T>(IUIRendererFactory)

Flags that a new renderer instance is requested for the specified renderer Type.

public static UIRendererManager.RendererData IncrementUsageCount<T>(IUIRendererFactory rendererFactory) where T : IUIRenderer
Type Parameters:
T -

The Type of renderer.

Parameter Type Description
rendererFactory IUIRendererFactory

The IUIRendererFactory that will be used to create renderers.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

RegisterRendererFactory(Type, IUIRendererFactory, bool)

Flags that a new renderer instance is requested for the specified renderer Type.

public static UIRendererManager.RendererData RegisterRendererFactory(Type rendererType, IUIRendererFactory rendererFactory, bool overwrite)
Parameter Type Description
rendererType Type

The Type of renderer that is needed.
rendererFactory IUIRendererFactory

The IUIRendererFactory that will be used to create renderers.
overwrite bool

Whether to overwrite any existing record.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

RegisterRendererFactory<T>(IUIRendererFactory, bool)

Flags that a new renderer instance is requested for the specified renderer Type.

public static UIRendererManager.RendererData RegisterRendererFactory<T>(IUIRendererFactory rendererFactory, bool overwrite) where T : IUIRenderer
Type Parameters:
T -

The Type of renderer generated by the factory.

Parameter Type Description
rendererFactory IUIRendererFactory

The IUIRendererFactory that will be used to create renderers.
overwrite bool

Whether to overwrite any existing record.

Returns

UIRendererManager.RendererData:

The UIRendererManager.RendererData for the given renderer type.

TryGetRenderer<T>(out T?)

Tries to gets the renderer for the specified type.

public static bool TryGetRenderer<T>(out T? renderer) where T : IUIRenderer
Type Parameters:
T -

The Type of renderer.

Parameter Type Description
renderer T

When found, outputs the renderer.

Returns

bool:

true if the renderer was found and output through the renderer parameter; otherwise, false.

See Also

Events

ColorSchemeChanged

Occurs after the ColorScheme property has changed.

public static event EventHandler? ColorSchemeChanged

Event Type

EventHandler

Inherited Members

Extension Methods