Click or drag to resize

CommentData Class

The CommentData class is used for adding comments to other annotations, but it can also be used standalone.
Inheritance Hierarchy

Namespace:  Atalasoft.Annotate
Assembly:  Atalasoft.dotImage (in Atalasoft.dotImage.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class CommentData : TextData, 
	IAttachableAnnotation, ISerializable, ICloneable

The CommentData type exposes the following members.

Constructors
  NameDescription
Public methodCommentData
Creates a new instance of CommentData.
Public methodCommentData(RectangleF)
Creates a new instance of CommentData specifying the annotation location and size.
Public methodCommentData(String)
Creates a new instance of CommentData specifying the annotation text.
Public methodCommentData(WangAttributeData)
Creates a new instance of CommentData from WANG annotation information.
Public methodCommentData(RectangleF, String)
Creates a new instance of CommentData specifying the annotation text.
Public methodCommentData(SerializationInfo, StreamingContext)
Creates a new instance of CommentData from serialized information.
Public methodCommentData(String, AnnotationFont)
Creates a new instance of CommentData specifying the text and font.
Public methodCommentData(RectangleF, String, AnnotationFont)
Creates a new instance of CommentData specifying the text and font.
Public methodCommentData(String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen)
Creates a new instance of CommentData specifying the text, font, font brush, fill and outline for the annotation.
Public methodCommentData(RectangleF, String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen)
Creates a new instance of CommentData specifying the text, font, font brush, fill and outline for the annotation.
Public methodCommentData(String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, ShadowMode)
Creates a new instance of CommentData specifying the properties for this object.
Public methodCommentData(RectangleF, String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, ShadowMode)
Creates a new instance of CommentData specifying the properties for this object.
Top
Properties
  NameDescription
Public propertyAlignment
Gets or sets the horizontal alignment of the text.
(Inherited from TextData.)
Public propertyAllowEditing

Gets or sets a value indicating whether the annotation's text data should be editable or read-only via the user interface.

(Inherited from TextData.)
Public propertyAnnotationBounds
Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied.
(Inherited from AnnotationData.)
Public propertyAutoSize
Gets or sets a value indicating whether the annotation will automatically resize to fit the text.
(Inherited from TextData.)
Public propertyBounds (Inherited from TextData.)
Public propertyCanMirror
Gets or sets a value indicating if the annotation can mirror.
(Inherited from AnnotationData.)
Public propertyCanMove
Gets or sets a value indicating if the annotation can be moved.
(Inherited from AnnotationData.)
Public propertyCanResize
Gets or sets a value indicating if the annotation can be resized.
(Inherited from AnnotationData.)
Public propertyCanRotate
Gets or sets a value indicating if the annotation can be rotated.
(Inherited from AnnotationData.)
Public propertyCanSelect
Gets or sets a value indicating if the annotation can be selected.
(Inherited from AnnotationData.)
Public propertyCreationTime
Gets or sets the creation time of the annotation.
(Inherited from AnnotationData.)
Public propertyFill
Gets or sets the fill used for the annotation.
(Inherited from TextData.)
Public propertyFont
Gets or sets the font for the text.
(Inherited from TextData.)
Public propertyFontBrush
Gets or sets the AnnotationBrush used for the font.
(Inherited from TextData.)
Public propertyFormatFlags
Gets or sets a StringFormatFlags enumeration that contains formatting information.
(Inherited from TextData.)
Public propertyGuid
Gets a Guid used to identify the annotation.
Public propertyIgnoreDataChanges
Gets or sets a value indicating whether any properties changes should be passed to the undo manager.
(Inherited from AnnotationData.)
Public propertyIsMirroredHorizontally
Gets a value indicating whether the annotation is mirrored horizontally.
(Inherited from AnnotationData.)
Public propertyIsMirroredVertically
Gets a value indicating whether the annotation is mirrored vertically.
(Inherited from AnnotationData.)
Public propertyLineAlignment
Gets or sets the line alignment.
(Inherited from TextData.)
Public propertyLocation
Gets or sets the location of this annotation.
(Inherited from AnnotationData.)
Public propertyMinimized
Gets or sets a value indicating whether the annotation is minimized.
(Inherited from TextData.)
Public propertyModifiedTime
Gets or sets the time in which this annotation was modified.
(Inherited from AnnotationData.)
Public propertyName
Gets or sets a name for this annotation.
(Inherited from AnnotationData.)
Public propertyOutline
Gets or sets the outline of the annotation.
(Inherited from TextData.)
Public propertyPadding
Gets or sets a value indicating how much padding is added around the text.
(Inherited from TextData.)
Public propertyParent
Gets or sets the annotation this annotation is attached to, if any.
Public propertyRenderingHint
Gets or sets the System.Drawing.Text.TextRenderingHint used when rendering this text
(Inherited from TextData.)
Public propertyReplies
Gets a list of CommentData replies.
Public propertyRotation
Gets or sets the current amount of rotation for this annotation.
(Inherited from AnnotationData.)
Public propertySecurity
Gets or sets the security lock used for this annotation.
(Inherited from AnnotationData.)
Public propertySelected
Get or set whether this AnnotationData object is selected
(Inherited from AnnotationData.)
Public propertyShadow
Gets or sets the AnnotationBrush used draw the drop shadow.
(Inherited from TextData.)
Public propertyShadowMode
Gets or sets the shadow mode used to indicate how the shadow is drawn.
(Inherited from TextData.)
Public propertyShadowOffset
Gets or sets the shadow offset.
(Inherited from TextData.)
Public propertySize
Gets or sets the size of the annotation.
(Inherited from AnnotationData.)
Public propertyState
Get or set the AnnotationState of this AnnotationData object
(Inherited from AnnotationData.)
Public propertyText
Gets or sets the text for this annotation.
(Inherited from TextData.)
Public propertyToolTip
Gets or sets the text displayed in the annotation tooltip.
(Inherited from AnnotationData.)
Public propertyTransform
Gets the transformation matrix used for rendering this annotation.
(Inherited from AnnotationData.)
Public propertyTrimming
Get or sets the type of character trimming to perform on the text.
(Inherited from TextData.)
Public propertyUserName
Gets or sets the username for the annotation. Internally this is used with PDF annotations.
(Inherited from AnnotationData.)
Public propertyVisible
Gets or sets a value indicating if the annotation is visible.
(Inherited from AnnotationData.)
Top
Methods
  NameDescription
Protected methodCalculateAnnotationBounds(AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
(Inherited from AnnotationData.)
Protected methodCalculateAnnotationBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle without applying the annotation transforms.
(Inherited from AnnotationData.)
Protected methodCalculateBounds(AnnotationPen, AnnotationBrush, PointF)
This method will calculate the bounding rectangle for the annotation, taking the pen width, shadow and annotation transforms into account.
(Inherited from AnnotationData.)
Protected methodCalculateBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)
This method will add the annotation pen width, shadow and transforms to the provided rectangle bounds.
(Inherited from AnnotationData.)
Public methodClone
Creates a copy of this TextData.
(Overrides TextDataClone.)
Protected methodCloneBaseData
Creates a copy of this TextData.
(Overrides TextDataCloneBaseData(AnnotationData).)
Protected methodCloneBaseDataFrom
Clones the base data from.
(Inherited from AnnotationData.)
Public methodDispose
Releases resources used by the annotation.
(Inherited from AnnotationData.)
Protected methodDispose(Boolean)
Called to release resources used by the annotation.
(Inherited from AnnotationData.)
Public methodEquals
Determines whether the specified Object, is equal to this instance.
(Overrides TextDataEquals(Object).)
Protected methodFinalize
Finalizes an instance of the AnnotationData class.
(Inherited from AnnotationData.)
Public methodGetAllExtraProperties
Returns a Dictionary containing the key value pairs for extra properties.
(Inherited from AnnotationData.)
Public methodGetExtraProperty
Returns the value stored with SetExtraProperty(String, String).
(Inherited from AnnotationData.)
Public methodGetHashCode
Returns a hash code for this instance.
(Overrides TextDataGetHashCode.)
Protected methodGetLineCapBounds
Called to get the rectangle bounds of the line cap used in an AnnotationLineCap.
(Inherited from AnnotationData.)
Public methodGetObjectData
Fills a SerializationInfo object with information about this object.
(Inherited from TextData.)
Public methodGetRenderTransform
Returns a System.Drawing.Drawing2D.Matrix containing the matrices applied to the annotation.
(Inherited from AnnotationData.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetWangAttributeData
Returns a WangAttributeData containing information about this TextData.
(Inherited from TextData.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMirror
Flips (mirrors) the annotation horizontally or vertically.
(Inherited from AnnotationData.)
Protected methodOnAnnotationControllerNotification
Called after a property value has been changed.
(Inherited from AnnotationData.)
Protected methodOnCanMirrorChanged
Called when the CanMirror property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanMoveChanged
Called when the CanMove property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanResizeChanged
Called when the CanResize property has changed.
(Inherited from AnnotationData.)
Protected methodOnCanRotateChanged
Called when the CanRotate property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCanSelectChanged
Called when the CanSelect property value has changed.
(Inherited from AnnotationData.)
Protected methodOnCreationTimeChanged
Called when the CreationTime property value has changed.
(Inherited from AnnotationData.)
Protected methodOnLocationChanged
Called when the Location property value has changed.
(Inherited from AnnotationData.)
Protected methodOnMirrored
Called when the annotation has been mirrored.
(Inherited from AnnotationData.)
Protected methodOnModifiedTimeChanged
Called when the ModifiedTime property has changed.
(Inherited from AnnotationData.)
Protected methodOnNameChanged
Called when the Name property has changed.
(Inherited from AnnotationData.)
Protected methodOnPropertyChanged
Called when a property has been changed and raises the PropertyChanged event.
(Inherited from AnnotationData.)
Protected methodOnPropertyChanging
Called just before a property value is changed.
(Inherited from AnnotationData.)
Protected methodOnRotationChanged
Called when the Rotation property has changed.
(Inherited from AnnotationData.)
Protected methodOnSecurityChanged
Called when the Security property has changed.
(Inherited from AnnotationData.)
Protected methodOnSizeChanged
Called when the Size property has changed.
(Inherited from AnnotationData.)
Protected methodOnStateChanged
Called when the State property has changed and raises the StateChanged event.
(Inherited from AnnotationData.)
Protected methodOnTooltipChanged
Called when the ToolTip property has changed.
(Inherited from AnnotationData.)
Protected methodOnTransformChanged
Called when the Transform property has changed.
(Inherited from AnnotationData.)
Protected methodOnUserNameChanged
Called when the UserName property has changed and raises the UserNameChanged event.
(Inherited from AnnotationData.)
Protected methodOnVisibleChanged
Called when the Visible property has changed.
(Inherited from AnnotationData.)
Protected methodRemoveBrushEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationBrush.
(Inherited from AnnotationData.)
Protected methodRemoveFontEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationFont.
(Inherited from AnnotationData.)
Protected methodRemovePenEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationPen.
(Inherited from AnnotationData.)
Protected methodRemoveSecurityEvents
This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an IAnnotationLock.
(Inherited from AnnotationData.)
Public methodRotate
Applies rotation to the annotation from its current rotation amount.
(Inherited from AnnotationData.)
Protected methodSetBrushEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationBrush.
(Inherited from AnnotationData.)
Public methodSetExtraProperty
Sets a custom value within an annotation that can be retrieved using GetExtraProperty(String).
(Inherited from AnnotationData.)
Protected methodSetFontEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationFont.
(Inherited from AnnotationData.)
Protected methodSetPenEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationPen.
(Inherited from AnnotationData.)
Protected methodSetSecurityEvents
This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an IAnnotationLock.
(Inherited from AnnotationData.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventAnnotationControllerNotification
Raised after a property has been changed.
(Inherited from AnnotationData.)
Public eventCanMirrorChanged
Raised when the CanMirror property is changed.
(Inherited from AnnotationData.)
Public eventCanMoveChanged
Raised when the CanMove property is changed.
(Inherited from AnnotationData.)
Public eventCanResizeChanged
Raised when the CanResize property has changed.
(Inherited from AnnotationData.)
Public eventCanRotateChanged
Raised when the CanRotate property has changed.
(Inherited from AnnotationData.)
Public eventCanSelectChanged
Raised when the CanSelect property has changed.
(Inherited from AnnotationData.)
Public eventCreationTimeChanged
Raised when the CreationTime property has changed.
(Inherited from AnnotationData.)
Public eventLocationChanged
Raised when the Location property has changed.
(Inherited from AnnotationData.)
Public eventMirrored
Raised when the annotation is mirrored, either by the user dragging a grip across its opposite or when the Mirror method is called.
(Inherited from AnnotationData.)
Public eventModifiedTimeChanged
Raised when the ModifiedTime property has changed.
(Inherited from AnnotationData.)
Public eventNameChanged
Raised when the Name property has changed.
(Inherited from AnnotationData.)
Public eventPropertyChanged
Raised when a property value has changed.
(Inherited from AnnotationData.)
Public eventPropertyChanging
Raised before a property is changed.
(Inherited from AnnotationData.)
Public eventRotationChanged
Raised when the Rotation property has changed.
(Inherited from AnnotationData.)
Public eventSecurityChanged
Raised when the Security property has changed.
(Inherited from AnnotationData.)
Public eventSizeChanged
Raised when the Size property has changed.
(Inherited from AnnotationData.)
Public eventStateChanged
This event is raised when the State property value has changed.
(Inherited from AnnotationData.)
Public eventTooltipChanged
Raised when the ToolTip property has changed.
(Inherited from AnnotationData.)
Public eventTransformChanged
Raised when the Transform property has changed.
(Inherited from AnnotationData.)
Public eventUserNameChanged
This event is raised when the UserName property has changed.
(Inherited from AnnotationData.)
Public eventVisibleChanged
Raised when the Visible property has changed.
(Inherited from AnnotationData.)
Top
See Also