Class EpubMetadataLink

A metadata link. Links are used to associate resources with the EPUB book, such as metadata records.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-elem for more information.

Inheritance
object
EpubMetadataLink
Inherited Members
Namespace: VersOne.Epub.Schema
Assembly: VersOne.Epub.dll
public class EpubMetadataLink

Constructors

View Source

EpubMetadataLink(string, string?, string?, List<EpubMetadataLinkProperty>?, string?, List<EpubMetadataLinkRelationship>?, string?)

Initializes a new instance of the EpubMetadataLink class.

Declaration
public EpubMetadataLink(string href, string? id = null, string? mediaType = null, List<EpubMetadataLinkProperty>? properties = null, string? refines = null, List<EpubMetadataLinkRelationship>? relationships = null, string? hrefLanguage = null)
Parameters
Type Name Description
string href

The location of the linked resource.
string id

The unique ID of this link or null if the link doesn't have an ID.
string mediaType

The media type of the linked resource or null if the link doesn't specify the media type.
List<EpubMetadataLinkProperty> properties

A list of the link properties used to establish the type of record a referenced resource represents or null if the link doesn't specify properties.
string refines

A relative IRI that identifies the resource augmented by the link or null if the link doesn't specify any augmentation.
List<EpubMetadataLinkRelationship> relationships

A list of properties that establish the relationship the resource has with the EPUB book.
string hrefLanguage

The language of the linked resource or null if the link doesn't specify the language of the linked resource.
Exceptions
Type Condition
ArgumentNullException

The href parameter is null.

Properties

View Source

Gets the location of the linked resource.

See https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-elem and https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-href for more information.

Declaration
public string Href { get; }
Property type: string
View Source

Gets the language of the linked resource or null if the link doesn't specify the language of the linked resource.

See https://www.w3.org/TR/epub-33/#attrdef-hreflang and https://www.rfc-editor.org/info/bcp47 for more information.

Declaration
public string? HrefLanguage { get; }
Property type: string
View Source

Gets the unique ID of this link or null if the link doesn't have an ID.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-id for more information.

Declaration
public string? Id { get; }
Property type: string
View Source

Gets the media type of the linked resource or null if the link doesn't specify the media type.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-link-media-type for more information.

Declaration
public string? MediaType { get; }
Property type: string
View Source

Gets a list of the link properties used to establish the type of record a referenced resource represents or null if the link doesn't specify properties.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-properties and https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-properties for more information.

Declaration
public List<EpubMetadataLinkProperty>? Properties { get; }
Property type: List<EpubMetadataLinkProperty>
View Source

Gets a relative IRI that identifies the resource augmented by the link or null if the link doesn't specify any augmentation.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-refines for more information.

Declaration
public string? Refines { get; }
Property type: string
View Source

Gets a list of properties that establish the relationship the resource has with the EPUB book.

See https://www.w3.org/publishing/epub32/epub-packages.html#attrdef-link-rel and https://www.w3.org/publishing/epub32/epub-packages.html#sec-link-rel for more information.

Declaration
public List<EpubMetadataLinkRelationship> Relationships { get; }
Property type: List<EpubMetadataLinkRelationship>