Class TitleBarStyleInfo

Represents the class that defines the title bar style information for the SfForm control.

Inheritance
System.Object
ShouldSerializeBasedPersisterType
StyleInfoBase
StyleInfoSubObjectBase
TitleBarStyleInfo
Implements
System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Syncfusion.WinForms.Controls.Styles
Assembly: Syncfusion.Shared.Base.dll
Syntax
public class TitleBarStyleInfo : StyleInfoSubObjectBase, ICustomTypeDescriptor, IDisposable, IStyleInfo, ISupportInitialize, IFormattable, IConvertible, IXmlSerializable, IStyleInfoSubObject

Constructors

TitleBarStyleInfo()

Initializes a new instance of the TitleBarStyleInfo class.

Declaration
public TitleBarStyleInfo()

TitleBarStyleInfo(StyleInfoSubObjectIdentity)

Initializes a new instance of the TitleBarStyleInfo class and associates it with an existing StyleInfoStore.

Declaration
public TitleBarStyleInfo(StyleInfoSubObjectIdentity identity)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A StyleInfoSubObjectIdentity that holds the identity for this StyleInfoBase.

TitleBarStyleInfo(StyleInfoSubObjectIdentity, TitleBarStyleInfoStore)

Initializes a new instance of the TitleBarStyleInfo class and associates it with an existing StyleInfoStore.

Declaration
public TitleBarStyleInfo(StyleInfoSubObjectIdentity identity, TitleBarStyleInfoStore store)
Parameters
Type Name Description
StyleInfoSubObjectIdentity identity

A StyleInfoSubObjectIdentity that holds the identity for this StyleInfoBase.
TitleBarStyleInfoStore store

A StyleInfoStore that holds data for this object. All changes in this style object will be saved in the StyleInfoStore object.

Properties

AllowRichText

Gets or sets a value indicating whether rich text can be provided as caption or not.

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

The default value is false.
Examples
this.Style.TitleBar.AllowRichText = true;
// Set rich text for the Form.Text property.
this.Text = "{\\rtf\\ansi \\b  Form1}";

BackColor

Gets or sets the background color of the TitleBar.

Declaration
public Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

BottomBorderColor

Gets or sets the bottom border color of the TitleBar.

Declaration
public Color BottomBorderColor { get; set; }
Property Value
Type
System.Drawing.Color

CaptionImage

Gets or sets the image to the caption bar.

Declaration
public Image CaptionImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

CaptionImageLocation

Gets or sets the location to the caption image.

Declaration
public Point CaptionImageLocation { get; set; }
Property Value
Type
System.Drawing.Point

CloseButtonForeColor

Gets or sets the fore color of the close button.

Declaration
public Color CloseButtonForeColor { get; set; }
Property Value
Type
System.Drawing.Color

CloseButtonHoverBackColor

Gets or sets the hover back color for the close button.

Declaration
public Color CloseButtonHoverBackColor { get; set; }
Property Value
Type
System.Drawing.Color

CloseButtonHoverForeColor

Gets or sets the hover fore color for the close button.

Declaration
public Color CloseButtonHoverForeColor { get; set; }
Property Value
Type
System.Drawing.Color

CloseButtonHoverImage

Gets or sets the hover image for the close button.

Declaration
public Image CloseButtonHoverImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

CloseButtonImage

Gets or sets the image for the close button.

Declaration
public Image CloseButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

CloseButtonPressedBackColor

Gets or sets the pressed background color of the close button.

Declaration
public Color CloseButtonPressedBackColor { get; set; }
Property Value
Type
System.Drawing.Color

CloseButtonPressedForeColor

Gets or sets the pressed fore color of the close button.

Declaration
public Color CloseButtonPressedForeColor { get; set; }
Property Value
Type
System.Drawing.Color

CloseButtonPressedImage

Gets or sets the pressed image for the close button.

Declaration
public Image CloseButtonPressedImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

CloseButtonSize

Gets or sets the size of the close button.

Declaration
public Size CloseButtonSize { get; set; }
Property Value
Type
System.Drawing.Size

DefaultStyle

Gets the default style of the TitleBar bar.

Declaration
public static TitleBarStyleInfo DefaultStyle { get; }
Property Value
Type
TitleBarStyleInfo

Font

Gets or sets the Font used to display text in the title bar.

