Class HeaderFooterBorder

Encapsulates the header/footer border properties.

Inheritance

System.Object

HeaderFooterBorder

Implements

System.Runtime.Serialization.ISerializable

System.ICloneable

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.Diagram

Assembly: Syncfusion.Diagram.Base.dll

Syntax

public sealed class HeaderFooterBorder : ISerializable, ICloneable

Remarks

Contains properties needed to specify the border drawing for the diagram headers and footers.

Constructors

HeaderFooterBorder()

Initializes a new instance of the HeaderFooterBorder class.

Declaration

public HeaderFooterBorder()

HeaderFooterBorder(DashStyle)

Initializes a new instance of the HeaderFooterBorder class.

Declaration

public HeaderFooterBorder(DashStyle style)

Parameters

Type	Name	Description
System.Drawing.Drawing2D.DashStyle	style	The line style to be be applied to the border.

HeaderFooterBorder(DashStyle, Color)

Initializes a new instance of the HeaderFooterBorder class.

Declaration

public HeaderFooterBorder(DashStyle style, Color color)

Parameters

Type	Name	Description
System.Drawing.Drawing2D.DashStyle	style	A System.Drawing.Drawing2D.DashStyle to be be applied to the specific border.
System.Drawing.Color	color	A System.Drawing.Color specifying the color of the border.

HeaderFooterBorder(DashStyle, Color, BorderWeight)

Initializes a new instance of the HeaderFooterBorder class.

Declaration

public HeaderFooterBorder(DashStyle style, Color color, BorderWeight weight)

Parameters

Type	Name	Description
System.Drawing.Drawing2D.DashStyle	style	A System.Drawing.Drawing2D.DashStyle to be be applied to the specific border.
System.Drawing.Color	color	A System.Drawing.Color specifying the color of the border.
BorderWeight	weight	A BorderWeight specifying the thickness of the border.

Fields

Empty

An empty HeaderFooterBorder object.

Declaration

public static readonly HeaderFooterBorder Empty

Field Value

Type
HeaderFooterBorder

Properties

Color

Gets or sets the color of the line used for drawing the border.

Declaration

public Color Color { get; set; }

Property Value

Type	Description
System.Drawing.Color	A System.Drawing.Color value.

ShowBorder

Gets or sets a value indicating whether the border will be displayed.

Declaration

public bool ShowBorder { get; set; }

Property Value

Type
System.Boolean

Style

Gets or sets the type of line used for drawing the border.

Declaration

public DashStyle Style { get; set; }

Property Value

Type	Description
System.Drawing.Drawing2D.DashStyle	A System.Drawing.Drawing2D.DashStyle value.

Weight

Gets or sets the thickness of the line used for drawing the border.

Declaration

public BorderWeight Weight { get; set; }

Property Value

Type	Description
BorderWeight	A BorderWeight value.

Width

Gets the width in pixels for the border line.

Declaration

public int Width { get; }

Property Value

Type
System.Int32

Methods

Clone()

Creates a shallow copy of the HeeaderFooterBorder object.

Declaration

public object Clone()

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

Compare(HeaderFooterBorder, HeaderFooterBorder)

Compares the specified two instance HeaderFooter borders.

Declaration

public static bool Compare(HeaderFooterBorder lhs, HeaderFooterBorder rhs)

Parameters

Type	Name	Description
HeaderFooterBorder	lhs	The first header.
HeaderFooterBorder	rhs	The second header.

Returns

Type	Description
System.Boolean	true, if equal.

CreatePen()

Creates the pen used for drawing the border.

Declaration

public Pen CreatePen()

Returns

Type	Description
System.Drawing.Pen	System.Drawing.Pen object matching the border style.

Equals(Object)

Equals the specified object.

Declaration

public override bool Equals(object o)

Parameters

Type	Name	Description
System.Object	o	The object.

Returns

Type	Description
System.Boolean	true, if equal.

Overrides

System.Object.Equals(System.Object)

GetHashCode()

Serves as a hash function for a particular type.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current System.Object.

Overrides

System.Object.GetHashCode()

MakeBlackAndWhite()

Returns a copy of this border object replacing the color with System.Drawing.Color.Black.

Declaration

public HeaderFooterBorder MakeBlackAndWhite()

Returns

Type	Description
HeaderFooterBorder	A HeaderFooterBorder with black color.

Operators

Equality(HeaderFooterBorder, HeaderFooterBorder)

Implements the operator ==.

Declaration

public static bool operator ==(HeaderFooterBorder lhs, HeaderFooterBorder rhs)

Parameters

Type	Name	Description
HeaderFooterBorder	lhs	The first header.
HeaderFooterBorder	rhs	The second header.

Returns

Type	Description
System.Boolean	The result of the operator.

Inequality(HeaderFooterBorder, HeaderFooterBorder)

Implements the operator !=.

Declaration

public static bool operator !=(HeaderFooterBorder lhs, HeaderFooterBorder rhs)

Parameters

Type	Name	Description
HeaderFooterBorder	lhs	The first header.
HeaderFooterBorder	rhs	The right header.

Returns

Type	Description
System.Boolean	The result of the operator.

Explicit Interface Implementations

ISerializable.GetObjectData(SerializationInfo, StreamingContext)

Implements the ISerializable interface and returns the data needed to serialize the HeaderFooterBorder.

Declaration

void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
System.Runtime.Serialization.SerializationInfo	info	A SerializationInfo object containing the information required to serialize the object.
System.Runtime.Serialization.StreamingContext	context	A StreamingContext object containing the source and destination of the serialized stream.

Implements

System.Runtime.Serialization.ISerializable

System.ICloneable