Class RadDiagramItem

Abstract base implementation of the IDiagramItem interface.

Inheritance
System.Object
RadDiagramItem
RadDiagramShapeBase
RadDiagramConnection
Namespace: Telerik.Windows.Controls.Diagrams
Assembly: Telerik.Windows.Controls.Diagrams.dll

Syntax

public abstract class RadDiagramItem : ContentControl, IDiagramItem, ISerializable, ISupportMouseOver, IPropertyChanged, IGroupable, ISupportManipulation, ISupportVirtualization, IContainerChild, ICollapsible

Constructors

RadDiagramItem()

Initializes a new instance of the RadDiagramItem class.

Declaration
protected RadDiagramItem()

Fields

AllowCopyProperty

Identifies the AllowCopy dependency property.

Declaration
public static readonly DependencyProperty AllowCopyProperty
Field Value
System.Windows.DependencyProperty

AllowCutProperty

Identifies the AllowCut dependency property.

Declaration
public static readonly DependencyProperty AllowCutProperty
Field Value
System.Windows.DependencyProperty

AllowDeleteProperty

Identifies the AllowDelete dependency property.

Declaration
public static readonly DependencyProperty AllowDeleteProperty
Field Value
System.Windows.DependencyProperty

AllowPasteProperty

Identifies the AllowPaste dependency property.

Declaration
public static readonly DependencyProperty AllowPasteProperty
Field Value
System.Windows.DependencyProperty

BeginEditEvent

Identifies the BeginEdit routed event.

Declaration
public static readonly RoutedEvent BeginEditEvent
Field Value
RoutedEvent

EditTemplateProperty

Identifies the EditTemplate dependency property.

Declaration
public static readonly DependencyProperty EditTemplateProperty
Field Value
System.Windows.DependencyProperty

EndEditEvent

Identifies the EndEdit routed event.

Declaration
public static readonly RoutedEvent EndEditEvent
Field Value
RoutedEvent

GroupProperty

Identifies the Group dependency property.

Declaration
public static readonly DependencyProperty GroupProperty
Field Value
System.Windows.DependencyProperty

IsConnectorsManipulationEnabledProperty

Identifies the IsConnectorsManipulationEnabled dependency property.

Declaration
public static readonly DependencyProperty IsConnectorsManipulationEnabledProperty
Field Value
System.Windows.DependencyProperty

IsDraggingEnabledProperty

Identifies the IsDraggingEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDraggingEnabledProperty
Field Value
System.Windows.DependencyProperty

IsEditableProperty

Identifies the IsEditable dependency property.

Declaration
public static readonly DependencyProperty IsEditableProperty
Field Value
System.Windows.DependencyProperty

IsInEditModeProperty

Identifies the IsInEditMode dependency property.

Declaration
public static readonly DependencyProperty IsInEditModeProperty
Field Value
System.Windows.DependencyProperty

IsManipulationAdornerVisibleProperty

Identifies the IsManipulationAdornerVisible dependency property.

Declaration
public static readonly DependencyProperty IsManipulationAdornerVisibleProperty
Field Value
System.Windows.DependencyProperty

IsResizingEnabledProperty

Identifies the IsResizingEnabled dependency property.

Declaration
public static readonly DependencyProperty IsResizingEnabledProperty
Field Value
System.Windows.DependencyProperty

IsRotationEnabledProperty

Identifies the IsRotationEnabled dependency property.

Declaration
public static readonly DependencyProperty IsRotationEnabledProperty
Field Value
System.Windows.DependencyProperty

IsSelectedProperty

Identifies the IsSelected dependency property.

Declaration
public static readonly DependencyProperty IsSelectedProperty
Field Value
System.Windows.DependencyProperty

PositionProperty

Identifies the Position dependency property.

Declaration
public static readonly DependencyProperty PositionProperty
Field Value
System.Windows.DependencyProperty

PreviewBeginEditEvent

Identifies the PreviewBeginEdit routed event.

Declaration
public static readonly RoutedEvent PreviewBeginEditEvent
Field Value
RoutedEvent

PreviewEndEditEvent

