Class AnnotationEditor

Represents a class that holds information and functionalities of Annotations.

Inheritance
System.Object
AnnotationEditor
Implements
System.ComponentModel.INotifyPropertyChanged
Namespace: Syncfusion.UI.Xaml.Diagram.Controls
Assembly: Syncfusion.SfDiagram.WPF.dll
Syntax
public class AnnotationEditor : Control, IView, IDiagramElement, IID, INotifyPropertyChanged

Constructors

AnnotationEditor()

Initializes a new instance of the AnnotationEditor class.

Declaration
public AnnotationEditor()

Fields

AnnotationRelativeModeProperty

Provides information about the AnnotationRelativeMode property.

Declaration
public static DependencyProperty AnnotationRelativeModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

ConstraintsProperty

Provides information about the Constraints property.

Declaration
public static DependencyProperty ConstraintsProperty
Field Value
Type Description
System.Windows.DependencyProperty

ContentProperty

Provides information about the Content property.

Declaration
public static DependencyProperty ContentProperty
Field Value
Type Description
System.Windows.DependencyProperty

DisplacementProperty

Provides information about the Displacement property.

Declaration
public static readonly DependencyProperty DisplacementProperty
Field Value
Type Description
System.Windows.DependencyProperty

DragLimitProperty

Provides information about the DragLimit property.

Declaration
public static DependencyProperty DragLimitProperty
Field Value
Type Description
System.Windows.DependencyProperty

EditTemplateProperty

Provides information about the EditTemplate property.

Declaration
public static DependencyProperty EditTemplateProperty
Field Value
Type Description
System.Windows.DependencyProperty

IDProperty

Provides information about the ID property.

Declaration
public static DependencyProperty IDProperty
Field Value
Type Description
System.Windows.DependencyProperty

KeyProperty

Provides information about the Key property.

Declaration
public static DependencyProperty KeyProperty
Field Value
Type Description
System.Windows.DependencyProperty

LabelWidthProperty

Provides information about the LabelWidth property.

Declaration
public static DependencyProperty LabelWidthProperty
Field Value
Type Description
System.Windows.DependencyProperty

LengthProperty

Provides information about the Length property.

Declaration
public static readonly DependencyProperty LengthProperty
Field Value
Type Description
System.Windows.DependencyProperty

MarginProperty

Provides information about the Margin property.

Declaration
public static DependencyProperty MarginProperty
Field Value
Type Description
System.Windows.DependencyProperty

ModeProperty

Provides information about the Mode property.

Declaration
public static DependencyProperty ModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

OffsetProperty

Provides information about the Offset property.

Declaration
public static DependencyProperty OffsetProperty
Field Value
Type Description
System.Windows.DependencyProperty

PivotProperty

Declaration
public static readonly DependencyProperty PivotProperty
Field Value
Type Description
System.Windows.DependencyProperty

ReadOnlyProperty

Provides information about the ReadOnly property.

Declaration
public static DependencyProperty ReadOnlyProperty
Field Value
Type Description
System.Windows.DependencyProperty

RotateAngleProperty

Provides information about the RotateAngle property.

Declaration
public static DependencyProperty RotateAngleProperty
Field Value
Type Description
System.Windows.DependencyProperty

RotationReferenceProperty

Provides information about the RotationReference property.

Declaration
public static DependencyProperty RotationReferenceProperty
Field Value
Type Description
System.Windows.DependencyProperty

TextAlignmentProperty

Provides information about the TextAlignment property.

Declaration
public static DependencyProperty TextAlignmentProperty
Field Value
Type Description
System.Windows.DependencyProperty

TextHorizontalAlignmentProperty

Provides information about the TextHorizontalAlignment property.

Declaration
public static DependencyProperty TextHorizontalAlignmentProperty
Field Value
Type Description
System.Windows.DependencyProperty

TextVerticalAlignmentProperty

Provides information about the TextVerticalAlignment property.

Declaration
public static DependencyProperty TextVerticalAlignmentProperty
Field Value
Type Description
System.Windows.DependencyProperty

UnitHeightProperty

Provides information about the UnitHeight property.

Declaration
public static DependencyProperty UnitHeightProperty
Field Value
Type Description
System.Windows.DependencyProperty

UnitWidthProperty

Provides information about the UnitWidth property.

Declaration
public static DependencyProperty UnitWidthProperty
Field Value
Type Description
System.Windows.DependencyProperty

ViewTemplateProperty

Provides information about the ViewTemplate property.

Declaration
public static DependencyProperty ViewTemplateProperty
Field Value
Type Description
System.Windows.DependencyProperty

WrapTextProperty

Provides information about the WrapText property.

Declaration
public static DependencyProperty WrapTextProperty
Field Value
Type Description
System.Windows.DependencyProperty

Properties

AnnotationRelativeMode

Gets or sets relative mode value of the annotation.

Declaration
public AnnotationRelativeMode AnnotationRelativeMode { get; set; }
Property Value
Type Description
AnnotationRelativeMode

BoundingRectangle

Gets or sets the bounding rectangle of the AnnotationEditor.

Declaration
public Rect BoundingRectangle { get; }
Property Value
Type Description
System.Windows.Rect

Constraints

Gets or sets constriants value of the annotation.

Declaration
public AnnotationConstraints Constraints { get; set; }
Property Value
Type Description
AnnotationConstraints

Content

Gets or sets the content value of the annotation.

Declaration
public object Content { get; set; }
Property Value
Type Description
System.Object

