Class Document

Namespace

Songhay.Publications.Models

Assembly

Songhay.Publications.dll

Publications Document.

public class Document : IDocument, ITemporal

Inheritance

object

Document

Implements

IDocument

ITemporal

Derived

SearchIndexEntry

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Extension Methods

IDocumentExtensions.Clone(IDocument?)

IDocumentExtensions.HasFragments(IDocument?)

IDocumentExtensions.IsTemplatable(IDocument?)

IDocumentExtensions.SetDefaults(IDocument?)

IDocumentExtensions.ToConventionalPublicationItem(IDocument?, string?)

IDocumentExtensions.ToDisplayText(IDocument?)

IDocumentExtensions.ToDisplayText(IDocument?, bool)

IDocumentExtensions.ToMarkdownEntry(IDocument?, string?, string?, ILogger?)

IDocumentExtensions.ToMenuDisplayItemModel(IDocument?)

IDocumentExtensions.ToMenuDisplayItemModel(IDocument?, IGroupable?)

IDocumentExtensions.ToValidationResult(IDocument?)

IDocumentExtensions.ToYaml(IDocument?, ILogger?)

IDocumentExtensions.ToYaml(IDocument?, IReadOnlyCollection<string>?, ILogger?)

IDocumentExtensions.WithDefaults(IDocument?)

IDocumentExtensions.WithEdit(IDocument?, Action<IDocument>?)

IDocumentExtensions.WritePublicationEntryWithJsonFrontMatter(IDocument?, string?, string?, ILogger?)

IDocumentExtensions.WritePublicationEntryWithYamlFrontMatter(IDocument?, string?, string?, ILogger?)

JsonNodeExtensions.ToJsonNode(object?)

Properties

ClientId

Gets or sets the client identifier.

[Display(Name = "Client ID", Order = 2)]
public string? ClientId { get; set; }

Property Value

string

DocumentId

Gets or sets the document identifier.

[Display(Name = "Document ID", Order = 1)]
public int? DocumentId { get; set; }

Property Value

int?

DocumentShortName

Gets or sets the short name of the document.

[Display(Name = "Short Name", Order = 4)]
public string? DocumentShortName { get; set; }

Property Value

string

EndDate

Gets or sets the end date.

[Display(Name = "End Date", Order = 9)]
public DateTime? EndDate { get; set; }

Property Value

DateTime?

FileName

Gets or sets the name of the file.

[Display(Name = "File Name", Order = 6)]
public string? FileName { get; set; }

Property Value

string

Fragments

Gets or sets the fragments.

[Display(AutoGenerateField = false)]
public ICollection<Fragment> Fragments { get; init; }

Property Value

ICollection<Fragment>

InceptDate

Gets or sets the incept date.

[Display(Name = "Incept Date", Order = 7)]
public DateTime? InceptDate { get; set; }

Property Value

DateTime?

IndexKeywords

Gets or sets the collection of IndexKeyword.

[Display(AutoGenerateField = false)]
public ICollection<IndexKeyword> IndexKeywords { get; init; }

Property Value

ICollection<IndexKeyword>

IsActive

Gets or sets the is active.

[Display(Name = "Is Active?", Order = 10)]
public bool? IsActive { get; set; }

Property Value

bool?

IsRoot

Gets or sets the is root.

[Display(Name = "Is Root?", Order = 11)]
public bool? IsRoot { get; set; }

Property Value

bool?

ModificationDate

Gets or sets the modification date.

[Display(Name = "Modification Date", Order = 8)]
public DateTime? ModificationDate { get; set; }

Property Value

DateTime?

Path

Gets or sets the path.

[Display(Name = "Path", Order = 5)]
public string? Path { get; set; }

Property Value

string

ResponsiveImages

Gets or sets the collection of ResponsiveImage.

[Display(AutoGenerateField = false)]
public ICollection<ResponsiveImage> ResponsiveImages { get; init; }

Property Value

ICollection<ResponsiveImage>

Segment

Gets or sets the segment.

[Display(AutoGenerateField = false)]
public Segment? Segment { get; set; }

Property Value

Segment

SegmentId

Gets or sets the segment identifier.

[Display(Name = "Segment ID", Order = 0)]
public int? SegmentId { get; set; }

Property Value

int?

SortOrdinal

Gets or sets the sort ordinal.

[Display(Name = "Sort Ordinal", Order = 6)]
public byte? SortOrdinal { get; set; }

Property Value

byte?

Tag

Gets or sets the tag.

[Display(Name = "Document Tag", Order = 12)]
public string? Tag { get; set; }

Property Value

string

TemplateId

Gets or sets the template identifier.

[Display(Name = "XSL Template", Order = 13)]
public int? TemplateId { get; set; }

Property Value

int?

Title

Gets or sets the title.

[Display(Name = "Document Title", Order = 3)]
public string? Title { get; set; }

Property Value

string

Methods

ToString()

Converts the Document into a string.

public override string ToString()

Returns

string