Class SwimlaneHeader

Represents a Header element for ISwimlane or IPhase or ILane elements.

Inheritance

System.Object

SwimlaneHeader

Implements

System.IDisposable

ISwimlaneHeader

ISwimlaneChild

IGroupable

IDiagramElement

IID

System.ComponentModel.INotifyPropertyChanged

Namespace: Syncfusion.UI.Xaml.Diagram

Assembly: Syncfusion.SfDiagram.WPF.dll

Syntax

public class SwimlaneHeader : Control, ISwimlaneHeaderView, IView, ISharedData, IDisposable, ISwimlaneHeader, ISwimlaneChild, IGroupable, IDiagramElement, IID, INotifyPropertyChanged

Constructors

SwimlaneHeader()

Creaets a new instance of SwimlaneHeader class.

Declaration

public SwimlaneHeader()

Fields

AnnotationProperty

Using a DependencyProperty as the backing store for Annotation. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty AnnotationProperty

Field Value

Type
System.Windows.DependencyProperty

IDProperty

Using a DependencyProperty as the backing store for ID. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty IDProperty

Field Value

Type
System.Windows.DependencyProperty

IsLaneHeaderProperty

Using a DependencyProperty as the backing store for IsPhaseHeader. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty IsLaneHeaderProperty

Field Value

Type
System.Windows.DependencyProperty

IsPhaseHeaderProperty

Using a DependencyProperty as the backing store for IsPhaseHeader. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty IsPhaseHeaderProperty

Field Value

Type
System.Windows.DependencyProperty

IsSelectedProperty

Using a DependencyProperty as the backing store for IsSelected. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty IsSelectedProperty

Field Value

Type
System.Windows.DependencyProperty

KeyProperty

Using a DependencyProperty as the backing store for Key. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty KeyProperty

Field Value

Type
System.Windows.DependencyProperty

SearchTagsProperty

Identifies the SearchTags dependency property.

Declaration

public static DependencyProperty SearchTagsProperty

Field Value

Type
System.Windows.DependencyProperty

ShapeStyleProperty

Using a DependencyProperty as the backing store for Style. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty ShapeStyleProperty

Field Value

Type
System.Windows.DependencyProperty

UnitHeightProperty

Using a DependencyProperty as the backing store for UnitHeight. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty UnitHeightProperty

Field Value

Type
System.Windows.DependencyProperty

UnitWidthProperty

Using a DependencyProperty as the backing store for UnitWidth. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty UnitWidthProperty

Field Value

Type
System.Windows.DependencyProperty

ZIndexProperty

Using a DependencyProperty as the backing store for ZIndex. This enables animation, styling, binding, etc...

Declaration

public static DependencyProperty ZIndexProperty

Field Value

Type
System.Windows.DependencyProperty

Properties

Annotation

Represent a block of text that can be displayed over a Header of ISwimlane, IPhase and ILane.

Declaration

public IAnnotation Annotation { get; set; }

Property Value

Type
IAnnotation

BoundingRectangle

Gets or sets the bounding rectangle of the AnnotationEditor.

Declaration

public Rect BoundingRectangle { get; }

Property Value

Type
System.Windows.Rect

ID

Gets or sets the id of the header.

Declaration

public object ID { get; set; }

Property Value

Type
System.Object

Info

Gets or sets info value of SwimlaneHeader class.

Declaration

public object Info { get; set; }

Property Value

Type
System.Object

IsLaneHeader

Using a DependencyProperty to check whether header is child of lane or not

Declaration

public bool IsLaneHeader { get; set; }

Property Value

Type
System.Boolean

IsPhaseHeader

Using a DependencyProperty to check whether header is child of phase or not.

Declaration

public bool IsPhaseHeader { get; set; }

Property Value

Type
System.Boolean

IsSelected

Gets or sets a value indicates whether the header is selected. The default value is set to false.

Declaration

public bool IsSelected { get; set; }

Property Value

Type
System.Boolean

Key

Gets or sets the key of the header.

Declaration

public object Key { get; set; }

Property Value

Type
System.Object

SearchTags

Gets or sets the search tags of the SwimlaneHeader in the Syncfusion.UI.Xaml.Diagram.Stencil.

Declaration

public IEnumerable<string> SearchTags { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<System.String>	The list of search tags that are used when you search for the symbol in the Syncfusion.UI.Xaml.Diagram.Stencil. The default is null.

ShapeStyle

Gets or sets the shapestyle of the header.

Declaration

public Style ShapeStyle { get; set; }

Property Value

Type
System.Windows.Style

UnitHeight

Gets or sets the height of the header.

Declaration

public double UnitHeight { get; set; }

Property Value

Type
System.Double

UnitWidth

Gets or sets the width of the header.

Declaration

public double UnitWidth { get; set; }

Property Value

Type
System.Double

ZIndex

Gets or sets the z-index of the Header.

Declaration

public int ZIndex { get; set; }

Property Value

Type
System.Int32

Methods

ArrangeOverride(Size)

Method to arrange SwimlaneHeader class elements to given size.

Declaration

protected override Size ArrangeOverride(Size finalSize)

Parameters

Type	Name	Description
System.Windows.Size	finalSize	Size to arrange elements.

Returns

Type	Description
System.Windows.Size	Return size.

MeasureOverride(Size)

Method to measure size of SwimlaneHeader class elements.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
System.Windows.Size	availableSize	Size to be measure.

Returns

Type	Description
System.Windows.Size	Return measured size.

OnApplyTemplate()

Method to appl template value to SwimlaneHeader class elements.

Declaration

public override void OnApplyTemplate()

OnCreateAutomationPeer()

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Type
System.Windows.Automation.Peers.AutomationPeer

OnPropertyChanged(String)

Method for property values are changed for SwimlaneHeader class.

Declaration

protected virtual void OnPropertyChanged(string name)

Parameters

Type	Name	Description
System.String	name	Property name.

Events

PropertyChanged

Event to notify when property values are changed for SwimlaneHeader class.

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Type

Type
System.ComponentModel.PropertyChangedEventHandler

Implements

System.IDisposable

ISwimlaneHeader

ISwimlaneChild

IGroupable

IDiagramElement

IID

System.ComponentModel.INotifyPropertyChanged