Displacement

Gets or sets displacement value of the annotation. It will maintain the annotation's position at constant distance form origin.

Declaration
public double Displacement { get; set; }
Property Value
Type Description
System.Double

DragLimit

Gets or sets drag limit value of the annotation. Annotation can be dragged within drag limit value.

Declaration
public Thickness DragLimit { get; set; }
Property Value
Type Description
System.Windows.Thickness

EditTemplate

Gets or sets edit template value of the annotation.

Declaration
public DataTemplate EditTemplate { get; set; }
Property Value
Type Description
System.Windows.DataTemplate

ID

Gets or sets ID value of the annotation.

Declaration
public object ID { get; set; }
Property Value
Type Description
System.Object

Key

Gets or sets key value of the annotation.

Declaration
public object Key { get; set; }
Property Value
Type Description
System.Object

LabelWidth

Gets or sets the width value of the annotation's label.

Declaration
public double LabelWidth { get; set; }
Property Value
Type Description
System.Double

Length

Gets or sets length value of the annotation.

Declaration
public double Length { get; set; }
Property Value
Type Description
System.Double

Margin

Gets or sets margin value of the annotation.

Declaration
public Thickness Margin { get; set; }
Property Value
Type Description
System.Windows.Thickness

Mode

Gets or sets the content editing mode value of the Annotation.

Declaration
public ContentEditorMode Mode { get; set; }
Property Value
Type Description
ContentEditorMode

Offset

Gets or sets offset value of the annotation. It is position of the annotation on Node or Connector.

Declaration
public Point Offset { get; set; }
Property Value
Type Description
System.Windows.Point

Pivot

Gets or sets pivot point value of the annotation.

Declaration
public Point Pivot { get; set; }
Property Value
Type Description
System.Windows.Point

ReadOnly

Gets or sets a value indicating whether the annotation can be edit or not.

Declaration
public bool ReadOnly { get; set; }
Property Value
Type Description
System.Boolean

RotateAngle

Gets or sets a rotating anlge value of the annotation.

Declaration
public double RotateAngle { get; set; }
Property Value
Type Description
System.Double

RotationReference

Gets or sets a rotation reference value of the annotation.

Declaration
public RotationReference RotationReference { get; set; }
Property Value
Type Description
RotationReference

TextAlignment

Gets or sets the alignment value of the annotation.

Declaration
public TextAlignment TextAlignment { get; set; }
Property Value
Type Description
System.Windows.TextAlignment

TextHorizontalAlignment

Gets or sets the horizontal alignment value of the Annotation.

Declaration
public TextAlignment TextHorizontalAlignment { get; set; }
Property Value
Type Description
System.Windows.TextAlignment

TextVerticalAlignment

Gets or sets the vertical alignment of the Annotation.

Declaration
public VerticalAlignment TextVerticalAlignment { get; set; }
Property Value
Type Description
System.Windows.VerticalAlignment

UnitHeight

Gets or sets the height value of the Annotation.

Declaration
public double UnitHeight { get; set; }
Property Value
Type Description
System.Double

UnitWidth

Gets or sets a unit width value of the annotation.

Declaration
public double UnitWidth { get; set; }
Property Value
Type Description
System.Double

ViewTemplate

Gets or sets the view template value of the annotation.

Declaration
public DataTemplate ViewTemplate { get; set; }
Property Value
Type Description
System.Windows.DataTemplate

WrapText

Gets or sets the text wrapping value of the annotation.

Declaration
public TextWrapping WrapText { get; set; }
Property Value
Type Description
System.Windows.TextWrapping

Methods

ArrangeOverride(Size)

Overridden to arrange the size of the annotation.

Declaration
protected override Size ArrangeOverride(Size finalSize)
Parameters
Type Name Description
System.Windows.Size finalSize

The size that the elements are going to be arrnanged.
Returns
Type Description
System.Windows.Size

Returns the size of the annotation.

CloseEditing()

Represents a virtual method that used to change the mode of annotation to view from edit that hides the editing process.

Declaration
protected virtual void CloseEditing()

GetNode(FrameworkElement)

To get parent element of the annotation.

Declaration
public object GetNode(FrameworkElement element)
Parameters
Type Name Description
System.Windows.FrameworkElement element

The framework element value.
Returns
Type Description
System.Object

Returns node, if the parent element of annotation is Node; otherwise, returns Connector.

MeasureOverride(Size)

Overridden to remeasure the annotation.

Declaration
protected override Size MeasureOverride(Size availableSize)
Parameters
Type Name Description
System.Windows.Size availableSize

The size that annotation can be measure.
Returns
Type Description
System.Windows.Size

Returns the size of the annotation.

OnApplyTemplate()

Overridden to apply templates to the annotation.

Declaration
public override void OnApplyTemplate()

OnPropertyChanged(String)

Represents a virtual method which invokes to change the value of given property.

Declaration
protected virtual void OnPropertyChanged(string property)
Parameters
Type Name Description
System.String property

The Name of the property.

StartEditing()

Represents a virtual method that used to change the mode of annotation to edit from view that start shows the editing.

Declaration
protected virtual void StartEditing()

Events

PropertyChanged

Represents an event which occurs when annotation's property has changed.

Declaration
public event PropertyChangedEventHandler PropertyChanged
Event Type
Type Description
System.ComponentModel.PropertyChangedEventHandler

Implements

IID
System.ComponentModel.INotifyPropertyChanged

Extension Methods