LinkifyFormatOptions Class

Formatting options to use with Linkify(FileInfo, LinkifyInterfaceType, LinkifyPlugins, LinkifyFormatOptions, Encoding) function.

Definition

Namespace: DevCase.Core.DataProcessing.Html
Assembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
C#Request Example
public class LinkifyFormatOptions
Inheritance
Object    LinkifyFormatOptions

Constructors

LinkifyFormatOptions Initializes a new instance of the LinkifyFormatOptions class.

Properties

Attributes Gets or sets the attributes to add to each new link.

Accepts a function that takes the link type, the unformatted href, and returns the attributes object.

Default value: null for all link types.

Note: the class, target and rel attributes have dedicated options through ClassAttribute, TargetAttribute and RelAttribute properties.

ClassAttribute Gets or sets the 'class' attribute name to use for newly created links.

Accepts a function that takes the link type, the unformatted 'href' value, and returns the 'class' attribute name.

Default value: null for all link types.

FormatHref Gets or sets a value to format the 'href' attribute.

Similar to FormatLink property, except the formatting will be used in the 'href' attribute of the new link, and not in the link value.

This is useful for hashtags or other LinkifyPlugins plugins where you don’t want the default to be a link to a named anchor (the default behaviour).

Accepts a function that takes the link type, the unformatted 'href' value, and returns the new formated 'href' value.

Default value: null (no formatting) for all link types.

FormatLink Gets or sets a value to format the text displayed by a linkified entity. (e.g., truncate a long URL).

Similar to FormatHref property, except the formatting will be used in the link value, and not in the 'href' attribute.

Accepts a function that takes the link type, the link value, and returns the new formated link value.

Default value: null (no formatting) for all link types.

IgnoreTags Gets or sets a value that prevent linkify from trying to parse links in the specified tags.

Use this when running linkify on arbitrary HTML.

Note: for Html interface only.

Default value: null

LinkValidationSelector Gets or sets a value to filter out certain links to prevent linkify from highlighting them based on any desired criteria.

Accepts a function that takes the link type, the link value, and returns true if the link value should be converted into an anchor tag, or false otherwise.

Default value: True for all link types.

NewLineToBreakLine Gets or sets a value indicating to convert '\n' line breaks to <br> tags.

Default value: False

RelAttribute Gets or sets the 'rel' attribute for each discovered link.

Accepts a function that takes the link type, the unformatted 'href' value, and returns the 'rel' attribute.

Default value: null for all link types.

TagName Gets or sets the HTML tag to use for each link. For cases where you can’t use anchor tags.

Accepts a function that takes the link type, the unformatted href, and returns the tag name.

Default value: "a" for all link types.

TargetAttribute Gets or sets the 'target' attribute for generated links, such as "_blank" or "_parent".

Accepts a function that takes the link type, the unformatted 'href' value, and returns the 'target' attribute.

Default value: "_blank" for all link types.

TruncateLength Gets or sets a value for the formatting helper that drops characters in discovered URLs so that the displayed link text is no longer than the specified length.

If any characters are dropped, also appends an ellipsis (…) to the result.

Default value: Infinity (no truncate).

UrlProtocol Gets or sets the url protocol ("http", "https", "ftp", "ftps", etc) that should be used in 'href' attributes for URLs without a protocol (e.g., github.com).

Default value: Uri.UriSchemeHttp ("http")

Methods

Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
ToString Returns a string that represents the current object.
(Inherited from Object)

Extension Methods

CanConvertTo Determines whether the source object can be converted to the specified target type.
(Defined by ObjectExtensions)
CanConvertToT Determines whether the source object can be converted to the specified target type.
(Defined by ObjectExtensions)
ConvertToT Converts an object to the specified target type.

If the conversion fails, an exception is thrown.
(Defined by ObjectExtensions)
ConvertToT Converts an object to the specified target type.

If the conversion fails, returns the specified default value.
(Defined by ObjectExtensions)
IsDisposable Determines whether the specified object is a disposable type (i.e., it implements IDisposable interface).
(Defined by ObjectExtensions)
Speak Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer.
(Defined by ObjectExtensions)
Speak Speaks the string representation of the source object by using the operating system integrated text-to-speech synthesizer.
(Defined by ObjectExtensions)
ThrowIfNullTException Throws the specified exception if the source object is null.
(Defined by ObjectExtensions)

See Also