Class SfTabbedForm

Represents a window that provides the tabbed user interface.

Inheritance
System.Object
SfForm
SfTabbedForm
Inherited Members
Namespace: Syncfusion.Windows.Forms.Tools
Assembly: Syncfusion.Tools.Windows.dll
Syntax
public class SfTabbedForm : SfForm, IThemeProvider, IVisualStyle

Constructors

SfTabbedForm()

Initializes a new instance of the SfTabbedForm class.

Declaration
public SfTabbedForm()

Properties

BaseThemeName

Gets or sets the BaseThemeName of the form.

Declaration
protected string BaseThemeName { get; set; }
Property Value
Type
System.String

CanApplyTheme

Gets or sets a value indicating whether a theme style has been applied to the control.

Declaration
public bool CanApplyTheme { get; set; }
Property Value
Type Description
System.Boolean

The default value is true.

CanOverrideStyle

Gets or sets a value indicating whether control elements styles can be overridden by theme style settings.

Declaration
public bool CanOverrideStyle { get; set; }
Property Value
Type Description
System.Boolean

Default value is false.
Remarks

By default, the control's element styles will not be overridden by theme style settings if the style is set in sample level. If this property is enabled, element style will be overridden by theme style settings event if it is set in sample level. This property should be enabled or disabled before calling the ThemeName property of the control.

ControlName

Gets the name of the form.

Declaration
public string ControlName { get; }
Property Value
Type
System.String

CreateParams

Gets the required creation parameters when the control handle is created.

Declaration
protected override CreateParams CreateParams { get; }
Property Value
Type
System.Windows.Forms.CreateParams

ExtendTabsToTitleBar

Gets or sets a value indicating whether the tabs should be extend to the title bar.

Declaration
public bool ExtendTabsToTitleBar { get; set; }
Property Value
Type
System.Boolean

TabbedFormControl

Gets or sets the SfTabbedFormControl to load the tabs in form.

Declaration
public SfTabbedFormControl TabbedFormControl { get; set; }
Property Value
Type
SfTabbedFormControl

ThemeName

Gets or sets the theme name of the form control.

Declaration
public string ThemeName { get; set; }
Property Value
Type Description
System.String

The default value is null.
Remarks

The theme will be applied only when the particular theme for this control has included the Themes assembly.

VisualTheme

Gets or sets the visualTheme of the control, which holds the ThemeName applied from SkinManager

Declaration
protected string VisualTheme { get; set; }
Property Value
Type
System.String

Methods

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.
Overrides

GetActiveThemeName()

Gets the active theme name of the control.

Declaration
public string GetActiveThemeName()
Returns
Type Description
System.String

Returns the active theme name.

OnLoad(EventArgs)

Raises the Syncfusion.WinForms.Controls.SfForm.Load event.

Declaration
protected override void OnLoad(EventArgs args)
Parameters
Type Name Description
System.EventArgs args

Event Arguments.
Overrides

OnStyleChanged(EventArgs)

Occurs when style of the form changed.

Declaration
protected override void OnStyleChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

The System.EventArgs that contains the event data.

WndProc(ref Message)

Processes Windows messages.

Declaration
protected override void WndProc(ref Message m)
Parameters
Type Name Description
System.Windows.Forms.Message m

Windows message.
Overrides

Events

ThemeNameChanged

Occurs when theme name of the SfTabbedForm has changed.

Declaration
public event ThemeChangedEventHandler ThemeNameChanged
Event Type
Type
ThemeChangedEventHandler

Explicit Interface Implementations

IVisualStyle.VisualTheme

Gets or sets the VisualTheme of the form.

Declaration
string IVisualStyle.VisualTheme { get; set; }
Returns
Type
System.String

IThemeProvider.BaseThemeName

Gets or sets the BaseTheme name of the theme

Declaration
string IThemeProvider.BaseThemeName { get; set; }
Returns
Type
System.String

Implements