TRSGPPen Class

TPersistent
RSGdiPlusGraphics.TRSGPGraphicsObject
RSGdiPlusGraphics.TRSGPPen

Delphi

type
TRSGPPen = class(TRSGPGraphicsObject)
end;

	Name	Description
	Create(TRSGPCanvas)	Overloaded. Constructs the graphics object. Specify the canvas that owns the graphics object. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Create(TRSGPCanvas).)
	Create(TRSGPCanvas,TRSGPBrushKind,TRSGPColor)	Overloaded. Create the pen with the specified default Kind and Color .
	Destroy	Represents the destructor of the TRSGPPen class. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Destroy.)

Top

Name

Description

Alignment

Specifies the alignment setting of the pen relative to the line that is drawn.

Brush

Specifies the Brush object that a pen uses to fill a line.

Note
Unlike the FMX TStrokeBrush, the TRSGPPen uses a brush to control how the pen line is filled.

Color

Specifies the color of the pen when the pen kind is bkSolid or foreground color when pen kind is bkHatchFill

Note
To properly use the Color property, you must set the Kind property to bkSolid or bkHatchFill.

CompoundArray

Specifies the compound array for this Pen object, which specifies the parallel lines for pen with values between 0 and 1. The CompoundArray property must be monotonically increasing (between 0 and 1) with an even number of elements in the array.

Suppose a compound array contains the values 0.0, 0.2, 0.7, and 1.0 and that the pen has a width of 100. When you use the pen to draw, you get two parallel lines. The first line has a width of 20, the space between the two lines has a width of 50, and the second line has a width of 30.

CustomEndCap

Specifies the custom end cap for this Pen object.

A line cap defines the style of graphic used to draw the ends of a line. It can be various shapes, such as a square, circle, or diamond. A custom line cap is defined by the path that draws it. The path is drawn by using a Pen object to draw the outline of a shape or by using a Brush object to fill the interior.

CustomStartCap

Specifies the custom start cap for this Pen object.

A line cap defines the style of graphic used to draw the ends of a line. It can be various shapes, such as a square, circle, or diamond. A custom line cap is defined by the path that draws it. The path is drawn by using a Pen object to draw the outline of a shape or by using a Brush object to fill the interior.

Dash

Specifies the dash style for this Pen object.

Note
The length of the dashes in a dashed line is dependent on the dash style and the width of the Pen object. The length of the space that separates two dashes in a dashed line is equal to the width of the Pen object.

DashArray

Specifies an array of real numbers that specifies the length of the custom dashes and spaces. All elements in the array must be positive real numbers.

The elements in the dash array set the length of each dash and space in the dash pattern. The first element sets the length of a dash, the second element sets the length of a space, the third element sets the length of a dash, and so forth.

The length of each dash and space in the dash pattern is the product of the element value in the array and the width of the Pen object.

DashCap

Specifies the start and end caps of the dashes in a dashed line.

DashOffset

Specifies the distance from the start of the line to the start of the first dash in a dashed line.

DefaultColor

Defines the default color of the pen. The pen object uses the DefaultColor property to determine whether the color of the pen is stored when streaming.

DefaultKind

Defines the default kind of the pen. The pen object uses the DefaultKind property to determine whether the kind of the pen is stored when streaming.

EndCap

Specifies the end cap for this Pen object.

Handle

Handle of the graphics object, used by the MS GDI+ flat API routines (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Join

Specifies the join style used at the end of a line segment that meets another line segment.

Kind

Determines the pattern for the pen.

Use Kind to specify the pattern painted by the pen. Kind can have one of the following values:

bkBitmap

The pen's pattern is defined by an external bitmap image.

bkGradient

The pen's pattern is a gradient and you can set the gradient type and colors.

bkNone

The pen has no pattern. The fill of the object is transparent and the Color property has no effect.

bkSolid

The pen's pattern is a solid color, which you can set by using the Color property.

bkHatchFill

The pen's pattern is a hatch fill. The pen defines a rectangular brush with a hatch style, a foreground color, and a background color. There are six hatch styles. The foreground color defines the color of the hatch lines; the background color defines the color over which the hatch lines are drawn.

Note
Unlike with FMX where you change gradient, bitmap, etc directly, with GDI+ the pen is configured by changing the properties of the Brush property.

Matrix

Specifies the world transformation of this Pen object.

MiterLimit

Specifies the miter limit of this Pen object. A real number value that is less than 1.0f will be replaced with 1.0f.

The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls outside of the join. The miter length can be large when the angle between two lines is small. The miter limit is the maximum allowed ratio of miter length to stroke width. The default value is 10.0f.

If the miter length of the join of the intersection exceeds the limit of the join, then the join will be beveled to keep it within the limit of the join of the intersection.

OnChange

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

OnChanged

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

Owner

Canvas that owns the object. The Canvas will free this graphics object if it is destroyed. However, to keep memory use under control, it is recommended that you free graphics objects when you are finished with them. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

StartCap

Specifies the start cap for this Pen object.

Thickness

Specifies the width, in pixels, of the stroke outline to draw a line or a contour.

	Name	Description
	Assign(TPersistent)	Overloaded. Represents method Assign(TPersistent).
	Changed	Call this method when the graphics object changes. It triggers an OnChange event. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	Clone	Creates a copy of the graphics object (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	GetHandle	Call this method to acquire a handle from the GDI+ flat API library (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.GetHandle.)
	Notification(TRSGPCanvas)	Called when the Canvas is releasing control of the graphics object. The canvas will no longer be responsible for freeing the graphics object. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Prepare(TRectF,Single)	Prepare the graphics object for drawing. Graphics objects respond in this method to upcoming calls. For example, gradient brushes can make sure the gradient will cover the entire rectangle. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Prepare(TRectF,Single).)
	QueryInterface(TGUID,Void)	Represents method QueryInterface(TGUID,Void). (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	ReleaseHandle	Releases the underlying GDI+ object back to the GDI+ library. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.ReleaseHandle.)
	SetCustomDash(Single[],Single)	Specifies an array of custom dashes and spaces for this Pen object. The SetCustomDash method allows you to set the DashArray and DashOffset properties at the same time. The Dash parameter is an array of real numbers that specifies the length of the custom dashes and spaces. All elements in the array must be positive real numbers. The offset parameter specifies the distance from the start of the line to the start of the first dash in a dashed line. The elements in the dash array set the length of each dash and space in the dash pattern. The first element sets the length of a dash, the second element sets the length of a space, the third element sets the length of a dash, and so forth. The length of each dash and space in the dash pattern is the product of the element value in the array and the width of the Pen object.
	Update	Update native graphics object (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Update.)
	_AddRef	Represents method _AddRef. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	_Release	Represents method _Release. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Top

	Name	Description
	FBrush	Represents field FBrush.
	FCustomEndCap	Represents field FCustomEndCap.
	FCustomStartCap	Represents field FCustomStartCap.
	FHandle	Represents field FHandle. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Top

The TRSGPPen attempts to mimic the FMX TStrokeBrush as closely as possible. However, it has much more capabilities than the TStrokeBrush.

Reference

•RSGdiPlusGraphics.TRSGPBrush

•RSGdiPlusGraphics.TRSGPCanvas.Pen

•RSGdiPlusGraphics.TRSGPCanvas.Stroke

•RSGdiPlusGraphics