VectSharp 2.6.1
A light library for C# vector graphics
Loading...
Searching...
No Matches
VectSharp.Markdown.UnderlineFragment Class Reference

Represents a text underline. More...

Inheritance diagram for VectSharp.Markdown.UnderlineFragment:

Public Member Functions

 UnderlineFragment (Point start, Point end, Colour colour, double thickness, string tag)
 Create a new UnderlineFragment. More...
 
override void Translate (double deltaX, double deltaY)
 Applies the specified translation to the line fragment.
Parameters
deltaXThe translation in the horizontal direction.
deltaYThe translation in the vertical direction.
More...
 
override double GetAscent (double lineAscent)
 Get the ascent of the LineFragment.
Parameters
lineAscentThe ascent of the Line on which the fragment should be drawn.
Returns
The ascent of the LineFragment.
More...
 
override double GetMaxY ()
 Get the vertical coordinate of the bottom of the LineFragment.
Returns
The vertical coordinates of the bottom of the LineFragment.
More...
 
override double GetMaxX ()
 Get the horizontal coordinate of the right side of the LineFragment.
Returns
The horizontal coordinate of the right side of the LineFragment.
More...
 
override? Point Render (Graphics graphics, double deltaY)
 Render the LineFragment on the specified graphics surface.
Parameters
graphicsThe Graphics surface on which the LineFragment will be drawn.
deltaYAdditional translation on the vertical axis.
Returns
If a text element has been drawn, this method should return the bottom-right corner of the drawn text element, otherwise null. This is used to update the MarkdownContext.BottomRight property.
More...
 
abstract void Translate (double deltaX, double deltaY)
 Applies the specified translation to the line fragment. More...
 
abstract double GetAscent (double lineAscent)
 Get the ascent of the LineFragment. More...
 
abstract double GetMaxY ()
 Get the vertical coordinate of the bottom of the LineFragment. More...
 
abstract double GetMaxX ()
 Get the horizontal coordinate of the right side of the LineFragment. More...
 
abstract ? Point Render (Graphics graphics, double deltaY)
 Render the LineFragment on the specified graphics surface. More...
 

Properties

Point Start [get]
 The start position of the underline, relative to the cursor at the start of the line. More...
 
Point End [get]
 The end position of the underline, relative to the cursor at the start of the line. More...
 
Colour Colour [get]
 The colour of the underline. More...
 
double Thickness [get]
 The thickness of the underline. More...
 
- Properties inherited from VectSharp.Markdown.LineFragment
string Tag [get]
 Graphics action tag for the fragment. More...
 

Detailed Description

Represents a text underline.

Definition at line 147 of file Line.cs.

Constructor & Destructor Documentation

◆ UnderlineFragment()

VectSharp.Markdown.UnderlineFragment.UnderlineFragment ( Point  start,
Point  end,
Colour  colour,
double  thickness,
string  tag 
)

Create a new UnderlineFragment.

Parameters
startThe start position of the underline.
endThe end position of the underline.
colourThe colour of the underline.
thicknessThe thickness of the underline.
tagGraphics action tag for the underline.

Definition at line 177 of file Line.cs.

Member Function Documentation

◆ GetAscent()

override double VectSharp.Markdown.UnderlineFragment.GetAscent ( double  lineAscent)
virtual

Get the ascent of the LineFragment.

Parameters
lineAscentThe ascent of the Line on which the fragment should be drawn.
Returns
The ascent of the LineFragment.

Implements VectSharp.Markdown.LineFragment.

Definition at line 194 of file Line.cs.

◆ GetMaxX()

override double VectSharp.Markdown.UnderlineFragment.GetMaxX ( )
virtual

Get the horizontal coordinate of the right side of the LineFragment.

Returns
The horizontal coordinate of the right side of the LineFragment.

Implements VectSharp.Markdown.LineFragment.

Definition at line 206 of file Line.cs.

◆ GetMaxY()

override double VectSharp.Markdown.UnderlineFragment.GetMaxY ( )
virtual

Get the vertical coordinate of the bottom of the LineFragment.

Returns
The vertical coordinates of the bottom of the LineFragment.

Implements VectSharp.Markdown.LineFragment.

Definition at line 200 of file Line.cs.

◆ Render()

override? Point VectSharp.Markdown.UnderlineFragment.Render ( Graphics  graphics,
double  deltaY 
)
virtual

Render the LineFragment on the specified graphics surface.

Parameters
graphicsThe Graphics surface on which the LineFragment will be drawn.
deltaYAdditional translation on the vertical axis.
Returns
If a text element has been drawn, this method should return the bottom-right corner of the drawn text element, otherwise null. This is used to update the MarkdownContext.BottomRight property.

Implements VectSharp.Markdown.LineFragment.

Definition at line 212 of file Line.cs.

◆ Translate()

override void VectSharp.Markdown.UnderlineFragment.Translate ( double  deltaX,
double  deltaY 
)
virtual

Applies the specified translation to the line fragment.

Parameters
deltaXThe translation in the horizontal direction.
deltaYThe translation in the vertical direction.

Implements VectSharp.Markdown.LineFragment.

Definition at line 187 of file Line.cs.

Property Documentation

◆ Colour

Colour VectSharp.Markdown.UnderlineFragment.Colour
get

The colour of the underline.

Definition at line 162 of file Line.cs.

◆ End

Point VectSharp.Markdown.UnderlineFragment.End
get

The end position of the underline, relative to the cursor at the start of the line.

Definition at line 157 of file Line.cs.

◆ Start

Point VectSharp.Markdown.UnderlineFragment.Start
get

The start position of the underline, relative to the cursor at the start of the line.

Definition at line 152 of file Line.cs.

◆ Thickness

double VectSharp.Markdown.UnderlineFragment.Thickness
get

The thickness of the underline.

Definition at line 167 of file Line.cs.


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