Click or drag to resize

XlsHyperLink Class

Represents a hyperlink.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsHyperLink
Spire.Xls HyperLink

Namespace: Spire.Xls.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsHyperLink : XlsObject, 
	IHyperLink, IExcelApplication, ICloneParent

The XlsHyperLink type exposes the following members.

Properties
Name Description
Public property Address
Returns or sets the address of the target document.
Public property FirstColumn
Gets the index of the first column.
Public property FirstRow
Gets the index of the first row.
Public property LastColumn
Gets the index of the last column.
Public property LastRow
Gets the index of the last row.
Public property Name
Returns or sets the name of the object.
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property Range
Returns a Range object that represents the range the specified hyperlink is attached to.
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property ScreenTip
Returns or sets the ScreenTip text for the specified hyperlink.
Public property SubAddress
Returns or sets the location within the document associated with the hyperlink.
Public property TextToDisplay
Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
Public property Type
Returns or sets the object type.
Public property UnicodePath
Gets/sets an optional string of Unicode characters that specifies the complete file path. When the property Type is not HyperLinkType.File, this property is invalid.
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clone
Creates a new object that is a copy of the current instance.
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
Determines whether the specified object is equal to the current object.
(Inherited from Object .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as the default hash function.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Public method SetAddress
Returns or sets the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method SetSubAddress
Sets sub address property.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also