Identifies the PreviewEndEdit routed event.

Declaration
public static readonly RoutedEvent PreviewEndEditEvent
Field Value
RoutedEvent

StrokeDashArrayProperty

Identifies the StrokeDashArray dependency property.

Declaration
public static readonly DependencyProperty StrokeDashArrayProperty
Field Value
System.Windows.DependencyProperty

StrokeProperty

Identifies the Stroke dependency property.

Declaration
public static readonly DependencyProperty StrokeProperty
Field Value
System.Windows.DependencyProperty

StrokeThicknessProperty

Identifies the StrokeThickness dependency property.

Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
System.Windows.DependencyProperty

ZIndexProperty

Identifies the ZIndex dependency property.

Declaration
public static readonly DependencyProperty ZIndexProperty
Field Value
System.Windows.DependencyProperty

Properties

ActualSize

The actual size of the item.

Declaration
protected virtual Size ActualSize { get; }
Property Value
System.Windows.Size

AllowCopy

Gets or sets a value indicating whether copying is allowed.

Declaration
public bool AllowCopy { get; set; }
Property Value
System.Boolean

True if copying is allowed; otherwise, false.
Implements

AllowCut

Gets or sets a value indicating whether cutting is allowed.

Declaration
public bool AllowCut { get; set; }
Property Value
System.Boolean

True if cutting is allowed; otherwise, false.
Implements

AllowDelete

Gets or sets a value indicating whether deleting is allowed.

Declaration
public bool AllowDelete { get; set; }
Property Value
System.Boolean

True if deleting is allowed; otherwise, false.
Implements

AllowPaste

Gets or sets a value indicating whether pasting is allowed.

Declaration
public bool AllowPaste { get; set; }
Property Value
System.Boolean

True if pasting is allowed; otherwise, false.
Implements

Bounds

Gets the bounds.

Declaration
public virtual Rect Bounds { get; }
Property Value
System.Windows.Rect

The bounds.
Implements

Diagram

Gets the owning diagram of this instance.

Declaration
protected IGraphInternal Diagram { get; }
Property Value
IGraphInternal

EditTemplate

Gets or sets the edit template.

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

The edit template.

Id

Gets the unique identifier of this entity.

Declaration
public string Id { get; }
Property Value
System.String

An identifier for this entity.
Implements

IsConnectorsManipulationEnabled

Gets or sets a value indicating whether manipulation on the connectors is enabled.

Declaration
public bool IsConnectorsManipulationEnabled { get; set; }
Property Value
System.Boolean

True if manipulation on connectors is enabled; otherwise, false.
Implements

IsDraggingEnabled

Gets or sets a value indicating whether dragging is enabled.

Declaration
public bool IsDraggingEnabled { get; set; }
Property Value
System.Boolean

True if dragging is enabled; otherwise, false.
Implements

IsDynamic

Gets or sets whether this item is dynamically generated.

Declaration
public bool IsDynamic { get; set; }
Property Value
System.Boolean

If true then this item will not be serialized as part of the diagram.
Implements
Remarks

In some applications or embeddings of RadDiagram (e.g. workflows) there are shapes or connections which are generated as part of some layout or organization. In those cases it doesn't make sense to serialize the elements which are automatically generated as part of the application. By setting this property to true the serialization pipeline will omit the element.

IsEditable

Gets or sets a value indicating whether editing is enabled on this item.

Declaration
public bool IsEditable { get; set; }
Property Value
System.Boolean

True if editing is enabled; otherwise, false.
Implements
Remarks

Note that the similar higher-level IsEditable can potentially overrule this setting.

IsInEditMode

Gets or sets a value indicating whether this instance is in edit mode.

Declaration
public bool IsInEditMode { get; set; }
Property Value
System.Boolean

True if this instance is in edit mode; otherwise, false.
Implements

IsManipulationAdornerVisible

Gets or sets a value indicating whether the manipulation adorner is visible.

Declaration
public bool IsManipulationAdornerVisible { get; set; }
Property Value
System.Boolean

True if the manipulation adorner is visible; otherwise, false.
Implements

IsMouseOver

