Class GpxWebLink

A link to an external resource (Web page, digital photo, video clip, etc) with additional information.

Inheritance

Object

GpxWebLink

Inherited Members

Object.Equals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Object.ReferenceEquals(Object, Object)

Namespace: NetTopologySuite.IO

Assembly: NetTopologySuite.IO.GPX.dll

Syntax

public sealed class GpxWebLink : ICanWriteToXmlWriter

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the simple type "linkType".

Constructors

| Improve this Doc View Source

GpxWebLink(String, String, String)

Initializes a new instance of the GpxWebLink class.

If hrefString is never longer than 65519 characters, then favor using GpxWebLink(Uri, String, String) instead of this, since Href will never be null when using that constructor.

Declaration

public GpxWebLink(string hrefString, string text, string contentType)

Parameters

Type	Name	Description
String	hrefString	The value of HrefString.
String	text	The value of Text.
String	contentType	The value of ContentType.

Exceptions

Type	Condition
ArgumentNullException	`hrefString` is null.
ArgumentException	`hrefString` does not look like a valid URI string.

| Improve this Doc View Source

GpxWebLink(Uri)

Initializes a new instance of the GpxWebLink class.

Declaration

public GpxWebLink(Uri href)

Parameters

Type	Name	Description
Uri	href	The value of Href.

Exceptions

Type	Condition
ArgumentNullException	`href` is null.

| Improve this Doc View Source

GpxWebLink(Uri, String, String)

Initializes a new instance of the GpxWebLink class.

Declaration

public GpxWebLink(Uri href, string text, string contentType)

Parameters

Type	Name	Description
Uri	href	The value of Href.
String	text	The value of Text.
String	contentType	The value of ContentType.

Exceptions

Type	Condition
ArgumentNullException	`href` is null.

Properties

| Improve this Doc View Source

ContentType

Gets the MIME type of content (e.g., image/jpeg).

Declaration

public string ContentType { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "type" element.

| Improve this Doc View Source

Href

Gets the URL of the hyperlink, or null if this instance was created from a valid-looking data URI whose total length exceeded 65519 characters.

Declaration

public Uri Href { get; }

Property Value

Type	Description
Uri

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "href" attribute.

| Improve this Doc View Source

HrefString

Gets the URL of the hyperlink, as a string.

Declaration

public string HrefString { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "href" attribute.

| Improve this Doc View Source

Text

Gets the text of the hyperlink.

Declaration

public string Text { get; }

Property Value

Type	Description
String

Remarks

In the official XSD schema for GPX 1.1, this corresponds to the "text" element.

Methods

| Improve this Doc View Source

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

| Improve this Doc View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

| Improve this Doc View Source

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

| Improve this Doc View Source

WithContentType(String)

Builds a new instance of GpxWebLink as a copy of this instance, but with ContentType replaced by the given value.

Declaration

public GpxWebLink WithContentType(string contentType)

Parameters

Type	Name	Description
String	contentType	The new value for ContentType.

Returns

Type	Description
GpxWebLink	A new GpxWebLink instance that's a copy of the current instance, but with its ContentType value set to `contentType`.

| Improve this Doc View Source

WithHref(Uri)

Builds a new instance of GpxWebLink as a copy of this instance, but with Href and HrefString replaced by the given value.

Declaration

public GpxWebLink WithHref(Uri href)

Parameters

Type	Name	Description
Uri	href	The new value for Href and HrefString.

Returns

Type	Description
GpxWebLink	A new GpxWebLink instance that's a copy of the current instance, but with its Href value set to `href` and with its HrefString set accordingly.

Exceptions

Type	Condition
ArgumentNullException	`href` is null.

| Improve this Doc View Source

WithHrefString(String)

Builds a new instance of GpxWebLink as a copy of this instance, but with HrefString and Href replaced according to the given value.

Declaration

public GpxWebLink WithHrefString(string hrefString)

Parameters

Type	Name	Description
String	hrefString	The new value for HrefString and (if possible) Href.

Returns

Type	Description
GpxWebLink	A new GpxWebLink instance that's a copy of the current instance, but with its HrefString value set to `hrefString` and its Href value set accordingly.

Exceptions

Type	Condition
ArgumentNullException	`hrefString` is null.
ArgumentException	`hrefString` does not look like a valid URI string.

| Improve this Doc View Source

WithText(String)

Builds a new instance of GpxWebLink as a copy of this instance, but with Text replaced by the given value.

Declaration

public GpxWebLink WithText(string text)

Parameters

Type	Name	Description
String	text	The new value for Text.

Returns

Type	Description
GpxWebLink	A new GpxWebLink instance that's a copy of the current instance, but with its Text value set to `text`.