skip navigation
  • Product Bundles

    DevCraft

    All Telerik .NET tools and Kendo UI JavaScript components in one package. Now enhanced with:

    • AI Coding Assistants
    • Embedded Reporting
    • Document Processing Libraries
    • SSO Account Sign-in

    Web

    Kendo UI UI for Angular UI for Vue UI for jQuery KendoReact UI for Blazor UI for ASP.NET Core UI for ASP.NET MVC UI for ASP.NET AJAX

    Mobile

    UI for .NET MAUI

    Document Management

    Telerik Document Processing

    Desktop

    UI for .NET MAUI UI for WinUI UI for WinForms UI for WPF

    Reporting

    Telerik Reporting Telerik Report Server

    Testing & Mocking

    Test Studio Telerik JustMock

    CMS

    Sitefinity

    AI Productivity Tools

    AI Coding Assistants

    UI/UX Tools

    ThemeBuilder Design System Kit Templates and Building Blocks

    Debugging

    Fiddler Fiddler Everywhere Fiddler Classic Fiddler Everywhere Reporter FiddlerCore

    Free Tools

    KendoReact Free VB.NET to C# Converter Testing Framework
    View all products
  • Overview
  • Demos
    • What's New
    • Roadmap
    • Release History
  • Support and Learning

    • Support and Learning Hub
    • First Steps
    • Docs
    • Demos
    • Virtual Classroom
    • Forums
    • Videos
    • Blogs
    • Accessibility
    • Submit a Ticket

    Productivity and Design Tools

    • Visual Studio Extensions
    • Visual Studio Templates
    • Embedded Reporting
  • Pricing
  • Shopping cart
    • Account Overview
    • Your Licenses
    • Downloads
    • Support Center
    • Forum Profile
    • Payment Methods
    • Edit Profile
    • Log out
  • Login
  • Contact Us
  • Try now

Class HyperlinkField

Represents a hyperlink field.

Inheritance
System.Object
Field
CodeBasedField
HyperlinkField
Inherited Members
CodeBasedField.DateTimeFormattingProperty
CodeBasedField.GeneralFormattingProperty
CodeBasedField.NumericFormattingProperty
CodeBasedField.CopyPropertiesFrom(FieldCodeExpression)
CodeBasedField.InvalidateCode()
CodeBasedField.GetCodeFragment()
CodeBasedField.MakeHyperlinkFragment(DocumentFragment, HyperlinkInfo)
CodeBasedField.GetNumberResultWithFormatting(Int32)
CodeBasedField.IsCodeValid()
CodeBasedField.CodeBuilder
CodeBasedField.FieldCode
CodeBasedField.DateTimeFormatting
CodeBasedField.GeneralFormatting
CodeBasedField.NumericFormatting
Field.CodeFragmentFormat
Field.DisplayNameFragmentFormat
Field.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.HasDisplayNameFragment
Field.FieldStart
Field.DisplayMode
Field.EvaluationContext
Field.Document
Field.FieldPropertySetters
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinForms.Documents.Model
Assembly: Telerik.WinControls.RichTextEditor.dll

Syntax

public class HyperlinkField : CodeBasedField, ISupportInitialize

Constructors

HyperlinkField()

Initializes a new instance of the HyperlinkField class.

Declaration
public HyperlinkField()

HyperlinkField(HyperlinkInfo, String)

Initializes a new instance of the HyperlinkField class.

Declaration
public HyperlinkField(HyperlinkInfo info, string hyperlinkText)
Parameters
HyperlinkInfo info

The hyperlink information.

System.String hyperlinkText

The text of the hyperlink.

HyperlinkField(HyperlinkInfo, DocumentFragment)

Initializes a new instance of the HyperlinkField class.

Declaration
public HyperlinkField(HyperlinkInfo info, DocumentFragment fragment)
Parameters
HyperlinkInfo info

The hyperlink information.

DocumentFragment fragment

The fragment representing the content of the hyperlink.

Fields

FieldType

Declaration
public static readonly string FieldType
Field Value
System.String

LocationInFileProperty

Declaration
public static readonly FieldPropertyDefinition LocationInFileProperty
Field Value
FieldPropertyDefinition

NavigateUriProperty

The URI to navigate to.

Declaration
public static readonly FieldPropertyDefinition NavigateUriProperty
Field Value
FieldPropertyDefinition

TargetProperty

Declaration
public static readonly FieldPropertyDefinition TargetProperty
Field Value
FieldPropertyDefinition

Properties

FieldTypeName

Gets the name of the field type.

Declaration
public override string FieldTypeName { get; }
Property Value
System.String

Overrides
Field.FieldTypeName

HyperlinkInfo

Gets or sets the hyperlink information.

Declaration
public HyperlinkInfo HyperlinkInfo { get; set; }
Property Value
HyperlinkInfo

The hyperlink information.

LocationInFile

Gets or sets the location in file.

Declaration
[XamlSerializable]
public string LocationInFile { get; set; }
Property Value
System.String

The location in file.

NavigateUri

Gets or sets the URI to navigate to..

Declaration
[XamlSerializable]
public string NavigateUri { get; set; }
Property Value
System.String

The navigate URI.

Target

Gets or sets the target of the hyperlink.

Declaration
[XamlSerializable]
public string Target { get; set; }
Property Value
System.String

The target.

Methods

BuildCodeOverride()

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

Declaration
protected override void BuildCodeOverride()
Overrides
CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration
public override void CopyPropertiesFrom(Field fromField)
Parameters
Field fromField

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.

Declaration
protected override void CopyPropertiesFromCodeExpression(FieldCodeExpression fieldCodeExpression)
Parameters
FieldCodeExpression fieldCodeExpression

The field code expression.

Overrides
CodeBasedField.CopyPropertiesFromCodeExpression(FieldCodeExpression)

CreateInstance()

Creates a new instance of the current field class.

Declaration
public override Field CreateInstance()
Returns
Field

The new field instance.

Overrides
Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration
protected override DocumentFragment GetResultFragment()
Returns
DocumentFragment

The result fragment.

Overrides
Field.GetResultFragment()

Extension Methods

SvgExtentions.Traverse<T>(T, Func<T, IEnumerable<T>>)
SvgExtentions.TraverseDepthFirst<T>(T, Func<T, IEnumerable<T>>)

See Also

CodeBasedField
Getting Started
  • Install Now
  • Demos
  • Step-by-Step Tutorial
  • Sample Applications
  • SDK Samples
  • Visual Studio Extensions
Support Resources
  • Code Library
  • Knowledge Base
  • Videos
Community
  • Forums
  • Blogs
  • Feedback Portal
  • Document Processing Feedback Portal

Copyright © 2018 Progress Software Corporation and/or its subsidiaries or affiliates.
All Rights Reserved.

Progress, Telerik, and certain product names used herein are trademarks or registered trademarks of Progress Software Corporation and/or one of its subsidiaries or affiliates in the U.S. and/or other countries. See Trademarks for appropriate markings.