PolygonAnnotation Class |
A PolygonAnnotation is a series of points used to draw a polygon with an optional fill.
Inheritance HierarchySystemObject
Atalasoft.Annotate.UIAnnotationUI
Atalasoft.Annotate.UIPointBaseAnnotation
Atalasoft.Annotate.UIPolygonAnnotation
Atalasoft.Annotate.UIAnnotationUI
Atalasoft.Annotate.UIPointBaseAnnotation
Atalasoft.Annotate.UIPolygonAnnotation
Namespace: Atalasoft.Annotate.UI
Assembly: Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe PolygonAnnotation type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | PolygonAnnotation | Creates a new instance of PolygonAnnotation. |
| PolygonAnnotation(PolygonData) | Creates a new instance of PolygonAnnotation specifying the PolygonData for
this annotation. |
| PolygonAnnotation(SerializationInfo, StreamingContext) | Creates a new instance of PolygonAnnotation from serialization information. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush) | Creates a new instance of PolygonAnnotation specifying the outline and fill. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush, PointFCollection) | Obsolete. This overload is obsolete and may be removed in a future release. Creates a new instance of PolygonAnnotation specifying the outline, fill and points collection. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush, PointF) | Obsolete. This overload is obsolete and may be removed in a future release. Creates a new instance of PolygonAnnotation specifying the outline, fill and an array of points. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush, AnnotationBrush, PointF) | Creates a new instance of PolygonAnnotation specifying the outline, fill and shadow
settings. |
| PolygonAnnotation(AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, Boolean) | Creates a new instance of PolygonAnnotation specifying its fill, outline, shadow, shadow
offset and translucent properties. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush, AnnotationBrush, PointF, PointFCollection) | Obsolete. This overload is obsolete and may be removed in a future release. Creates a new instance of PolygonAnnotation specifying the outline, fill, shadow settings and points of the polygon. |
| PolygonAnnotation(AnnotationPen, AnnotationBrush, AnnotationBrush, PointF, PointF) | Obsolete. This overload is obsolete and may be removed in a future release. Creates a new instance of PolygonAnnotation specifying the outline, fill, shadow settings and array of points for the polygon. |
| PolygonAnnotation(PointF, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, Boolean) | Creates a new instance of PolygonAnnotation specifying the points, fill, outline, shadow,
shadow offset and translucent properties. |
| PolygonAnnotation(PointFCollection, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, Boolean) | Creates a new instance of PolygonAnnotation specifying the point collection, fill,
outline, shadow, shadow offset and translucent properties. |
Properties| Name | Description | |
|---|---|---|
 | Bounds |
Gets the bounding rectangle for the annotation.
(Overrides AnnotationUIBounds.) |
| CanMirror |
Gets or sets a value indicating whether can mirror.
(Inherited from AnnotationUI.) |
| CanMove |
Gets or sets a value indicating whether can move.
(Inherited from AnnotationUI.) |
| CanResize |
Gets or sets a value indicating whether can resize.
(Inherited from AnnotationUI.) |
| CanRotate |
Gets or sets a value indicating whether can rotate.
(Inherited from AnnotationUI.) |
| CanSelect |
Gets or sets a value indicating whether can select.
(Inherited from AnnotationUI.) |
| ContextMenu | Gets or sets a ContextMenu object that will be displayed when the user right-clicks on
the annotation. (Inherited from AnnotationUI.) |
| ContextMenuStrip | Gets or sets a ContextMenuStrip object that will be displayed when the user right-clicks
on the annotation. (Inherited from AnnotationUI.) |
| Controller | Gets the AnnotationController for this annotation. (Inherited from AnnotationUI.) |
| CreationTime |
Gets or sets the creation time.
(Inherited from AnnotationUI.) |
| Data | Gets the AnnotationData object associated with this annotation. (Inherited from AnnotationUI.) |
| Fill | Gets or sets the fill for the annotation. |
 | FreehandStyle |
Gets or sets a value indicating whether this annotation should create in the same
style as a FreehandAnnotation.
(Inherited from PointBaseAnnotation.) |
| GripMode |
Gets or sets whether a RectangleGrips or PointGrips object is used for this
annotation.
(Inherited from PointBaseAnnotation.) |
| Grips | Gets the grips used for the annotation. (Inherited from AnnotationUI.) |
| HitTestRectangle | Gets a rectangle used for hit testing or RectangleF.Empty to use the default hit testing
method. (Inherited from AnnotationUI.) |
| Location | Gets or sets the location of the annotation in document space. (Inherited from AnnotationUI.) |
| ModifiedTime |
Gets or sets the modification time.
(Inherited from AnnotationUI.) |
| Name |
Gets or sets the name.
(Inherited from AnnotationUI.) |
| Outline | Gets or sets the outline for the annotation. |
| ParentLayer | Gets or sets the LayerAnnotation that contains this annotation. (Inherited from AnnotationUI.) |
| Points | Gets a PointFCollection containing the points for this polygon in annotation space.
|
| Rotation |
Gets or sets the rotation.
(Inherited from AnnotationUI.) |
| Security |
Gets or sets the security.
(Inherited from AnnotationUI.) |
| Selected | Gets or sets a value indicating whether this annotation the selected. (Inherited from AnnotationUI.) |
| Shadow | Gets or sets the AnnotationBrush used for the drop shadow. |
| ShadowOffset | Gets or sets the drop shadow offset. |
| Size | Gets or sets the size of the annotation. (Inherited from AnnotationUI.) |
| State | Gets or sets the current state of the annotation. (Inherited from AnnotationUI.) |
| ToolTip |
Gets or sets the tool tip.
(Inherited from AnnotationUI.) |
| Transform |
Gets or sets the transform.
(Inherited from AnnotationUI.) |
| Translucent | Gets or sets a value indicating whether this annotation is used as a highlighter. |
| UserName |
Gets or sets the name of the user.
(Inherited from AnnotationUI.) |
| Visible | Gets or sets a value indicating whether the annotation is visible. (Inherited from AnnotationUI.) |
Methods| Name | Description | |
|---|---|---|
  | AddGripsToRegion |
