CommentData Class

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

Inheritance Hierarchy

SystemObject
  Atalasoft.AnnotateAnnotationData
    Atalasoft.AnnotateTextData
      Atalasoft.AnnotateCommentData

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]
public class CommentData : TextData, 
	IAttachableAnnotation, ISerializable, ICloneable

<SerializableAttribute>
Public Class CommentData
	Inherits TextData
	Implements IAttachableAnnotation, ISerializable, ICloneable

The CommentData type exposes the following members.

Constructors

	Name	Description
	CommentData	Creates a new instance of CommentData.
	CommentData(RectangleF)	Creates a new instance of CommentData specifying the annotation location and size.
	CommentData(String)	Creates a new instance of CommentData specifying the annotation text.
	CommentData(WangAttributeData)	Creates a new instance of CommentData from WANG annotation information.
	CommentData(RectangleF, String)	Creates a new instance of CommentData specifying the annotation text.
	CommentData(SerializationInfo, StreamingContext)	Creates a new instance of CommentData from serialized information.
	CommentData(String, AnnotationFont)	Creates a new instance of CommentData specifying the text and font.
	CommentData(RectangleF, String, AnnotationFont)	Creates a new instance of CommentData specifying the text and font.
	CommentData(String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen)	Creates a new instance of CommentData specifying the text, font, font brush, fill and outline for the annotation.
	CommentData(RectangleF, String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen)	Creates a new instance of CommentData specifying the text, font, font brush, fill and outline for the annotation.
	CommentData(String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, ShadowMode)	Creates a new instance of CommentData specifying the properties for this object.
	CommentData(RectangleF, String, AnnotationFont, AnnotationBrush, AnnotationBrush, AnnotationPen, AnnotationBrush, PointF, ShadowMode)	Creates a new instance of CommentData specifying the properties for this object.

Top

Properties

	Name	Description
	Alignment	Gets or sets the horizontal alignment of the text. (Inherited from TextData.)
	AllowEditing	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.)
	AnnotationBounds	Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied. (Inherited from AnnotationData.)
	AutoSize	Gets or sets a value indicating whether the annotation will automatically resize to fit the text. (Inherited from TextData.)
	Bounds	(Inherited from TextData.)
	CanMirror	Gets or sets a value indicating if the annotation can mirror. (Inherited from AnnotationData.)
	CanMove	Gets or sets a value indicating if the annotation can be moved. (Inherited from AnnotationData.)
	CanResize	Gets or sets a value indicating if the annotation can be resized. (Inherited from AnnotationData.)
	CanRotate	Gets or sets a value indicating if the annotation can be rotated. (Inherited from AnnotationData.)
	CanSelect	Gets or sets a value indicating if the annotation can be selected. (Inherited from AnnotationData.)
	CreationTime	Gets or sets the creation time of the annotation. (Inherited from AnnotationData.)
	Fill	Gets or sets the fill used for the annotation. (Inherited from TextData.)
	Font	Gets or sets the font for the text. (Inherited from TextData.)
	FontBrush	Gets or sets the AnnotationBrush used for the font. (Inherited from TextData.)
	FormatFlags	Gets or sets a StringFormatFlags enumeration that contains formatting information. (Inherited from TextData.)
	Guid	Gets a Guid used to identify the annotation.
	IgnoreDataChanges	Gets or sets a value indicating whether any properties changes should be passed to the undo manager. (Inherited from AnnotationData.)
	IsMirroredHorizontally	Gets a value indicating whether the annotation is mirrored horizontally. (Inherited from AnnotationData.)
	IsMirroredVertically	Gets a value indicating whether the annotation is mirrored vertically. (Inherited from AnnotationData.)
	LineAlignment	Gets or sets the line alignment. (Inherited from TextData.)
	Location	Gets or sets the location of this annotation. (Inherited from AnnotationData.)
	Minimized	Gets or sets a value indicating whether the annotation is minimized. (Inherited from TextData.)
	ModifiedTime	Gets or sets the time in which this annotation was modified. (Inherited from AnnotationData.)
	Name	Gets or sets a name for this annotation. (Inherited from AnnotationData.)
	Outline	Gets or sets the outline of the annotation. (Inherited from TextData.)
	Padding	Gets or sets a value indicating how much padding is added around the text. (Inherited from TextData.)
	Parent	Gets or sets the annotation this annotation is attached to, if any.
	RenderingHint	Gets or sets the System.Drawing.Text.TextRenderingHint used when rendering this text (Inherited from TextData.)
	Replies	Gets a list of CommentData replies.
	Rotation	Gets or sets the current amount of rotation for this annotation. (Inherited from AnnotationData.)
	Security	Gets or sets the security lock used for this annotation. (Inherited from AnnotationData.)
	Selected	Get or set whether this AnnotationData object is selected (Inherited from AnnotationData.)
	Shadow	Gets or sets the AnnotationBrush used draw the drop shadow. (Inherited from TextData.)
	ShadowMode	Gets or sets the shadow mode used to indicate how the shadow is drawn. (Inherited from TextData.)
	ShadowOffset	Gets or sets the shadow offset. (Inherited from TextData.)
	Size	Gets or sets the size of the annotation. (Inherited from AnnotationData.)
	State	Get or set the AnnotationState of this AnnotationData object (Inherited from AnnotationData.)
	Text	Gets or sets the text for this annotation. (Inherited from TextData.)
	ToolTip	Gets or sets the text displayed in the annotation tooltip. (Inherited from AnnotationData.)
	Transform	Gets the transformation matrix used for rendering this annotation. (Inherited from AnnotationData.)
	Trimming	Get or sets the type of character trimming to perform on the text. (Inherited from TextData.)
	UserName	Gets or sets the username for the annotation. Internally this is used with PDF annotations. (Inherited from AnnotationData.)
	Visible	Gets or sets a value indicating if the annotation is visible. (Inherited from AnnotationData.)

Top

Methods

	Name	Description
	CalculateAnnotationBounds(AnnotationPen, AnnotationBrush, PointF)	This method will calculate the bounding rectangle without applying the annotation transforms. (Inherited from AnnotationData.)
	CalculateAnnotationBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)	This method will calculate the bounding rectangle without applying the annotation transforms. (Inherited from AnnotationData.)
	CalculateBounds(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.)
	CalculateBounds(RectangleF, AnnotationPen, AnnotationBrush, PointF)	This method will add the annotation pen width, shadow and transforms to the provided rectangle bounds. (Inherited from AnnotationData.)
	Clone	Creates a copy of this TextData. (Overrides TextDataClone.)
	CloneBaseData	Creates a copy of this TextData. (Overrides TextDataCloneBaseData(AnnotationData).)
	CloneBaseDataFrom	Clones the base data from. (Inherited from AnnotationData.)
	Dispose	Releases resources used by the annotation. (Inherited from AnnotationData.)
	Dispose(Boolean)	Called to release resources used by the annotation. (Inherited from AnnotationData.)
	Equals	Determines whether the specified Object, is equal to this instance. (Overrides TextDataEquals(Object).)
	Finalize	Finalizes an instance of the AnnotationData class. (Inherited from AnnotationData.)
	GetAllExtraProperties	Returns a Dictionary containing the key value pairs for extra properties. (Inherited from AnnotationData.)
	GetExtraProperty	Returns the value stored with SetExtraProperty(String, String). (Inherited from AnnotationData.)
	GetHashCode	Returns a hash code for this instance. (Overrides TextDataGetHashCode.)
	GetLineCapBounds	Called to get the rectangle bounds of the line cap used in an AnnotationLineCap. (Inherited from AnnotationData.)
	GetObjectData	Fills a SerializationInfo object with information about this object. (Inherited from TextData.)
	GetRenderTransform	Returns a System.Drawing.Drawing2D.Matrix containing the matrices applied to the annotation. (Inherited from AnnotationData.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetWangAttributeData	Returns a WangAttributeData containing information about this TextData. (Inherited from TextData.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Mirror	Flips (mirrors) the annotation horizontally or vertically. (Inherited from AnnotationData.)
	OnAnnotationControllerNotification	Called after a property value has been changed. (Inherited from AnnotationData.)
	OnCanMirrorChanged	Called when the CanMirror property value has changed. (Inherited from AnnotationData.)
	OnCanMoveChanged	Called when the CanMove property value has changed. (Inherited from AnnotationData.)
	OnCanResizeChanged	Called when the CanResize property has changed. (Inherited from AnnotationData.)
	OnCanRotateChanged	Called when the CanRotate property value has changed. (Inherited from AnnotationData.)
	OnCanSelectChanged	Called when the CanSelect property value has changed. (Inherited from AnnotationData.)
	OnCreationTimeChanged	Called when the CreationTime property value has changed. (Inherited from AnnotationData.)
	OnLocationChanged	Called when the Location property value has changed. (Inherited from AnnotationData.)
	OnMirrored	Called when the annotation has been mirrored. (Inherited from AnnotationData.)
	OnModifiedTimeChanged	Called when the ModifiedTime property has changed. (Inherited from AnnotationData.)
	OnNameChanged	Called when the Name property has changed. (Inherited from AnnotationData.)
	OnPropertyChanged	Called when a property has been changed and raises the PropertyChanged event. (Inherited from AnnotationData.)
	OnPropertyChanging	Called just before a property value is changed. (Inherited from AnnotationData.)
	OnRotationChanged	Called when the Rotation property has changed. (Inherited from AnnotationData.)
	OnSecurityChanged	Called when the Security property has changed. (Inherited from AnnotationData.)
	OnSizeChanged	Called when the Size property has changed. (Inherited from AnnotationData.)
	OnStateChanged	Called when the State property has changed and raises the StateChanged event. (Inherited from AnnotationData.)
	OnTooltipChanged	Called when the ToolTip property has changed. (Inherited from AnnotationData.)
	OnTransformChanged	Called when the Transform property has changed. (Inherited from AnnotationData.)
	OnUserNameChanged	Called when the UserName property has changed and raises the UserNameChanged event. (Inherited from AnnotationData.)
	OnVisibleChanged	Called when the Visible property has changed. (Inherited from AnnotationData.)
	RemoveBrushEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationBrush. (Inherited from AnnotationData.)
	RemoveFontEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationFont. (Inherited from AnnotationData.)
	RemovePenEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an AnnotationPen. (Inherited from AnnotationData.)
	RemoveSecurityEvents	This is a helper method to remove the PropertyChanging and AnnotationControllerNotification event handlers for an IAnnotationLock. (Inherited from AnnotationData.)
	Rotate	Applies rotation to the annotation from its current rotation amount. (Inherited from AnnotationData.)
	SetBrushEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationBrush. (Inherited from AnnotationData.)
	SetExtraProperty	Sets a custom value within an annotation that can be retrieved using GetExtraProperty(String). (Inherited from AnnotationData.)
	SetFontEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationFont. (Inherited from AnnotationData.)
	SetPenEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an AnnotationPen. (Inherited from AnnotationData.)
	SetSecurityEvents	This is a helper method used to set event handlers for the PropertyChanging and AnnotationControllerNotification event handlers in an IAnnotationLock. (Inherited from AnnotationData.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	AnnotationControllerNotification	Raised after a property has been changed. (Inherited from AnnotationData.)
	CanMirrorChanged	Raised when the CanMirror property is changed. (Inherited from AnnotationData.)
	CanMoveChanged	Raised when the CanMove property is changed. (Inherited from AnnotationData.)
	CanResizeChanged	Raised when the CanResize property has changed. (Inherited from AnnotationData.)
	CanRotateChanged	Raised when the CanRotate property has changed. (Inherited from AnnotationData.)
	CanSelectChanged	Raised when the CanSelect property has changed. (Inherited from AnnotationData.)
	CreationTimeChanged	Raised when the CreationTime property has changed. (Inherited from AnnotationData.)
	LocationChanged	Raised when the Location property has changed. (Inherited from AnnotationData.)
	Mirrored	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.)
	ModifiedTimeChanged	Raised when the ModifiedTime property has changed. (Inherited from AnnotationData.)
	NameChanged	Raised when the Name property has changed. (Inherited from AnnotationData.)
	PropertyChanged	Raised when a property value has changed. (Inherited from AnnotationData.)
	PropertyChanging	Raised before a property is changed. (Inherited from AnnotationData.)
	RotationChanged	Raised when the Rotation property has changed. (Inherited from AnnotationData.)
	SecurityChanged	Raised when the Security property has changed. (Inherited from AnnotationData.)
	SizeChanged	Raised when the Size property has changed. (Inherited from AnnotationData.)
	StateChanged	This event is raised when the State property value has changed. (Inherited from AnnotationData.)
	TooltipChanged	Raised when the ToolTip property has changed. (Inherited from AnnotationData.)
	TransformChanged	Raised when the Transform property has changed. (Inherited from AnnotationData.)
	UserNameChanged	This event is raised when the UserName property has changed. (Inherited from AnnotationData.)
	VisibleChanged	Raised when the Visible property has changed. (Inherited from AnnotationData.)

Top

Reference

Atalasoft.Annotate Namespace