Gets a value indicating whether this instance is mouse over.

Declaration
public bool IsMouseOver { get; protected set; }
Property Value
System.Boolean

True if this instance is mouse over; otherwise, false.
Implements

IsResizingEnabled

Gets or sets a value indicating whether resizing is enabled.

Declaration
public bool IsResizingEnabled { get; set; }
Property Value
System.Boolean

True if resizing is enabled; otherwise, false.
Implements

IsRotationEnabled

Gets or sets a value indicating whether rotation is enabled.

Declaration
public bool IsRotationEnabled { get; set; }
Property Value
System.Boolean

true if this rotation is enabled; otherwise, false.
Implements

IsSelected

Gets or sets whether the diagram entity is selected.

Declaration
public bool IsSelected { get; set; }
Property Value
System.Boolean

True if selected; otherwise, false.
Implements

IsSelectedInGroup

Gets a value indicating whether this instance is selected in group.

Declaration
protected bool IsSelectedInGroup { get; set; }
Property Value
System.Boolean

True if this item is selected in group; otherwise, false.

IsServiceManipulation

Gets whether any service is manipulating at the moment.

Declaration
protected bool IsServiceManipulation { get; }
Property Value
System.Boolean

ParentContainer

Gets the parent container shape.

Declaration
public IContainerShape ParentContainer { get; }
Property Value
IContainerShape

The parent container.
Implements

ParentGroup

Gets or sets the group.

Declaration
public IGroup ParentGroup { get; set; }
Property Value
IGroup

The group.
Implements

Position

Gets or sets the position of the top left corner of the bounding rectangle of the item.

Declaration
public Point Position { get; set; }
Property Value
System.Windows.Point

Implements

ServiceLocator

Gets the service locator.

Declaration
protected IGraphServiceLocator ServiceLocator { get; }
Property Value
IGraphServiceLocator

Services

Gets the diagram's services.

Declaration
protected IGraphServiceLocator Services { get; }
Property Value
IGraphServiceLocator

Stroke

Gets or sets the stroke of this item.

Declaration
public Brush Stroke { get; set; }
Property Value
System.Windows.Media.Brush

The stroke.

StrokeDashArray

Gets or sets the stroke dash array of this item.

Declaration
public DoubleCollection StrokeDashArray { get; set; }
Property Value
System.Windows.Media.DoubleCollection

The stroke dash array.

StrokeThickness

Gets or sets the stroke thickness of this item.

Declaration
public double StrokeThickness { get; set; }
Property Value
System.Double

The stroke thickness.

X

Gets or sets the horizontal position of this item.

Declaration
public double X { get; set; }
Property Value
System.Double

The x-coordinate.

Y

Gets or sets the vertical position of this item.

Declaration
public double Y { get; set; }
Property Value
System.Double

The y-coordinate.

ZIndex

Gets or sets the ZIndex of this instance.

Declaration
public int ZIndex { get; set; }
Property Value
System.Int32

Implements

Methods

add_BeginEdit(RadRoutedEventHandler)

