Back to all docs
API Reference / Telerik.Windows.Documents.Model / HyperlinkField

Class
HyperlinkField

Represents a hyperlink field.

Definition

Namespace:Telerik.Windows.Documents.Model

Assembly:Telerik.Windows.Controls.RichTextBox.dll

Syntax:
cs-api-definition
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.

Declaration

cs-api-definition
public HyperlinkField()

HyperlinkField(HyperlinkInfo, DocumentFragment)

Initializes a new instance of the HyperlinkField class.

Declaration

cs-api-definition
public HyperlinkField(HyperlinkInfo info, DocumentFragment fragment)

Parameters

info

HyperlinkInfo

The hyperlink information.

fragment

DocumentFragment

The fragment representing the content of the hyperlink.

HyperlinkField(HyperlinkInfo, string)

Initializes a new instance of the HyperlinkField class.

Declaration

cs-api-definition
public HyperlinkField(HyperlinkInfo info, string hyperlinkText)

Parameters

info

HyperlinkInfo

The hyperlink information.

hyperlinkText

string

The text of the hyperlink.

Fields

FieldType

Declaration

cs-api-definition
public static readonly string FieldType

Field Value

string

LocationInFileProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition LocationInFileProperty

Field Value

FieldPropertyDefinition

NavigateUriProperty

The URI to navigate to.

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition NavigateUriProperty

Field Value

FieldPropertyDefinition

TargetProperty

Declaration

cs-api-definition
public static readonly FieldPropertyDefinition TargetProperty

Field Value

FieldPropertyDefinition

Properties

FieldTypeName

Gets the name of the field type.

Declaration

cs-api-definition
public override string FieldTypeName { get; }

Property Value

string

Overrides Field.FieldTypeName

HyperlinkInfo

Gets or sets the hyperlink information.

Declaration

cs-api-definition
public HyperlinkInfo HyperlinkInfo { get; set; }

Property Value

HyperlinkInfo

The hyperlink information.

LocationInFile

Gets or sets the location in file.

Declaration

cs-api-definition
[XamlSerializable]
public string LocationInFile { get; set; }

Property Value

string

The location in file.

NavigateUri

Gets or sets the URI to navigate to..

Declaration

cs-api-definition
[XamlSerializable]
public string NavigateUri { get; set; }

Property Value

string

The navigate URI.

Target

Gets or sets the target of the hyperlink.

Declaration

cs-api-definition
[XamlSerializable]
public string Target { get; set; }

Property Value

string

The target.

Methods

BuildCodeOverride()

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

Declaration

cs-api-definition
protected override void BuildCodeOverride()

Overrides CodeBasedField.BuildCodeOverride()

CopyPropertiesFrom(Field)

Copies all properties from another field of the same type.

Declaration

cs-api-definition
public override void CopyPropertiesFrom(Field fromField)

Parameters

fromField

Field

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

cs-api-definition
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

cs-api-definition
public override Field CreateInstance()

Returns

Field

The new field instance.

Overrides Field.CreateInstance()

GetResultFragment()

Builds the result fragment of the field.

Declaration

cs-api-definition
protected override DocumentFragment GetResultFragment()

Returns

DocumentFragment

The result fragment.

Overrides Field.GetResultFragment()

In this article
DefinitionConstructorsHyperlinkField()HyperlinkField(HyperlinkInfo, DocumentFragment)HyperlinkField(HyperlinkInfo, string)FieldsFieldTypeLocationInFilePropertyNavigateUriPropertyTargetPropertyPropertiesFieldTypeNameHyperlinkInfoLocationInFileNavigateUriTargetMethodsBuildCodeOverride()CopyPropertiesFrom(Field)CopyPropertiesFromCodeExpression(FieldCodeExpression)CreateInstance()GetResultFragment()
Not finding the help you need?
Contact Support