Class Section

Namespace

C4.Net.Documentation

Assembly

C4.Net.Core.dll

Represents a single documentation section attached to the workspace or a model element.

[DataContract]
public sealed class Section

Inheritance

object

Section

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Content

Contains the section body in the configured markup format.

[DataMember(Name = "content", EmitDefaultValue = false)]
public string Content { get; }

Property Value

string

Element

References the model element that owns this section, when the section is element-specific.

public Element Element { get; }

Property Value

Element

ElementId

The ID of the element.

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

Property Value

string

Format

Identifies the markup format used by Content.

[DataMember(Name = "format", EmitDefaultValue = true)]
public Format Format { get; }

Property Value

Format

Order

Defines the display order of the section.

[DataMember(Name = "order", EmitDefaultValue = true)]
public int Order { get; }

Property Value

int

Title

Provides the section title shown in documentation navigation.

[DataMember(Name = "title", EmitDefaultValue = true)]
public string Title { get; }

Property Value

string

Methods

Equals(Section)

Determines whether another section has the same scope and title.

public bool Equals(Section section)

Parameters

section Section

The section to compare with this instance.

Returns

bool

true when both sections refer to the same element scope and title; otherwise, false.

Equals(object)

Determines whether another object represents the same documentation section.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with this instance.

Returns

bool

true when obj is an equivalent Section; otherwise, false.

GetHashCode()

Computes a hash code from the scoped section title.

public override int GetHashCode()

Returns

int

A hash code suitable for section set membership.