Loading...
Searching...
No Matches
OFT.Rendering.Tools.RenderPen Class Reference

Defines an object used to draw lines and curves. This class cannot be inherited. More...

Inheritance diagram for OFT.Rendering.Tools.RenderPen:
[legend]
Collaboration diagram for OFT.Rendering.Tools.RenderPen:
[legend]

Public Member Functions

 RenderPen (Color color)
 Initializes a new instance of the T:OFT.Rendering.Pen class with the specified color.
 
 RenderPen (Color color, float width)
 Initializes a new instance of the T:OFT.Rendering.Pen class with the specified T:System.Drawing.Color and P:OFT.Rendering.Pen.Width properties.
 
 RenderPen (Color color, DashStyle dashStyle)
 
 RenderPen (Color color, float width, DashStyle dashStyle)
 
bool Equals (RenderPen? other)
 
override bool Equals (object? obj)
 
override int GetHashCode ()
 

Properties

Color Color [get]
 Gets or sets the color of this T:OFT.Rendering.Pen.
 
RenderAdjustableArrowCap? CustomEndCap [get, set]
 Gets or sets a custom cap to use at the end of lines drawn with this T:OFT.Rendering.RenderPen.
 
RenderAdjustableArrowCap? CustomStartCap [get, set]
 Gets or sets a custom cap to use at the beginning of lines drawn with this T:OFT.Rendering.RenderPen.
 
float?[] DashPattern [get, set]
 Gets or sets an array of custom dashes and spaces.
 
DashStyle DashStyle = DashStyle.Solid [get, set]
 Gets or sets the style used for dashed lines drawn with this T:OFT.Rendering.RenderPen.
 
float Width [get, set]
 Gets or sets the width of this T:OFT.Rendering.Pen, in units of the T:OFT.Rendering.Graphics object used for drawing.
 

Detailed Description

Defines an object used to draw lines and curves. This class cannot be inherited.

<filterpriority>1</filterpriority> <completionlist cref="T:OFT.Rendering.Tools.RenderPens" >

Constructor & Destructor Documentation

◆ RenderPen() [1/4]

OFT.Rendering.Tools.RenderPen.RenderPen ( Color  color)

Initializes a new instance of the T:OFT.Rendering.Pen class with the specified color.

Parameters
colorA T:System.Drawing.Color structure that indicates the color of this T:OFT.Rendering.Pen.

◆ RenderPen() [2/4]

OFT.Rendering.Tools.RenderPen.RenderPen ( Color  color,
float  width 
)

Initializes a new instance of the T:OFT.Rendering.Pen class with the specified T:System.Drawing.Color and P:OFT.Rendering.Pen.Width properties.

Parameters
colorA T:System.Drawing.Color structure that indicates the color of this T:OFT.Rendering.Pen.
widthA value indicating the width of this T:OFT.Rendering.Pen.

◆ RenderPen() [3/4]

OFT.Rendering.Tools.RenderPen.RenderPen ( Color  color,
DashStyle  dashStyle 
)

◆ RenderPen() [4/4]

OFT.Rendering.Tools.RenderPen.RenderPen ( Color  color,
float  width,
DashStyle  dashStyle 
)

Member Function Documentation

◆ Equals() [1/2]

override bool OFT.Rendering.Tools.RenderPen.Equals ( object?  obj)

◆ Equals() [2/2]

bool OFT.Rendering.Tools.RenderPen.Equals ( RenderPen?  other)

◆ GetHashCode()

override int OFT.Rendering.Tools.RenderPen.GetHashCode ( )

Property Documentation

◆ Color

Color OFT.Rendering.Tools.RenderPen.Color
get

Gets or sets the color of this T:OFT.Rendering.Pen.

Returns
A T:System.Drawing.Color structure that represents the color of this T:OFT.Rendering.Pen.

<filterpriority>1</filterpriority>

◆ CustomEndCap

RenderAdjustableArrowCap? OFT.Rendering.Tools.RenderPen.CustomEndCap
getset

Gets or sets a custom cap to use at the end of lines drawn with this T:OFT.Rendering.RenderPen.

Returns
A T:OFT.Rendering.RenderCustomLineCap that represents the cap used at the end of lines drawn with this T:OFT.Rendering.RenderPen.

<filterpriority>1</filterpriority>

◆ CustomStartCap

RenderAdjustableArrowCap? OFT.Rendering.Tools.RenderPen.CustomStartCap
getset

Gets or sets a custom cap to use at the beginning of lines drawn with this T:OFT.Rendering.RenderPen.

Returns
A T:OFT.Rendering.RenderCustomLineCap that represents the cap used at the beginning of lines drawn with this T:OFT.Rendering.RenderPen.

<filterpriority>1</filterpriority>

◆ DashPattern

float? [] OFT.Rendering.Tools.RenderPen.DashPattern
getset

Gets or sets an array of custom dashes and spaces.

Returns
An array of real numbers that specifies the lengths of alternating dashes and spaces in dashed lines.

<filterpriority>1</filterpriority>

◆ DashStyle

DashStyle OFT.Rendering.Tools.RenderPen.DashStyle = DashStyle.Solid
getset

Gets or sets the style used for dashed lines drawn with this T:OFT.Rendering.RenderPen.

Returns
A T:OFT.Rendering.DashStyle that represents the style used for dashed lines drawn with this T:OFT.Rendering.RenderPen.

<filterpriority>1</filterpriority>

◆ Width

float OFT.Rendering.Tools.RenderPen.Width
getset

Gets or sets the width of this T:OFT.Rendering.Pen, in units of the T:OFT.Rendering.Graphics object used for drawing.

Returns
The width of this T:OFT.Rendering.Pen.

<filterpriority>1</filterpriority>


The documentation for this class was generated from the following file: