Click or drag to resize

InkData Class

This class holds the InkCollector data for an InkAnnotation.
Inheritance Hierarchy

Namespace:  Atalasoft.Annotate.Ink
Assembly:  Atalasoft.DotAnnotate.Ink (in Atalasoft.DotAnnotate.Ink.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
[SerializableAttribute]
public class InkData : AnnotationData, IDisposable, 
	ISerializable

The InkData type exposes the following members.

Constructors
  NameDescription
Public methodInkData
Creates a new instance of InkData.
Public methodInkData(SerializationInfo, StreamingContext)
Creates a new instance of InkData from serialized information.
Top
Properties
  NameDescription
Public propertyAllowPenScaling
Gets or sets a value indicating whether the ink pen size should be scaled along with the zoom level of the viewer.
Public propertyAnnotationBounds
Gets the rectangle bounds of the annotation, including any pen or shadow, before any matricies are applied.
(Inherited from AnnotationData.)
Public propertyBounds
Gets the bounding rectangle of the annotation.
(Inherited from AnnotationData.)
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 propertyDisposed
Gets a value indicating whether this object has been disposed.
Public propertyDrawingAttributes
Gets or sets the attributes that are applied to the ink when drawn.
Public propertyIgnoreDataChanges
Gets or sets a value indicating whether any properties changes should be passed to the undo manager.
(Inherited from AnnotationData.)
Public propertyInkCollector
Gets the Microsoft.Ink.InkCollector used to store the ink strokes.
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 propertyLocation
Gets or sets the location of this annotation.
(Inherited from AnnotationData.)
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 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 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 propertyStrokes
Gets a collection of Microsoft.Ink.Stroke objects.
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 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 (Overrides AnnotationDataClone.)
Protected methodCode exampleCloneBaseData
Fills the data object with cloned property values.
(Inherited from 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)
Releases the unmanaged resources used by the InkData and optionally releases the managed resources
(Overrides AnnotationDataDispose(Boolean).)
Public methodEquals (Overrides AnnotationDataEquals(Object).)
Protected methodFinalize
InkData destructor
(Overrides AnnotationDataFinalize.)
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
Get hash code for this object
(Overrides AnnotationDataGetHashCode.)
Protected methodGetLineCapBounds
Called to get the rectangle bounds of the line cap used in an AnnotationLineCap.
(Inherited from AnnotationData.)
Public methodGetObjectData (Overrides AnnotationDataGetObjectData(SerializationInfo, StreamingContext).)
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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodMirror (Overrides AnnotationDataMirror(MirrorDirection, Boolean).)
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 (Overrides AnnotationDataOnLocationChanged(AnnotationLocationChangedEventArgs).)
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 (Overrides AnnotationDataOnPropertyChanging(AnnotationPropertyChangingEventArgs).)
Protected methodOnRotationChanged (Overrides AnnotationDataOnRotationChanged(EventArgs).)
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 (Overrides AnnotationDataRotate(Single).)
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
Remarks
Access to the internal InkData of an InkAnnotation is provided through the Data property.
See Also