Class PolyObj

A class that represents a bordered and/or filled polygon object on the graph. A list of PolyObj objects is maintained by the GraphObjList collection class.

Inheritance

Object

GraphObj

BoxObj

PolyObj

Implements

ICloneable

ISerializable

Inherited Members

BoxObj._fill

BoxObj._border

BoxObj.Fill

BoxObj.Border

BoxObj.schema2

BoxObj.GetCoords(PaneBase, Graphics, Single, String, String)

GraphObj._location

GraphObj._isVisible

GraphObj._isClippedToChartRect

GraphObj.Tag

GraphObj.Location

GraphObj.ZOrder

GraphObj.IsVisible

GraphObj.IsClippedToChartRect

GraphObj.Link

GraphObj.IsInFrontOfData

GraphObj.schema

Object.Equals(Object)

Object.Equals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Object.ToString()

Namespace: ZedGraph

Assembly: ZedGraph.dll

Syntax

[Serializable]
public class PolyObj : BoxObj, ICloneable, ISerializable

Constructors

PolyObj()

A default constructor that creates a PolyObj from an empty PointD array. Other properties are defaulted.

Declaration

public PolyObj()

PolyObj(SerializationInfo, StreamingContext)

Constructor for deserializing objects

Declaration

protected PolyObj(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	A SerializationInfo instance that defines the serialized data
StreamingContext	context	A StreamingContext instance that contains the serialized data

PolyObj(PointD[])

A constructor that allows the position of the PolyObj to be pre-specified. Other properties are defaulted.

Declaration

public PolyObj(PointD[] points)

Parameters

Type	Name	Description
PointD[]	points	The PointD array that defines the polygon. This will be in units determined by CoordinateFrame.

PolyObj(PointD[], Color, Color)

A constructor that allows the position, border color, and solid fill color of the PolyObj to be pre-specified.

Declaration

public PolyObj(PointD[] points, Color borderColor, Color fillColor)

Parameters

Type	Name	Description
PointD[]	points	The PointD array that defines the polygon. This will be in units determined by CoordinateFrame.
Color	borderColor	An arbitrary Color specification for the box border
Color	fillColor	An arbitrary Color specification for the box fill (will be a solid color fill)

PolyObj(PointD[], Color, Color, Color)

A constructor that allows the position, border color, and two-color gradient fill colors of the PolyObj to be pre-specified.

Declaration

public PolyObj(PointD[] points, Color borderColor, Color fillColor1, Color fillColor2)

Parameters

Type	Name	Description
PointD[]	points	The PointD array that defines the polygon. This will be in units determined by CoordinateFrame.
Color	borderColor	An arbitrary Color specification for the box border
Color	fillColor1	An arbitrary Color specification for the start of the box gradient fill
Color	fillColor2	An arbitrary Color specification for the end of the box gradient fill

PolyObj(PolyObj)

The Copy Constructor

Declaration

public PolyObj(PolyObj rhs)

Parameters

Type	Name	Description
PolyObj	rhs	The PolyObj object from which to copy

Fields

schema3

Current schema value that defines the version of the serialized file

Declaration

public const int schema3 = 11

Field Value

Type	Description
Int32

Properties

IsClosedFigure

Gets or sets a value that determines if the polygon will be automatically closed. true to close the figure, false to leave it "open."

Declaration

public bool IsClosedFigure { get; set; }

Property Value

Type	Description
Boolean

Remarks

This boolean determines whether or not the CloseFigure() method will be called to fully close the path of the polygon. This value defaults to true, and for any closed figure it should fine. If you want to draw a line that does not close into a shape, then you should set this value to false. For a figure that is naturally closed (e.g., the first point of the polygon is the same as the last point), leaving this value set to false may result in minor pixel artifacts due to rounding.

Points

Gets or sets the PointD array that defines the polygon. This will be in units determined by CoordinateFrame.

Declaration

public PointD[] Points { get; set; }

Property Value

Type	Description
PointD[]

Methods

Clone()

Typesafe, deep-copy clone method.

Declaration

public PolyObj Clone()

Returns

Type	Description
PolyObj	A new, independent copy of this class

Draw(Graphics, PaneBase, Single)

Render this object to the specified Graphics device.

Declaration

public override void Draw(Graphics g, PaneBase pane, float scaleFactor)

Parameters

Type	Name	Description
Graphics	g	A graphic device object to be drawn into. This is normally e.Graphics from the PaintEventArgs argument to the Paint() method.
PaneBase	pane	A reference to the PaneBase object that is the parent or owner of this object.
Single	scaleFactor	The scaling factor to be used for rendering objects. This is calculated and passed down by the parent GraphPane object using the CalcScaleFactor() method, and is used to proportionally adjust font sizes, etc. according to the actual size of the graph.

Overrides

BoxObj.Draw(Graphics, PaneBase, Single)

Remarks

This method is normally only called by the Draw method of the parent GraphObjList collection object.

GetObjectData(SerializationInfo, StreamingContext)

Populates a SerializationInfo instance with the data needed to serialize the target object

Declaration

[SecurityPermission(SecurityAction.Demand, SerializationFormatter = true)]
public override void GetObjectData(SerializationInfo info, StreamingContext context)

Parameters

Type	Name	Description
SerializationInfo	info	A SerializationInfo instance that defines the serialized data
StreamingContext	context	A StreamingContext instance that contains the serialized data

Overrides

BoxObj.GetObjectData(SerializationInfo, StreamingContext)

PointInBox(PointF, PaneBase, Graphics, Single)

Determine if the specified screen point lies inside the bounding box of this PolyObj.

Declaration

public override bool PointInBox(PointF pt, PaneBase pane, Graphics g, float scaleFactor)

Parameters

Type	Name	Description
PointF	pt	The screen point, in pixels
PaneBase	pane	A reference to the PaneBase object that is the parent or owner of this object.
Graphics	g	A graphic device object to be drawn into. This is normally e.Graphics from the PaintEventArgs argument to the Paint() method.
Single	scaleFactor	The scaling factor to be used for rendering objects. This is calculated and passed down by the parent GraphPane object using the CalcScaleFactor() method, and is used to proportionally adjust font sizes, etc. according to the actual size of the graph.

Returns

Type	Description
Boolean	true if the point lies in the bounding box, false otherwise

Overrides

BoxObj.PointInBox(PointF, PaneBase, Graphics, Single)

Explicit Interface Implementations

ICloneable.Clone()

Implement the ICloneable interface in a typesafe manner by just calling the typed version of Clone()

Declaration

object ICloneable.Clone()

Returns

Type	Description
Object	A deep copy of this object

Implements

System.ICloneable

System.Runtime.Serialization.ISerializable