Declaration
public void add_BeginEdit(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler value

add_PreviewBeginEdit(RadRoutedEventHandler)

Declaration
public void add_PreviewBeginEdit(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler value

Deserialize(SerializationInfo)

Deserializes the serialization info in this diagram entity.

Declaration
public virtual void Deserialize(SerializationInfo info)
Parameters
SerializationInfo info

A SerializationInfo instance.
Implements

Initialize(IGraphServiceLocator, IGraphInternal)

Initializes the specified service locator and parent graph.

Declaration
protected virtual void Initialize(IGraphServiceLocator serviceLocator, IGraphInternal graph)
Parameters
IGraphServiceLocator serviceLocator

The service locator.
IGraphInternal graph

The diagram control.

OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks.

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Creates a Telerik.Windows.Controls.Diagrams.AutomationPeers.RadDiagramAutomationPeer peer associated with this object.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

An instance of the Telerik.Windows.Controls.Diagrams.AutomationPeers.RadDiagramAutomationPeer.

OnGroupNameChanged()

Called when the group name changes.

Declaration
protected virtual void OnGroupNameChanged()

OnIsConnectorsManipulationEnabledChanged(Boolean, Boolean)

Called when connectors manipulation changes.

Declaration
protected virtual void OnIsConnectorsManipulationEnabledChanged(bool newValue, bool oldValue)
Parameters
System.Boolean newValue

The new value.
System.Boolean oldValue

The old value.

OnIsEditableChanged(Boolean, Boolean)

Called when IsEditable has changed.

Declaration
protected virtual void OnIsEditableChanged(bool oldIsEditable, bool isEditable)
Parameters
System.Boolean oldIsEditable

The old value of the property.
System.Boolean isEditable

The current value of the property.

OnIsInEditModeChanged(Boolean, Boolean)

Called when IsInEditMode changes.

Declaration
protected virtual void OnIsInEditModeChanged(bool oldIsInEditMode, bool isInEditMode)
Parameters
System.Boolean oldIsInEditMode

The old value of the property.
System.Boolean isInEditMode

The current value of the property.

OnIsSelectedChanged(Boolean, Boolean)

Called when the IsSelected property has changed.

Declaration
protected virtual void OnIsSelectedChanged(bool oldValue, bool newValue)
Parameters
System.Boolean oldValue

The old value of the IsSelected property.
System.Boolean newValue

The new value of the IsSelected property.

OnMouseEnter(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseEnter attached event is raised on this element. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseEnter(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseLeave(MouseEventArgs)

Invoked when an unhandled System.Windows.Input.Mouse.MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.

Declaration
protected override void OnMouseLeave(MouseEventArgs e)
Parameters
System.Windows.Input.MouseEventArgs e

The System.Windows.Input.MouseEventArgs that contains the event data.

OnMouseLeftButtonDown(MouseButtonEventArgs)

Called before the System.Windows.UIElement.MouseLeftButtonDown event occurs.

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The data for the event.

OnMouseLeftButtonUp(MouseButtonEventArgs)

Called before the System.Windows.UIElement.MouseLeftButtonUp event occurs.

Declaration
protected override void OnMouseLeftButtonUp(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

The data for the event.

OnPositionChanged(Point, Point)

Called when position changes.

Declaration
protected virtual void OnPositionChanged(Point oldPosition, Point newPosition)
Parameters
System.Windows.Point oldPosition

The old position.
System.Windows.Point newPosition

The new position.

OnPositionCoerced(Point)

Called when [position coerced].

Declaration
protected virtual object OnPositionCoerced(Point position)
Parameters
System.Windows.Point position

The position.
Returns
System.Object

OnPropertyChanged(String)

Called when a property value changed.

Declaration
protected virtual void OnPropertyChanged(string propertyName)
Parameters
System.String propertyName

Name of the property.

OnSizeChanged(Size, Size)

Called when the size changes.

Declaration
protected virtual void OnSizeChanged(Size newSize, Size oldSize)
Parameters
System.Windows.Size newSize

The new size.
System.Windows.Size oldSize

The old size.

OnStrokeThicknessChanged()

Invoked when the StrokeThickness property has changed.

Declaration
protected virtual void OnStrokeThicknessChanged()

OnZIndexChanged(Int32)

Called when the ZIndex changes.

Declaration
protected virtual void OnZIndexChanged(int newValue)
Parameters
System.Int32 newValue

The new value.

OnZIndexChanged(Int32, Int32)

Called when the ZIndex changes.

Declaration
protected virtual void OnZIndexChanged(int newValue, int oldValue)
Parameters
System.Int32 newValue

The new value.
System.Int32 oldValue

The old value.

RefreshIsSelectedInGroup()

Refreshes the is selected in group property.

Declaration
protected virtual void RefreshIsSelectedInGroup()

remove_BeginEdit(RadRoutedEventHandler)

Declaration
public void remove_BeginEdit(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler value

remove_PreviewBeginEdit(RadRoutedEventHandler)

Declaration
public void remove_PreviewBeginEdit(RadRoutedEventHandler value)
Parameters
RadRoutedEventHandler value

Serialize()

Serializes this instance.

Declaration
public virtual SerializationInfo Serialize()
Returns
SerializationInfo

Implements

UpdateVisualStates()

Updates the visual states.

Declaration
protected virtual void UpdateVisualStates()

Events

BeginEdit

Occurs when the editing begins.

Declaration
public event RadRoutedEventHandler BeginEdit
Event Type
RadRoutedEventHandler

EndEdit

Occurs when the editing ends.

Declaration
public event EventHandler<RadRoutedEditEventArgs> EndEdit
Event Type
System.EventHandler<RadRoutedEditEventArgs>

ParentGroupChanged

Occurs when [group changed].

Declaration
public event EventHandler<PropertyEventArgs<IGroup>> ParentGroupChanged
Event Type
System.EventHandler<PropertyEventArgs<IGroup>>

Implements

PreviewBeginEdit

Occurs before the editing starts.

Declaration
public event RadRoutedEventHandler PreviewBeginEdit
Event Type
RadRoutedEventHandler

PreviewEndEdit

Occurs before the editing ends.

Declaration
public event EventHandler<RadRoutedEditEventArgs> PreviewEndEdit
Event Type
System.EventHandler<RadRoutedEditEventArgs>

PropertyChanged

Occurs when a property value changes.

Declaration
public event EventHandler<PropertyEventArgs> PropertyChanged
Event Type
System.EventHandler<PropertyEventArgs>

Implements

Explicit Interface Implementations

ICollapsible.IsCollapsed

Gets or sets a value indicating whether this item is collapsed.

Declaration
bool ICollapsible.IsCollapsed { get; set; }
Returns
System.Boolean

Implements

IDiagramItem.get_Content()

Declaration
object IDiagramItem.get_Content()
Returns
System.Object

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.get_Content()

IDiagramItem.get_IsEnabled()

Declaration
bool IDiagramItem.get_IsEnabled()
Returns
System.Boolean

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.get_IsEnabled()

IDiagramItem.get_Name()

Declaration
string IDiagramItem.get_Name()
Returns
System.String

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.get_Name()

IDiagramItem.get_RenderTransformOrigin()

Declaration
Point IDiagramItem.get_RenderTransformOrigin()
Returns
System.Windows.Point

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.get_RenderTransformOrigin()

IDiagramItem.get_Visibility()

Declaration
Visibility IDiagramItem.get_Visibility()
Returns
System.Windows.Visibility

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.get_Visibility()

IDiagramItem.Initialize(IGraphServiceLocator, IGraphInternal)

Initializes the specified service locator.

Declaration
void IDiagramItem.Initialize(IGraphServiceLocator serviceLocator, IGraphInternal graph)
Parameters
IGraphServiceLocator serviceLocator

The service locator.
IGraphInternal graph

The diagram.
Implements

IDiagramItem.set_Content(Object)

Declaration
void IDiagramItem.set_Content(object value)
Parameters
System.Object value

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.set_Content(System.Object)

IDiagramItem.set_IsEnabled(Boolean)

Declaration
void IDiagramItem.set_IsEnabled(bool value)
Parameters
System.Boolean value

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.set_IsEnabled(System.Boolean)

IDiagramItem.set_Name(String)

Declaration
void IDiagramItem.set_Name(string value)
Parameters
System.String value

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.set_Name(System.String)

IDiagramItem.set_RenderTransformOrigin(Point)

Declaration
void IDiagramItem.set_RenderTransformOrigin(Point value)
Parameters
System.Windows.Point value

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.set_RenderTransformOrigin(System.Windows.Point)

IDiagramItem.set_Visibility(Visibility)

Declaration
void IDiagramItem.set_Visibility(Visibility value)
Parameters
System.Windows.Visibility value

Implements
Telerik.Windows.Diagrams.Core.IDiagramItem.set_Visibility(System.Windows.Visibility)

ISupportVirtualization.VirtualizationState

Get a value indicating item state regarding virtualization.

Declaration
ItemVisibility ISupportVirtualization.VirtualizationState { get; set; }
Returns
ItemVisibility

Implements

Extension Methods