Declaration
public Font Font { get; set; }
Property Value
Type
System.Drawing.Font
Examples
this.Style.TitleBar.Font = new Font("Segoe UI", 15, FontStyle.Bold);

ForeColor

Gets or sets the foreground color of the TitleBar.

Declaration
public Color ForeColor { get; set; }
Property Value
Type
System.Drawing.Color

HasFont

Gets a value indicating whether Font has been initialized for the TitleBar.

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

Height

Gets or sets the height of the TitleBar.

Declaration
public int Height { get; set; }
Property Value
Type
System.Int32

HelpButtonForeColor

Gets or sets the fore color of the help button.

Declaration
public Color HelpButtonForeColor { get; set; }
Property Value
Type
System.Drawing.Color

HelpButtonHoverBackColor

Gets or sets the hover back color for the help button.

Declaration
public Color HelpButtonHoverBackColor { get; set; }
Property Value
Type
System.Drawing.Color

HelpButtonHoverForeColor

Gets or sets the hover fore color for the help button.

Declaration
public Color HelpButtonHoverForeColor { get; set; }
Property Value
Type
System.Drawing.Color

HelpButtonHoverImage

Gets or sets the hover image for the help button.

Declaration
public Image HelpButtonHoverImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

HelpButtonImage

Gets or sets the image for the help button.

Declaration
public Image HelpButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

HelpButtonPressedBackColor

Gets or sets the pressed background color of the help button.

Declaration
public Color HelpButtonPressedBackColor { get; set; }
Property Value
Type
System.Drawing.Color

HelpButtonPressedForeColor

Gets or sets the pressed fore color of the help button.

Declaration
public Color HelpButtonPressedForeColor { get; set; }
Property Value
Type
System.Drawing.Color

HelpButtonPressedImage

Gets or sets the pressed image for the help button.

Declaration
public Image HelpButtonPressedImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

HelpButtonSize

Gets or sets the size of the help button.

Declaration
public Size HelpButtonSize { get; set; }
Property Value
Type
System.Drawing.Size

IconBackColor

Gets or sets the backcolor for the icon

Declaration
public Color IconBackColor { get; set; }
Property Value
Type
System.Drawing.Color

IconHorizontalAlignment

Gets or sets the horizontal alignment of the title bar icon.

Declaration
public HorizontalAlignment IconHorizontalAlignment { get; set; }
Property Value
Type Description
System.Windows.Forms.HorizontalAlignment

The default value is left.

IconVerticalAlignment

Gets or sets the vertical alignment of the title bar icon.

Declaration
public VerticalAlignment IconVerticalAlignment { get; set; }
Property Value
Type Description
System.Windows.Forms.VisualStyles.VerticalAlignment

The default value is center.

MaximizeButtonForeColor

Gets or sets the fore color of the maximize button.

Declaration
public Color MaximizeButtonForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MaximizeButtonHoverBackColor

Gets or sets the hover back color for the maximize button.

Declaration
public Color MaximizeButtonHoverBackColor { get; set; }
Property Value
Type
System.Drawing.Color

MaximizeButtonHoverForeColor

Gets or sets the hover fore color for the maximize button.

Declaration
public Color MaximizeButtonHoverForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MaximizeButtonHoverImage

Gets or sets the hover image for the maximize button.

Declaration
public Image MaximizeButtonHoverImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MaximizeButtonImage

Gets or sets the image for the maximize button.

Declaration
public Image MaximizeButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MaximizeButtonPressedBackColor

Gets or sets the pressed background color of the maximize button.

Declaration
public Color MaximizeButtonPressedBackColor { get; set; }
Property Value
Type
System.Drawing.Color

MaximizeButtonPressedForeColor

Gets or sets the pressed fore color of the maximize button.

Declaration
public Color MaximizeButtonPressedForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MaximizeButtonPressedImage

Gets or sets the pressed image for the maximize button.

Declaration
public Image MaximizeButtonPressedImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MaximizeButtonSize

Gets or sets the size of the maximize button.

Declaration
public Size MaximizeButtonSize { get; set; }
Property Value
Type
System.Drawing.Size

MinimizeButtonForeColor

Gets or sets the fore color of the minimize button.

Declaration
public Color MinimizeButtonForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MinimizeButtonHoverBackColor

