Click or drag to resize

AnnotationBase Class

LightningChart .NET Help
Annotations base class.
Inheritance Hierarchy
SystemObject
  System.Windows.ThreadingDispatcherObject
    System.WindowsDependencyObject
      System.WindowsFreezable
        Arction.Wpf.ChartingMVVMChartNode
          Arction.Wpf.ChartingMVVMUserInteractiveObjectInt
            Arction.Wpf.ChartingMVVMUserInteractiveObject
              Arction.Wpf.ChartingMVVMHighlightingItemBase
                Arction.Wpf.ChartingMVVMDraggableObject
                  Arction.Wpf.ChartingMVVM.AnnotationsAnnotationBase
                    Arction.Wpf.ChartingMVVM.AnnotationsAnnotation3DBase
                    Arction.Wpf.ChartingMVVM.AnnotationsAnnotationRound
                    Arction.Wpf.ChartingMVVM.AnnotationsAnnotationXY

Namespace:  Arction.Wpf.ChartingMVVM.Annotations
Assembly:  Arction.Wpf.ChartingMVVM.LightningChart (in Arction.Wpf.ChartingMVVM.LightningChart.dll) Version: 10.3.1
Syntax
[SerializableAttribute]
[TypeConverterAttribute(typeof(GeneralTypeConverter))]
public abstract class AnnotationBase : DraggableObject

The AnnotationBase type exposes the following members.

Constructors
  NameDescription
Public methodAnnotationBase
Constructor.
Top
Properties
  NameDescription
Public propertyAllowDragging
Gets or sets if allow dragging by user. This is a dependency property.
(Inherited from DraggableObject.)
Public propertyAllowResize
Gets or sets if allows resizing by user. This is a dependency property.
Public propertyAllowRotate
Gets or sets if rotation is allowed by user. This is a dependency property.
Public propertyAllowTargetMove
Gets or sets if allows target move by user. This is a dependency property.
Public propertyAllowUserInteraction
Gets or sets if user interaction is allowed. This is a dependency property.
(Inherited from UserInteractiveObject.)
Public propertyAnchor
Gets or sets anchor. This is a dependency property. Rotation uses this point as a center point. Tells where to place the anchored point within the control area. For X-dimension, value 0 represents left coordinate of the object and 1 right coordinate. For Y-dimension, value 0 represents top coordinate of the object and 1 bottom coordinate. To define anchor point outside the object area, define values outside range 0...1.
Public propertyAnchorAdjustByUser
Gets or sets if allows anchor move by user. Anchor is centerpoint of rotation and start point of arrow. This is a dependency property.
Public propertyArrowEndAspectRatio
Gets or sets arrow end aspect ratio (width / height). This is a dependency property.
Public propertyArrowLineStyle
Gets or sets arrow line style. This is a dependency property.
Public propertyArrowStyleBegin
Gets or sets lead arrow style, in the beginning of line. This is a dependency property.
Public propertyArrowStyleEnd
Gets or sets lead arrow style, in Target location. This is a dependency property.
Public propertyAutoSizePadding
Gets or sets padding between text and borders when automatic size is used. This is a dependency property.
Public propertyBorderLineStyle
Gets or sets border line style. This is a dependency property.
Public propertyBorderVisible
Gets or sets if border is visible. This is a dependency property.
Public propertyCanFreeze
Gets a value that indicates whether the object can be made unmodifiable.
(Inherited from Freezable.)
Public propertyCornerRoundRadius
Gets or sets corner rounding radius, in pixels. This is a dependency property.
Public propertyDependencyObjectType
Gets the DependencyObjectType that wraps the CLR type of this instance. 
(Inherited from DependencyObject.)
Public propertyDispatcher
Gets the Dispatcher this DispatcherObject is associated with.
(Inherited from DispatcherObject.)
Public propertyFill
Gets or sets fill. This is a dependency property.
Public propertyHighlight
Gets or sets highlight style. Item can be highlighted by user interactive device or by code. This is a dependency property.
(Inherited from HighlightingItemBase.)
Public propertyIsFrozen
Gets a value that indicates whether the object is currently modifiable.
(Inherited from Freezable.)
Public propertyIsSealed
Gets a value that indicates whether this instance is currently sealed (read-only).
(Inherited from DependencyObject.)
Public propertyLayerGrouping
Gets or sets if text is rendered on layers. This is a dependency property.
Public propertyLocationCoordinateSystem
Gets or sets location coordinate system. This is a dependency property.
Public propertyLocationRelativeOffset
Gets or sets location offset in pixels, relative to location. This is a dependency property.
Public propertyLocationScreenCoords
Gets or sets location as screen coordinates in pixels. This is a dependency property.
Public propertyNibStyle
Gets and sets nib style. Appearance of the user-interactive nibs. This is a dependency property.
Public propertyRotateAngle
Gets or sets rotation angle, in degrees. The rotation is done around the element's center of rotation. This is a dependency property.
Public propertySelected
Gets or sets if annotation is in 'Selected' state, allowing resizing, rotating and anchor adjustment. This is a dependency property.
Public propertyShadow
Gets or sets shadow beneath the object. This is a dependency property.
Public propertySizeScreenCoords
Gets or sets size as screen coordinates. This is a dependency property.
Public propertyStyle
Gets and sets style of the main layout of annotation. This is a dependency property.
Public propertyTargetCoordinateSystem
Gets or sets target coordinate system. This is a dependency property.
Public propertyTargetScreenCoords
Gets or sets screen coordinates. Target is the point that the arrow or callout tip points to. This is a dependency property.
Public propertyText
Gets or sets annotation text. This is a dependency property.
Public propertyTextStyle
Gets or sets text style. Appearance of the text. This is a dependency property.
Public propertyVisible
Gets and sets annotation visible state. This is a dependency property.
Top
Methods
  NameDescription
