Class RelationshipStyle

Namespace

C4.Net

Assembly

C4.Net.Core.dll

A definition of a relationship style.

[DataContract]
public sealed class RelationshipStyle

Inheritance

object

RelationshipStyle

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

RelationshipStyle(string)

Creates a relationship style for the supplied tag.

public RelationshipStyle(string tag)

Parameters

tag string

The tag this style applies to.

Properties

Color

The colour of the line, as a HTML RGB hex string (e.g. #123456)

[DataMember(Name = "color", EmitDefaultValue = false)]
public string Color { get; set; }

Property Value

string

Exceptions

ArgumentException

Thrown when the value is not a valid hexadecimal color code.

Dashed

A flag to indicate whether the line is rendered as dashed or not.

[DataMember(Name = "dashed", EmitDefaultValue = false)]
public bool? Dashed { get; set; }

Property Value

bool?

A flag to indicate whether the line is rendered as dashed or not.

FontSize

The standard font size used to render the relationship annotation, in pixels.

[DataMember(Name = "fontSize", EmitDefaultValue = false)]
public int? FontSize { get; set; }

Property Value

int?

Opacity

The opacity of the line/text; 0 to 100.

[DataMember(Name = "opacity", EmitDefaultValue = false)]
public int? Opacity { get; set; }

Property Value

int?

Position

The position of the annotation along the line; 0 (start) to 100 (end).

[DataMember(Name = "position", EmitDefaultValue = false)]
public int? Position { get; set; }

Property Value

int?

Routing

The routing of the line.

[DataMember(Name = "routing", EmitDefaultValue = false)]
public Routing? Routing { get; set; }

Property Value

Routing?

Tag

The tag to which this relationship style applies.

[DataMember(Name = "tag", EmitDefaultValue = false)]
public string Tag { get; set; }

Property Value

string

Thickness

The thickness of the line, in pixels.

[DataMember(Name = "thickness", EmitDefaultValue = false)]
public int? Thickness { get; set; }

Property Value

int?

Width

The width of the relationship annotation, in pixels.

[DataMember(Name = "width", EmitDefaultValue = false)]
public int? Width { get; set; }

Property Value

int?