Class PageBorderStyle
Encapsulates the properties of a page border.
Implements
Inherited Members
Namespace: Syncfusion.Windows.Forms.Diagram
Assembly: Syncfusion.Diagram.Base.dll
Syntax
public class PageBorderStyle : PropertyContainer, IServiceReferenceHolder, IServiceReferenceProvider, IPropertyObserver, IPropertyContainer, ICloneable, ISerializable, IDisposable
Remarks
Contains properties needed to create a pen for drawing the border of an page. The CreatePen() method returns a pen to draw the border.
Constructors
PageBorderStyle()
Initializes a new instance of the PageBorderStyle class.
Declaration
public PageBorderStyle()
PageBorderStyle(PageBorderStyle)
Initializes a new instance of the PageBorderStyle class.
Declaration
public PageBorderStyle(PageBorderStyle src)
Parameters
Type | Name | Description |
---|---|---|
PageBorderStyle | src | The page border style. |
PageBorderStyle(SerializationInfo, StreamingContext)
Initializes a new instance of the PageBorderStyle class.
Declaration
protected PageBorderStyle(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Runtime.Serialization.SerializationInfo | info | The info. |
System.Runtime.Serialization.StreamingContext | context | The context. |
Properties
AlphaFactor
Gets or sets Transparency of the border.
Declaration
public int AlphaFactor { get; set; }
Property Value
Type |
---|
System.Int32 |
BorderColor
Gets or sets the color of the pen used for drawing the border.
Declaration
public Color BorderColor { get; set; }
Property Value
Type |
---|
System.Drawing.Color |
BorderCornerRounding
Gets or sets Rounding of the border corners.
Declaration
public BorderStyleCornerRounding BorderCornerRounding { get; set; }
Property Value
Type |
---|
BorderStyleCornerRounding |
BorderDashStyle
Gets or sets the type of line used for drawing the border.
Declaration
public DashStyle BorderDashStyle { get; set; }
Property Value
Type | Description |
---|---|
System.Drawing.Drawing2D.DashStyle | A System.Drawing.Drawing2D.DashStyle value. |
BorderWeight
Gets or sets the thickness of the line used for drawing the border.
Declaration
public BorderWeight BorderWeight { get; set; }
Property Value
Type | Description |
---|---|
BorderWeight | A BorderWeight value. |
BorderWidth
Gets the width in pixels for the border line.
Declaration
public int BorderWidth { get; }
Property Value
Type |
---|
System.Int32 |
ShowBorder
Gets or sets a value indicating whether the border is visible or not.
Declaration
public bool ShowBorder { get; set; }
Property Value
Type |
---|
System.Boolean |
Methods
Clone()
Creates a shallow copy of the PageBorderStyle object.
Declaration
public override object Clone()
Returns
Type | Description |
---|---|
System.Object | A new object that is a copy of this instance. |
Overrides
CreatePen()
Creates a pen to draw the border.
Declaration
public Pen CreatePen()
Returns
Type | Description |
---|---|
System.Drawing.Pen | System.Drawing.Pen object matching the border style. |
GetObjectData(SerializationInfo, StreamingContext)
Gets the object data.
Declaration
protected override void GetObjectData(SerializationInfo info, StreamingContext context)
Parameters
Type | Name | Description |
---|---|---|
System.Runtime.Serialization.SerializationInfo | info | The info. |
System.Runtime.Serialization.StreamingContext | context | The context. |
Overrides
GetPropertyContainerName()
Gets the name of the property container.
Declaration
protected override string GetPropertyContainerName()
Returns
Type | Description |
---|---|
System.String | Property container name. |