Gets or sets the hover back color for the minimize button.

Declaration
public Color MinimizeButtonHoverBackColor { get; set; }
Property Value
Type
System.Drawing.Color

MinimizeButtonHoverForeColor

Gets or sets the hover fore color for the minimize button.

Declaration
public Color MinimizeButtonHoverForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MinimizeButtonHoverImage

Gets or sets the hover image for the minimize button.

Declaration
public Image MinimizeButtonHoverImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MinimizeButtonImage

Gets or sets the image for the minimize button.

Declaration
public Image MinimizeButtonImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MinimizeButtonPressedBackColor

Gets or sets the pressed background color of the minimize button.

Declaration
public Color MinimizeButtonPressedBackColor { get; set; }
Property Value
Type
System.Drawing.Color

MinimizeButtonPressedForeColor

Gets or sets the pressed fore color of the minimize button.

Declaration
public Color MinimizeButtonPressedForeColor { get; set; }
Property Value
Type
System.Drawing.Color

MinimizeButtonPressedImage

Gets or sets the pressed image for the minimize button.

Declaration
public Image MinimizeButtonPressedImage { get; set; }
Property Value
Type Description
System.Drawing.Image

The default value is null.

MinimizeButtonSize

Gets or sets the size of the minimize button.

Declaration
public Size MinimizeButtonSize { get; set; }
Property Value
Type
System.Drawing.Size

Padding

Gets or sets the padding for the TitleBarTextControl.

Declaration
public Padding Padding { get; set; }
Property Value
Type
System.Windows.Forms.Padding

TextHorizontalAlignment

Gets or sets the horizontal alignment of the title bar text.

Declaration
public HorizontalAlignment TextHorizontalAlignment { get; set; }
Property Value
Type Description
System.Windows.Forms.HorizontalAlignment

The default value is left.

TextVerticalAlignment

Gets or sets the vertical alignment of the title Bar text.

Declaration
public VerticalAlignment TextVerticalAlignment { get; set; }
Property Value
Type Description
System.Windows.Forms.VisualStyles.VerticalAlignment

The default value is center.

Methods

GetDefaultStyle()

Provide the default style of the TitleBar bar.

Declaration
protected override StyleInfoBase GetDefaultStyle()
Returns
Type Description
StyleInfoBase

Default style object.
Overrides

MakeCopy(StyleInfoBase, StyleInfoProperty)

Makes an exact copy of the current object.

Declaration
public override IStyleInfoSubObject MakeCopy(StyleInfoBase newOwner, StyleInfoProperty sip)
Parameters
Type Name Description
StyleInfoBase newOwner

The new owner style object for the copied object.
StyleInfoProperty sip

The identifier for this object.
Returns
Type Description
IStyleInfoSubObject

A copy of the current object registered with the new owner style object.
Overrides

ShouldSerializeCloseButtonSize()

Determines a value that indicates whether to serialize the CloseButtonSize property or not.

Declaration
public bool ShouldSerializeCloseButtonSize()
Returns
Type Description
System.Boolean

returns true if serialized; Otherwise false

ShouldSerializeFont()

Determines a value that indicates whether to serialize the Font property or not.

Declaration
public bool ShouldSerializeFont()
Returns
Type Description
System.Boolean

returns true if serialized; Otherwise false

ShouldSerializeHelpButtonSize()

Determines a value that indicates whether to serialize the HelpButtonSize property or not.

Declaration
public bool ShouldSerializeHelpButtonSize()
Returns
Type Description
System.Boolean

returns true if serialized; Otherwise false

ShouldSerializeMaximizeButtonSize()

Determines a value that indicates whether to serialize the MaximizeButtonSize property or not.

Declaration
public bool ShouldSerializeMaximizeButtonSize()
Returns
Type Description
System.Boolean

returns true if serialized; Otherwise false

ShouldSerializeMinimizeButtonSize()

Determines a value that indicates whether to serialize the MinimizeButtonSize property or not.

Declaration
public bool ShouldSerializeMinimizeButtonSize()
Returns
Type Description
System.Boolean

returns true if serialized; Otherwise false

Implements

System.ComponentModel.ICustomTypeDescriptor
System.IDisposable
System.ComponentModel.ISupportInitialize
System.IFormattable
System.IConvertible
System.Xml.Serialization.IXmlSerializable