Public methodChangeOrder
Change object position in list of annotations.
Public methodClearValue(DependencyProperty)
Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier.
(Inherited from DependencyObject.)
Public methodClearValue(DependencyPropertyKey)
Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey.
(Inherited from DependencyObject.)
Public methodClone
Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values.
(Inherited from Freezable.)
Public methodCloneCurrentValue
Creates a modifiable clone (deep copy) of the Freezable using its current values.
(Inherited from Freezable.)
Public methodCoerceValue
Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject.
(Inherited from DependencyObject.)
Public methodDispose
Release all resources used by this instance.
(Inherited from ChartNode.)
Public methodEquals
Determines whether a provided DependencyObject is equivalent to the current DependencyObject.
(Inherited from DependencyObject.)
Public methodFreeze
Makes the current object unmodifiable and sets its IsFrozen property to true.
(Inherited from Freezable.)
Public methodGetAsFrozen
Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetCurrentValueAsFrozen
Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference.
(Inherited from Freezable.)
Public methodGetHashCode
Gets a hash code for this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetLocalValueEnumerator
Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject.
(Inherited from DependencyObject.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetValue
Returns the current effective value of a dependency property on this instance of a DependencyObject.
(Inherited from DependencyObject.)
Public methodInvalidateProperty
Re-evaluates the effective value for the specified dependency property
(Inherited from DependencyObject.)
Public methodIsHighlighted
returns true if the object is highlighted.
(Inherited from HighlightingItemBase.)
Public methodIsPositionOver
Is position over Annotation.
(Overrides UserInteractiveObjectIsPositionOver(Int32, Int32, Boolean).)
Public methodReadLocalValue
Returns the local value of a dependency property, if it exists.
(Inherited from DependencyObject.)
Public methodRemoveHighlight
Removes forced highlighting.
(Inherited from HighlightingItemBase.)
Public methodResetLocation
Reset location, if moved by mouse.
(Inherited from DraggableObject.)
Public methodSetCurrentValue
Sets the value of a dependency property without changing its value source.
(Inherited from DependencyObject.)
Public methodSetHighlight
Highlights the object.

This is a kind of "forced" highlight, and the object might be highlighted even if the highlighting type (defined by Highlight property) is set to None. How the highlighting happens, if any, depends on object. Most objects use the defined type by default, and fall back to Simple highlighting if None is set.

(Inherited from HighlightingItemBase.)
Public methodSetProperCursor
Set proper cursor. Default for dragging is hand and for resize SizeAll.
(Overrides DraggableObjectSetProperCursor.)
Public methodSetValue(DependencyProperty, Object)
Sets the local value of a dependency property, specified by its dependency property identifier.
(Inherited from DependencyObject.)
Public methodSetValue(DependencyPropertyKey, Object)
Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property.
(Inherited from DependencyObject.)
Public methodToString
Description of class.
(Overrides HighlightingItemBaseToString.)
Top
Events
  NameDescription
Public eventAnchorAdjustedByUser
Anchor has been adjusted by user.
Public eventChanged
Occurs when the Freezable or an object it contains is modified.
(Inherited from Freezable.)
Public eventDraggedByUser
Dragged by user.
(Inherited from DraggableObject.)
Public eventHighlightedStateChanged
Event telling that highlighted state has changed. Contains information of the new state.
(Inherited from HighlightingItemBase.)
Public eventLocationRelativeOffsetChangedByUser
Location relative screen coordinate offset has been changed by user.
Public eventLocationScreenCoordinatesChangedByUser
Location screen coordinates have been changed by user.
Public eventMouseClick
Mouse button has been clicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDoubleClick
Mouse button has been doubleclicked.
(Inherited from UserInteractiveObject.)
Public eventMouseDown
Mouse button has been pressed down.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOff
Mouse has been moved outside of object.
(Inherited from UserInteractiveObject.)
Public eventMouseOverOn
Mouse has been moved over object.
(Inherited from UserInteractiveObject.)
Public eventMouseUp
Mouse button has been released.
(Inherited from UserInteractiveObject.)
Public eventRotatedByUser
Annotation has been rotated by user.
Top
Fields
  NameDescription
Public fieldStatic memberAllowAnchorAdjustProperty
Identifies the AllowAnchorAdjust dependency property.
Public fieldStatic memberAllowRotateProperty
Identifies the AllowRotate dependency property.
Public fieldStatic memberAllowTargetMoveProperty
Identifies the AllowTargetMove dependency property.
Public fieldStatic memberAnchorProperty
Identifies the Anchor dependency property.
Public fieldStatic memberArrowEndAspectRatioProperty
Identifies the ArrowEndAspectRatio dependency property.
Public fieldStatic memberArrowLineStyleProperty
Identifies the ArrowLineStyle dependency property.
Public fieldStatic memberArrowStyleBeginProperty
Identifies the ArrowStyleBegin dependency property.
Public fieldStatic memberArrowStyleEndProperty
Identifies the ArrowStyleEnd dependency property.
Public fieldStatic memberAutoSizePaddingProperty
Identifies the AutoSizePadding dependency property.
Public fieldStatic memberBorderLineStyleProperty
Identifies the BorderLineStyle dependency property.
Public fieldStatic memberBorderVisibleProperty
Identifies the BorderVisible dependency property.
Public fieldStatic memberCornerRoundRadiusProperty
Identifies the CornerRoundRadius dependency property.
Public fieldStatic memberFillProperty
Identifies the Fill dependency property.
Public fieldStatic memberLayerGroupingProperty
Identifies the LayerGrouping dependency property.
Public fieldStatic memberLocationCoordinateSystemProperty
Identifies the LocationCoordinateSystem dependency property.
Public fieldStatic memberLocationRelativeOffsetProperty
Identifies the LocationRelativeOffset dependency property.
Public fieldStatic memberLocationScreenCoordsProperty
Identifies the LocationScreenCoords dependency property.
Public fieldStatic memberNibStyleProperty
Identifies the NibStyle dependency property.
Public fieldStatic memberRotateAngleProperty
Identifies the RotateAngle dependency property.
Public fieldStatic memberSelectedProperty
Identifies the Selected dependency property.
Public fieldStatic memberShadowProperty
Identifies the Shadow dependency property.
Public fieldStatic memberSizeScreenCoordsProperty
Identifies the SizeScreenCoords dependency property.
Public fieldStatic memberStyleProperty
Identifies the Style dependency property.
Public fieldTag
Tag. Freely assignable object.
(Inherited from UserInteractiveObjectInt.)
Public fieldStatic memberTargetCoordinateSystemProperty
Identifies the TargetCoordinateSystem dependency property.
Public fieldStatic memberTargetScreenCoordsProperty
Identifies the TargetCoordinateSystem dependency property.
Public fieldStatic memberTextProperty
Identifies the Text dependency property.
Public fieldStatic memberTextStyleProperty
Identifies the TextStyle dependency property.
Public fieldStatic memberVisibleProperty
Identifies the Visible dependency property.
Top
See Also