Adds the annotation grips to a region. The grips are added in annotation space.
(Inherited from AnnotationUI.) |
| ApplyRegionTransform |
Use this method to convert a region from annotation space to document or view
space.
(Inherited from AnnotationUI.) |
| BeginCreate |
This method is called by the AnnotationController when the user is beginning to create this
annotation using the mouse.
(Inherited from PointBaseAnnotation.) |
| Clone |
Creates a copy of this annotation.
(Overrides AnnotationUIClone.) |
| CreateRenderTransform | Returns the Matrix used by the renderer to transform the annotation. (Inherited from AnnotationUI.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from 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.) |
| GetConfinedGripPosition |
Gets the confined grip position.
(Inherited from AnnotationUI.) |
| GetConfinedLocation(RectangleF, PointF) |
Returns the new confined location of the annotation when a confinement bounds and new location offset are
provided.
(Inherited from PointBaseAnnotation.) |
| GetConfinedLocation(RectangleF, RectangleF, PointF) | Returns the new confined location of the annotation when the annotation bounds, a confinement bounds and new location offset are provided. This overload is useful when only a portion of the annotation bounds should be taken into account for this calculation. |
| GetConfinedRotation |
Gets the confined rotation.
(Inherited from PointBaseAnnotation.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetObjectData | Fills a SerializationInfo object with information about this annotation. (Inherited from PointBaseAnnotation.) |
| GetOnePixel | Returns the equivalent of 1 pixel in resolution units. (Inherited from AnnotationUI.) |
| GetRegion | Returns a region for the PolygonAnnotation. (Overrides AnnotationUIGetRegion(AnnotateSpace).) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetViewerParameters | This method is used to get information about the viewer where the annotations are rendered, including
resolution, zoom (scale) level and scrollbar position. (Inherited from AnnotationUI.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| Mirror | Mirrors (flips) the annotation horizontally or vertically. (Inherited from AnnotationUI.) |
| OnAnnotationControllerNotification |
Called after a property of the annotation or related AnnotationData has been modified.
(Inherited from PointBaseAnnotation.) |
| OnClick | Called when the user has clicked on the annotation. (Inherited from AnnotationUI.) |
| OnControllerChanged | Called when the Controller property has changed. (Inherited from AnnotationUI.) |
| OnDoubleClick | Called when the annotation is double-clicked. (Inherited from AnnotationUI.) |
| OnGripPositionChanged |
Called when a grip of the annotation has been moved by the user using the mouse.
(Inherited from PointBaseAnnotation.) |
| OnMirror |
Called when the grips of an annotation have been dragged past the opposite grip.
(Inherited from PointBaseAnnotation.) |
| OnMouseDown |
Called when the user clicks down on the annotation.
(Inherited from PointBaseAnnotation.) |
| OnMouseEnter | Called when the mouse is moved into the annotation region. (Inherited from AnnotationUI.) |
| OnMouseExit | Called when the mouse is moved out of the annotation region. (Inherited from AnnotationUI.) |
| OnMouseMove |
Called when the user has moved the mouse over the annotation.
(Inherited from PointBaseAnnotation.) |
| OnMouseUp |
Called when the user has released the mouse over the annotation.
(Inherited from PointBaseAnnotation.) |
| OnMoved | Called when a move to a new location has completed. (Inherited from AnnotationUI.) |
| OnMoving |
Called while an annotation is being moved by the user.
(Inherited from PointBaseAnnotation.) |
| OnPropertyChanged | Called when a property value has changed and raises the PropertyChanged event.
(Inherited from AnnotationUI.) |
| OnPropertyChanging | Called when a property of the annotation or AnnotationData is about to be changed.
(Inherited from AnnotationUI.) |
| OnResized |
Called when a resize on the annotation has completed.
(Inherited from PointBaseAnnotation.) |
| OnResizing | Called while the annotation is being resized by the user. (Inherited from AnnotationUI.) |
| OnRotate | Called when the Rotate(Single) method is called on the annotation. (Inherited from AnnotationUI.) |
| OnRotated | Called when the annotation has been rotated by the user. (Inherited from AnnotationUI.) |
| OnRotateDocument | Called when the RotateDocument(DocumentRotation, Int32) method is used. (Inherited from AnnotationUI.) |
| OnRotating | Called while an annotation is being rotated by the user. (Inherited from AnnotationUI.) |
| OnScrollPositionChanged | Called when the IAnnotate. Transform indicates a change in its
offset (scroll position). (Inherited from AnnotationUI.) |
| OnSelectedChanged | Called when the Selected property of the annotation has changed. (Inherited from AnnotationUI.) |
| OnSizeChanged | Called when the Size property of the annotation has changed. (Inherited from AnnotationUI.) |
| RaiseClickEvent | Use this method to force a Click event on the annotation. (Inherited from AnnotationUI.) |
| RaiseDoubleClickEvent | Use this method to force a DoubleClick event on the annotation. (Inherited from AnnotationUI.) |
| RaiseGripPositionChangedEvent | Use this method to force a GripPositionChanged event on the annotation.
(Inherited from AnnotationUI.) |
| RaiseMouseDownEvent | Use this method to force a MouseDown event on the annotation. (Inherited from AnnotationUI.) |
| RaiseMouseEnterEvent | Use to force the MouseEnter event for the annotation. (Inherited from AnnotationUI.) |
| RaiseMouseExitEvent | Use to force a MouseExit event on the annotation. (Inherited from AnnotationUI.) |
| RaiseMouseMoveEvent | Use this method to force a MouseMove event on the annotation. (Inherited from AnnotationUI.) |
| RaiseMouseUpEvent | Use this method to force a MouseUp event on the annotation. (Inherited from AnnotationUI.) |
| RaiseMovedEvent | Use this method to force a Moved event on the annotation. (Inherited from AnnotationUI.) |
| RaiseMovingEvent | Use this method to force a Moving event on the annotation. (Inherited from AnnotationUI.) |
| RaiseOnRotateDocument | Use this method to force the OnRotateDocument(DocumentRotation) method to be called. (Inherited from AnnotationUI.) |
| RaiseResizedEvent | Use this method to force a Resized event on the annotation. (Inherited from AnnotationUI.) |
| RaiseRotatedEvent | This method invokes the Rotated event. (Inherited from AnnotationUI.) |
| RaiseScrollPositionChangedEvent | Use this method to force the OnScrollPositionChanged(ScrollPositionChangedEventArgs) method to be called.
(Inherited from AnnotationUI.) |
| Remove | Forces the annotation to remove itself from its parent layer. (Inherited from AnnotationUI.) |
| Rotate | Rotates the annotation by the specified number of degrees. (Inherited from AnnotationUI.) |
| SetGrips | Sets the grips used by the annotation. (Inherited from AnnotationUI.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| TransformRectangle | Applies the render transformation matrix to a rectangle. (Inherited from AnnotationUI.) |
Events| Name | Description | |
|---|---|---|
 | AnnotationControllerNotification | Raised after a property value has been changed. (Inherited from AnnotationUI.) |
| Click | Raised when the annotation has been clicked with the mouse. (Inherited from AnnotationUI.) |
| DoubleClick | Raised when the annotation has been double-clicked with the mouse. (Inherited from AnnotationUI.) |
| GripPositionChanged | Raised when a grip for the annotation has been moved. (Inherited from AnnotationUI.) |
| MouseDown | Raised when a mouse button is pressed while on top of the annotation. (Inherited from AnnotationUI.) |
| MouseEnter | Raised when the mouse enters the annotation region. (Inherited from AnnotationUI.) |
| MouseExit | Raised when the mouse exists the annotation region. (Inherited from AnnotationUI.) |
| MouseMove | Raised when the mouse is moved over the annotation. (Inherited from AnnotationUI.) |
| MouseUp | Raised when the mouse button is released from an annotation. (Inherited from AnnotationUI.) |
| Moved | Raised when the annotation has been moved. (Inherited from AnnotationUI.) |
| Moving | Raised while the annotation is being moved. (Inherited from AnnotationUI.) |
| PropertyChanged | Raised when a property value has changed. (Inherited from AnnotationUI.) |
| PropertyChanging | Raised when a property of the annotation or AnnotationData is going to be changed.
(Inherited from AnnotationUI.) |
| Resized | Raised when the annotation has been resized. (Inherited from AnnotationUI.) |
| Resizing | Raised while the annotation is being resized. (Inherited from AnnotationUI.) |
| Rotated |
Raised after the annotation has been rotated by the user.
(Inherited from AnnotationUI.) |
| Rotating | Raise while an annotation is being rotated. (Inherited from AnnotationUI.) |
| SelectedChanged | Raised when the Selected property changes. (Inherited from AnnotationUI.) |
RemarksTo generate a polygon, the user clicks the left mouse button to set each point. The user can stop adding points by clicking the right mouse button.
A polygon requires at least three points in the Points collection.
See Also