AnnotationPen Class

This class represents a pen object used for drawing lines of annotations.

Inheritance Hierarchy

System.Object
Atalasoft.Annotate.AnnotationPen

Namespace: Atalasoft.Annotate
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)

Syntax

Copy

[SerializableAttribute]
[TypeConverterAttribute(typeof(AnnotationPenConverter))]
public class AnnotationPen : ISerializable

<SerializableAttribute>
<TypeConverterAttribute(GetType(AnnotationPenConverter))>
Public Class AnnotationPen
	Implements ISerializable

The AnnotationPen type exposes the following members.

Constructors

	Name	Description
	AnnotationPen(Color)	Creates a new instance of AnnotationPen specifying the color of the pen.
	AnnotationPen(AnnotationBrush)	Creates a new instance of AnnotationPen from an AnnotationBrush object.
	AnnotationPen(Color, Single)	Creates a new instance of AnnotationPen specifying the color and width of the pen.
	AnnotationPen(SerializationInfo, StreamingContext)	Creates a new instance of AnnotationPen from serialized data.
	AnnotationPen(AnnotationBrush, Single)	Creates a new instance of AnnotationPen specifying the AnnotationBrush and pen width.

Top

Properties

	Name	Description
	Alignment	Gets or sets the AnnotationPenAlignment for the pen.
	Brush	Gets or sets the AnnotationBrush used to describe this pen.
	Color	Gets or sets the color for the pen.
	DashCap	Gets or sets the DashCap used at the end of the dashes that make up dashed lines drawn with this pen.
	DashOffset	Gets or sets the distance from the start of a line to the beginning of a dash pattern.
	DashPattern	Gets or sets the dash pattern used
	DashStyle	Gets or sets the style used for dashed lines drawn with this pen.
	EndCap	Gets or sets the AnnotationLineCap used at the end of lines drawn with this pen.
	LineJoin	Gets or sets the join style for the ends of two consecutive lines drawn with this pen.
	MiterLimit	Gets or sets the limit of the thickness of the join on a mitered corner.
	StartCap	Gets or sets the AnnotationLineCap used at the beginning of lines drawn with this pen.
	Width	Gets or sets the width of the pen.

Top

Methods

	Name	Description
	Clone	Creates a copy of this AnnotationPen.
	Equals	Compares this AnnotationPen with another to test if they are equal. (Overrides Object.Equals(Object).)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Returns an identifier for this object. (Overrides Object.GetHashCode().)
	GetObjectData	Fills a SerializationInfo object with information about this AnnotationPen.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnAnnotationControllerNotification	Called to notify the AnnotationController after a property has been changed.
	OnPropertyChanged	Called when a property value has changed and raises the PropertyChanged event.
	OnPropertyChanging	Called before a property is changed.
	RemoveLineCapEvents	This is a helper method used to remove event handler for an AnnotationLineCap object.
	SetLineCapEvents	This is a helper method used to add event handling to an AnnotationLineCap.
	ToString	Returns a string representation of this object. (Overrides Object.ToString().)

Top

Events

	Name	Description
	AnnotationControllerNotification	Raised after a property of the AnnotationBrush if modified.
	PropertyChanged	Raised when a property value has changed.
	PropertyChanging	Raised just before a property is about to be modified.

Top

Remarks

The IAnnotationRenderer for each annotation will use this information to construct a pen or equivalent for the drawing environment of its choice.

Examples

The code below creates a RectangleAnnotation with a black 1 pixel border.

CreateRectAnn

Copy

RectangleAnnotation rect = new RectangleAnnotation(RectangleF.Empty, new AnnotationBrush(Color.Red), new AnnotationPen(Color.Black, 1));
((RectangleGrips)rect.Grips).GripsToDisplay = RectangleGripDisplay.Both;
this.annotateViewer1.Annotations.CreateAnnotation(rect);

CreateRectAnn

Copy

Dim rect As RectangleAnnotation =  New RectangleAnnotation(RectangleF.Empty,New AnnotationBrush(Color.Red),New AnnotationPen(Color.Black,1)) 
((RectangleGrips)rect.Grips).GripsToDisplay = RectangleGripDisplay.Both
Me.annotateViewer1.Annotations.CreateAnnotation(rect)

Reference

Atalasoft.Annotate Namespace