Class TabRendererFactory

Manages custom ITabRenderers (custom tab styles).

Inheritance

System.Object

TabRendererFactory

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms.Tools

Assembly: Syncfusion.Tools.Windows.dll

Syntax

public abstract class TabRendererFactory

Remarks

When you create a custom tab style, you have to register it with the framework through the RegisterTabType(String, Type, ITabDefaultProperties) method.

Constructors

TabRendererFactory()

Declaration

protected TabRendererFactory()

Methods

CreateNewTabRenderer(String, ITabControl, ITabPanelRenderer)

Returns a new instance of a registered ITabRenderer given the custom tab style name.

Declaration

public static ITabRenderer CreateNewTabRenderer(string tabStyle, ITabControl tabControl, ITabPanelRenderer panelRenderer)

Parameters

Type	Name	Description
System.String	tabStyle	The custom tab style name.
ITabControl	tabControl	The tab control that requests a new instance.
ITabPanelRenderer	panelRenderer	The panel renderer that requests a new instance.

Returns

Type	Description
ITabRenderer	A ITabRenderer instance.

GetRegisteredExtender(String)

Returns the ITabDefaultProperties instance associated with the specified tab style.

Declaration

public static ITabDefaultProperties GetRegisteredExtender(string tabStyle)

Parameters

Type	Name	Description
System.String	tabStyle	The tab style name.

Returns

Type	Description
ITabDefaultProperties	A ITabDefaultProperties instance.

GetRegisteredRenderers(Boolean)

Returns a list of registered ITabRenderer types.

Declaration

public static ArrayList GetRegisteredRenderers(bool forDesignTime)

Parameters

Type	Name	Description
System.Boolean	forDesignTime	Indicates whether this list is for design-time.

Returns

Type	Description
System.Collections.ArrayList	An ArrayList of System.Type instances.

Remarks

If forDesignTime is true, then tab styles with the ShowInDesignMode property set to false will be excluded from the returned list.

RegisterTabType(String, Type, ITabDefaultProperties)

Registers custom tab styles with the framework.

Declaration

public static void RegisterTabType(string tabStyleName, Type tabType, ITabDefaultProperties tabPanelPropertyExtender)

Parameters

Type	Name	Description
System.String	tabStyleName	A unique name associated with your tab style.
System.Type	tabType	A ITabRenderer implementation.
ITabDefaultProperties	tabPanelPropertyExtender	A ITabDefaultProperties implementation.

Remarks

Each "tab style" (that you can specify in the TabStyle property) is represented by a type that implements the ITabRenderer interface and a corresponding ITabDefaultProperties implementation to specify certain default tab control properties. Register these implementations with this method before specifying them in the TabStyle property. A good place to do the registration is from your ITabRenderer implementation's static constructor.

Note that your ITabRenderer implementation should have a non-default constructor that takes the following 2 parameters: (ITabControl and ITabPanelRenderer).