Class BoxObj

A class that represents a bordered and/or filled box (rectangle) object on the graph. A list of BoxObj objects is maintained by the GraphObjList collection class.

Inheritance
Object
GraphObj
BoxObj
EllipseObj
PolyObj
Inherited Members
Namespace: ZedGraph
Assembly: ZedGraph.dll
Syntax
[Serializable]
public class BoxObj : GraphObj, ICloneable, ISerializable

Constructors

| Improve this Doc View Source

BoxObj()

A default constructor that creates a BoxObj using a location of (0,0), and a width,height of (1,1). Other properties are defaulted.

Declaration
public BoxObj()
| Improve this Doc View Source

BoxObj(Double, Double, Double, Double)

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

Declaration
public BoxObj(double x, double y, double width, double height)
Parameters
Type Name Description
Double x

The x location for this BoxObj. This will be in units determined by CoordinateFrame.
Double y

The y location for this BoxObj. This will be in units determined by CoordinateFrame.
Double width

The width of this BoxObj. This will be in units determined by CoordinateFrame.
Double height

The height of this BoxObj. This will be in units determined by CoordinateFrame.
| Improve this Doc View Source

BoxObj(Double, Double, Double, Double, Color, Color)

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

Declaration
public BoxObj(double x, double y, double width, double height, Color borderColor, Color fillColor)
Parameters
Type Name Description
Double x

The x location for this BoxObj. This will be in units determined by CoordinateFrame.
Double y

The y location for this BoxObj. This will be in units determined by CoordinateFrame.
Double width

The width of this BoxObj. This will be in units determined by CoordinateFrame.
Double height

The height of this BoxObj. 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)
| Improve this Doc View Source

BoxObj(Double, Double, Double, Double, Color, Color, Color)

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

Declaration
public BoxObj(double x, double y, double width, double height, Color borderColor, Color fillColor1, Color fillColor2)
Parameters
Type Name Description
Double x

The x location for this BoxObj. This will be in units determined by CoordinateFrame.
Double y

The y location for this BoxObj. This will be in units determined by CoordinateFrame.
Double width

The width of this BoxObj. This will be in units determined by CoordinateFrame.
Double height

The height of this BoxObj. 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
| Improve this Doc View Source

BoxObj(SerializationInfo, StreamingContext)

Constructor for deserializing objects

Declaration
protected BoxObj(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
| Improve this Doc View Source

BoxObj(BoxObj)

The Copy Constructor

Declaration
public BoxObj(BoxObj rhs)
Parameters
Type Name Description
BoxObj rhs

The BoxObj object from which to copy

Fields

| Improve this Doc View Source

_border

Private field that determines the properties of the border around this BoxObj Use the public property Border to access this value.

Declaration
[CLSCompliant(false)]
protected Border _border
Field Value
Type Description
Border
| Improve this Doc View Source

_fill

Private field that stores the Fill data for this BoxObj. Use the public property Fill to access this value.

Declaration
[CLSCompliant(false)]
protected Fill _fill
Field Value
Type Description
Fill
| Improve this Doc View Source

schema2

Current schema value that defines the version of the serialized file

Declaration
public const int schema2 = 10
Field Value
Type Description
Int32

Properties

| Improve this Doc View Source

Border

Gets or sets the Border object, which determines the properties of the border around this BoxObj

Declaration
public Border Border { get; set; }
Property Value
Type Description
Border
| Improve this Doc View Source

Fill

Gets or sets the Fill data for this BoxObj.

Declaration
public Fill Fill { get; set; }
Property Value
Type Description
Fill

Methods

| Improve this Doc View Source

Clone()

Typesafe, deep-copy clone method.

Declaration
public BoxObj Clone()
Returns
Type Description
BoxObj

A new, independent copy of this class
| Improve this Doc View Source

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
Remarks

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

| Improve this Doc View Source

GetCoords(PaneBase, Graphics, Single, out String, out String)

Determines the shape type and Coords values for this GraphObj

Declaration
public override void GetCoords(PaneBase pane, Graphics g, float scaleFactor, out string shape, out string coords)
Parameters
Type Name Description
PaneBase pane
Graphics g
Single scaleFactor
String shape
String coords
Overrides
| Improve this Doc View Source

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
| Improve this Doc View Source

PointInBox(PointF, PaneBase, Graphics, Single)

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

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

Explicit Interface Implementations

| Improve this Doc View Source

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