Class HyperLinkImpl

Represents hyperlink object.

Inheritance
System.Object
CommonObject
HyperLinkImpl
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class HyperLinkImpl : CommonObject, IDisposable, IHyperLink, IParentApplication, ICloneParent

Constructors

HyperLinkImpl(IApplication, Object)

Creates an object and sets its Application and Parent properties to specified values.

Declaration
public HyperLinkImpl(IApplication application, object parent)
Parameters
Type Name Description
IApplication application

Application object for the hyperlink.
System.Object parent

Parent object for the hyperlink.

HyperLinkImpl(IApplication, Object, IRange)

Creates an object and sets its Application, Parent and Range properties to specified values.

Declaration
public HyperLinkImpl(IApplication application, object parent, IRange range)
Parameters
Type Name Description
IApplication application

Application object for the hyperlink.
System.Object parent

Parent object for the hyperlink.
IRange range

Range object that represents the range the specified hyperlink is attached to.

HyperLinkImpl(IApplication, Object, IShape)

Creates an object and sets its Application, Parent and shape properties to specified values.

Declaration
public HyperLinkImpl(IApplication application, object parent, IShape shape)
Parameters
Type Name Description
IApplication application

Application object for the hyperlink.
System.Object parent

Parent object for the hyperlink.
IShape shape

Shape object that represents the shape the specified hyperlink is attached to.

HyperLinkImpl(IApplication, Object, IList, ref Int32)

Recover hyperlink from Biff records.

Declaration
public HyperLinkImpl(IApplication application, object parent, IList data, ref int iPos)
Parameters
Type Name Description
IApplication application

Application object for the hyperlink.
System.Object parent

Parent object for the hyperlink.
System.Collections.IList data

Array of BiffRecordRaws that contains hyperlink records.
System.Int32 iPos

Position of the first hyperlink record.

Fields

DEF_STYLE_NAME

Style for hyperlink.

Declaration
public const string DEF_STYLE_NAME = "Hyperlink"
Field Value
Type
System.String

Properties

Address

Returns or sets the address of the target document.

Declaration
public string Address { get; set; }
Property Value
Type
System.String

AttachedType

Represent the hyperlink attached object name.

Declaration
public ExcelHyperlinkAttachedType AttachedType { get; }
Property Value
Type
ExcelHyperlinkAttachedType

FirstColumn

Declaration
public int FirstColumn { get; }
Property Value
Type
System.Int32

FirstRow

Declaration
public int FirstRow { get; }
Property Value
Type
System.Int32

LastColumn

Declaration
public int LastColumn { get; }
Property Value
Type
System.Int32

LastRow

Declaration
public int LastRow { get; }
Property Value
Type
System.Int32

Name

Returns or sets the name of the object.

Declaration
public string Name { get; }
Property Value
Type
System.String

Range

Returns/sets a Range object that represents the range the specified hyperlink is attached to.

Declaration
public IRange Range { get; set; }
Property Value
Type
IRange

ScreenTip

Returns or sets the ScreenTip text for the specified hyperlink.

Declaration
public string ScreenTip { get; set; }
Property Value
Type
System.String

Shape

Returns a shape object that specified hyperlink is attached to.

Declaration
public IShape Shape { get; }
Property Value
Type
IShape

SubAddress

Returns or sets the location within the document associated with the hyperlink.

Declaration
public string SubAddress { get; set; }
Property Value
Type
System.String

TextToDisplay

Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

Declaration
public string TextToDisplay { get; set; }
Property Value
Type
System.String

TopLeftCell

Returns top left cell of the range. Read-only.

Declaration
protected IRange TopLeftCell { get; }
Property Value
Type
IRange

Type

Returns or sets the object type.

Declaration
public ExcelHyperLinkType Type { get; set; }
Property Value
Type
ExcelHyperLinkType

Methods

Clear()

Clears the hyperlink

Declaration
public void Clear()

Clone(Object)

Creates a new object that is a copy of the current instance.

Declaration
public object Clone(object parent)
Parameters
Type Name Description
System.Object parent

Parent object for a copy of this instance.
Returns
Type Description
System.Object

A new object that is a copy of this instance.

Serialize(OffsetArrayList)

Saves hyperlink into OffsetArrayList.

Declaration
public void Serialize(OffsetArrayList records)
Parameters
Type Name Description
OffsetArrayList records

OffsetArrayList that will receive all records of the range.

SetAddress(String, Boolean)

Sets address property.

Declaration
public void SetAddress(string strAddress, bool bSetText)
Parameters
Type Name Description
System.String strAddress

Address to set.
System.Boolean bSetText

Indicates whether we should set Text property of the TopLeft cell with this hyperlink.

SetSubAddress(String)

Sets sub address property.

Declaration
public void SetSubAddress(string strSubAddress)
Parameters
Type Name Description
System.String strSubAddress

Sub address to set.

Implements

System.IDisposable