Class BannerTextInfo

Describes banner text appearance and behavior.

Inheritance

System.Object

BannerTextInfo

Inherited Members

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

System.Object.GetType()

System.Object.MemberwiseClone()

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

System.Object.ToString()

Namespace: Syncfusion.Windows.Forms

Assembly: Syncfusion.Shared.Base.dll

Syntax

public class BannerTextInfo

Constructors

BannerTextInfo()

Default constructor.

Declaration

public BannerTextInfo()

BannerTextInfo(BannerTextInfo)

Copy constructor.

Declaration

public BannerTextInfo(BannerTextInfo other)

Parameters

Type	Name	Description
BannerTextInfo	other

BannerTextInfo(String, Boolean, Font, Color, BannerTextMode)

Initializes a new instance of the BannerTextInfo class with the specified text, visibility, font, color, and display mode.

Declaration

public BannerTextInfo(string text, bool bVisible, Font font, Color color, BannerTextMode mode)

Parameters

Type	Name	Description
System.String	text	The banner text to display.
System.Boolean	bVisible	A value indicating whether the banner text is visible.
System.Drawing.Font	font	The font used to render the banner text.
System.Drawing.Color	color	The color of the banner text.
BannerTextMode	mode	The display mode for the banner text.

Fields

Empty

Represents an empty or default instance of the BannerTextInfo class. This field can be used to signify the absence of banner text information.

Declaration

public static readonly BannerTextInfo Empty

Field Value

Type
BannerTextInfo

Properties

Color

Specifies banner text color.

Declaration

public Color Color { get; set; }

Property Value

Type
System.Drawing.Color

Font

Specifies font of banner text.

Declaration

public Font Font { get; set; }

Property Value

Type
System.Drawing.Font

Mode

Specifies banner text rendering mode. See BannerTextMode for details.

Declaration

public BannerTextMode Mode { get; set; }

Property Value

Type
BannerTextMode

Text

Specifies banner text.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

TextAlignment

Gets or sets the value to indicate the Text alignment for BannerTextInfo.

Declaration

public StringAlignment TextAlignment { get; set; }

Property Value

Type
System.Drawing.StringAlignment

Visible

Gets or sets a value indicating whether the banner text is visible.

Declaration

public bool Visible { get; set; }

Property Value

Type
System.Boolean

Methods

Equals(Object)

Determines whether the specified object is equal to the current BannerTextInfo instance.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The object to compare with the current instance.

Returns

Type
System.Boolean

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Returns a hash code for this instance.

Declaration

public override int GetHashCode()

Returns

Type
System.Int32

Overrides

System.Object.GetHashCode()

ResetColor()

Resets the Color property to its default value as defined by Empty.

Declaration

protected void ResetColor()

ResetTextAlignment()

Specifies whether to reset TextAlignment property

Declaration

protected void ResetTextAlignment()

ShouldSerializeColor()

Determines whether the Color property should be serialized. This is used by the designer to decide whether the property value differs from its default.

Declaration

protected bool ShouldSerializeColor()

Returns

Type
System.Boolean

ShouldSerializeTextAlignment()

Specifies whether to serialize TextAlignment property

Declaration

protected bool ShouldSerializeTextAlignment()

Returns

Type	Description
System.Boolean	Returns true when the value is not Near.

Operators

Equality(BannerTextInfo, BannerTextInfo)

Determines whether two BannerTextInfo instances are equal.

Declaration

public static bool operator ==(BannerTextInfo lVal, BannerTextInfo rVal)

Parameters

Type	Name	Description
BannerTextInfo	lVal	The first BannerTextInfo instance.
BannerTextInfo	rVal	The second BannerTextInfo instance.

Returns

Type
System.Boolean

Inequality(BannerTextInfo, BannerTextInfo)

Determines whether two BannerTextInfo instances are not equal.

Declaration

public static bool operator !=(BannerTextInfo lVal, BannerTextInfo rVal)

Parameters

Type	Name	Description
BannerTextInfo	lVal	The first BannerTextInfo instance.
BannerTextInfo	rVal	The second BannerTextInfo instance.

Returns

Type
System.Boolean