AnnotationBrush Class

This class describes a brush object used for drawing annotations.

Inheritance Hierarchy

SystemObject
Atalasoft.AnnotateAnnotationBrush

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(AnnotationBrushConverter))]
public class AnnotationBrush : ISerializable

<SerializableAttribute>
<TypeConverterAttribute(GetType(AnnotationBrushConverter))>
Public Class AnnotationBrush
	Implements ISerializable

The AnnotationBrush type exposes the following members.

Constructors

	Name	Description
	AnnotationBrush(Color)	Creates a solid brush with the specified color.
	AnnotationBrush(AnnotationImage)	Creates a texture brush using the specified image.
	AnnotationBrush(HatchStyle, Color)	Creates a hatch brush with the specified hatch style and forecolor.
	AnnotationBrush(SerializationInfo, StreamingContext)	Creates a brush from serialized information.
	AnnotationBrush(AnnotationImage, WrapMode)	Creates a new texture brush with the specified image and wrap mode.
	AnnotationBrush(AnnotationImage, Rectangle)	Creates a texture brush using the specified image and bounding rectangle.
	AnnotationBrush(AnnotationImage, RectangleF)	Creates a texture brush using the specified image and bounding rectangle.
	AnnotationBrush(HatchStyle, Color, Color)	Creates a hatch brush with the specified hatch style, forecolor and background color.
	AnnotationBrush(AnnotationImage, WrapMode, Rectangle)	Creates a texture brush with the specified image, wrap mode and bounding rectangle.
	AnnotationBrush(AnnotationImage, WrapMode, RectangleF)	Creates a texture brush with the specified image, wrap mode and bounding rectangle.
	AnnotationBrush(Point, Point, Color, Color)	Creates a linear gradient brush using the specified start point, end point, start color and end color.
	AnnotationBrush(PointF, PointF, Color, Color)	Creates a linear gradient brush using the specified start point, end point, start color and end color.
	AnnotationBrush(Rectangle, Color, Color, LinearGradientMode)	Creates a linear gradient brush with the bounding rectangle, starting and ending colors, and the gradient orientation.
	AnnotationBrush(RectangleF, Color, Color, LinearGradientMode)	Creates a linear gradient brush with the bounding rectangle, starting and ending colors, and the gradient orientation.

Top

Properties

	Name	Description
	Color	Gets or sets the color of a solid brush.
	FillType	Gets or sets the type of brush used.
	HatchBackColor	Gets or sets the hatch background color of a hatch brush.
	HatchForeColor	Gets or sets the hatch forecolor of a hatch brush.
	HatchStyle	Gets or sets the hatch style of a hatch brush.
	Image	Gets or sets the image used for a texture brush.
	LinearColors	Gets or sets the colors used by a linear gradient brush.
	LinearGradientMode	The orientation of a linear gradient brush.
	Rectangle	The bounding rectangle a texture or linear gradient brush.
	WrapMode	Gets or sets the wrap mode of a texture brush.

Top

Methods

	Name	Description
	Clone	Creates a copy of the AnnotationBrush object.
	Equals	Used to compare two AnnotationBrush objects. (Overrides ObjectEquals(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 ObjectGetHashCode.)
	GetObjectData	Fills a SerializationInfo object with information about the brush.
	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 after a property has been changed.
	OnPropertyChanged	Called when a property value has changed and raises the PropertyChanged event.
	OnPropertyChanging	Called before a property has been changed.
	ToString	Returns a information about this AnnotationBrush. (Overrides ObjectToString.)

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 brush or equivalent for the drawing environment of its choice.

Examples

The code below creates a RectangleAnnotation with a solid brush and black 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