New to Telerik UI for WinForms? Start a free 30-day trial

HyperlinkField

Class

Represents a hyperlink field.

Definition

Namespace:Telerik.WinForms.Documents.Model

Assembly:Telerik.WinControls.RichTextEditor.dll

Syntax:

public class HyperlinkField : CodeBasedField, ISupportInitialize

Inheritance: objectFieldCodeBasedFieldHyperlinkField

Implements: ISupportInitialize

Inherited Members CodeBasedField.DateTimeFormattingPropertyCodeBasedField.GeneralFormattingPropertyCodeBasedField.NumericFormattingPropertyCodeBasedField.CopyPropertiesFrom(FieldCodeExpression)CodeBasedField.InvalidateCode()CodeBasedField.GetCodeFragment()CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)CodeBasedField.GetNumberResultWithFormatting(int)CodeBasedField.IsCodeValid()CodeBasedField.CodeBuilderCodeBasedField.FieldCodeCodeBasedField.DateTimeFormattingCodeBasedField.GeneralFormattingCodeBasedField.NumericFormattingField.CodeFragmentFormatField.DisplayNameFragmentFormatField.GetFragmentToDisplay()Field.GetFragmentByDisplayMode(FieldDisplayMode)Field.SetFragmentByDisplayMode(FieldDisplayMode, DocumentFragment)Field.Update()Field.CreateFragmentFromText(string)Field.GetDisplayNameFragment()Field.CreateDeepCopy()Field.SetPropertyValue(FieldPropertyDefinition, string)Field.SetPropertyValue(FieldPropertyDefinition, Field)Field.IsResultFragmentEmpty()Field.HasDisplayNameFragmentField.FieldStartField.DisplayModeField.EvaluationContextField.Document...

Constructors

HyperlinkField()

Initializes a new instance of the HyperlinkField class.

public HyperlinkField()

HyperlinkField(HyperlinkInfo, DocumentFragment)

Initializes a new instance of the HyperlinkField class.

public HyperlinkField(HyperlinkInfo info, DocumentFragment fragment)

Parameters:infoHyperlinkInfo

The hyperlink information.

fragmentDocumentFragment

The fragment representing the content of the hyperlink.

HyperlinkField(HyperlinkInfo, string)

Initializes a new instance of the HyperlinkField class.

public HyperlinkField(HyperlinkInfo info, string hyperlinkText)

Parameters:infoHyperlinkInfo

The hyperlink information.

hyperlinkTextstring

The text of the hyperlink.

Fields

FieldType

string

public static readonly string FieldType

LocationInFileProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition LocationInFileProperty

NavigateUriProperty

FieldPropertyDefinition

The URI to navigate to.

public static readonly FieldPropertyDefinition NavigateUriProperty

TargetProperty

FieldPropertyDefinition

public static readonly FieldPropertyDefinition TargetProperty

Properties

FieldTypeName

string

Gets the name of the field type.

public override string FieldTypeName { get; }

Overrides: Field.FieldTypeName

HyperlinkInfo

Gets or sets the hyperlink information.

public HyperlinkInfo HyperlinkInfo { get; set; }

Property Value:

The hyperlink information.

LocationInFile

string

Gets or sets the location in file.

[XamlSerializable]
public string LocationInFile { get; set; }

Property Value:

The location in file.

NavigateUri

string

Gets or sets the URI to navigate to..

[XamlSerializable]
public string NavigateUri { get; set; }

Property Value:

The navigate URI.

Target

string

Gets or sets the target of the hyperlink.

[XamlSerializable]
public string Target { get; set; }

Property Value:

The target.

Methods

BuildCodeOverride()

Builds the field-specific parts of the code fragment, using the current CodeBuilder.

protected override void BuildCodeOverride()

Overrides: CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

public override void CopyPropertiesFrom(Field fromField)

Parameters:fromFieldField

The other field, which has to be of the same type as the current instance.

Overrides: CodeBasedField.CopyPropertiesFrom(Field)

CopyPropertiesFromCodeExpression(FieldCodeExpression)

Copies the field-specific properties from a FieldCodeExpression.

protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)

Parameters:fieldCodeExpressionFieldCodeExpression

The field code expression.

Overrides: CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

public override Field CreateInstance()

Returns:

Field

The new field instance.

Overrides: Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

protected override DocumentFragment GetResultFragment()

Returns:

DocumentFragment

The result fragment.

Overrides: Field.GetResultFragment()