Interface IHyperLinks
Represents collection of hyperlinks.
Namespace: Syncfusion.XlsIO
Assembly: Syncfusion.XlsIO.Portable.dll
Syntax
public interface IHyperLinks : IParentApplicationProperties
Count
Returns the number of objects in the collection. Read-only.
Declaration
int Count { get; }Property Value
| Type |
|---|
| System.Int32 |
Item[Int32]
Returns a single hyperlink object from the collection. Read-only.
Declaration
IHyperLink this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| IHyperLink |
Methods
Add(IRange)
Defines a new hyperlink.
Declaration
IHyperLink Add(IRange range)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | range | Range object that represents the range new hyperlink is attached to. |
Returns
| Type | Description |
|---|---|
| IHyperLink | A hyperlink in the range |
Add(IRange, ExcelHyperLinkType, String, String)
Defines a new hyperlink for the range object.
Declaration
IHyperLink Add(IRange range, ExcelHyperLinkType hyperlinkType, string address, string screenTip)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | range | Range object. |
| ExcelHyperLinkType | hyperlinkType | The type of the hyperlink. |
| System.String | address | The address of the hyperlink. |
| System.String | screenTip | The screen tip to be displayed when the mouse pointer is paused over the hyperlink. |
Returns
| Type | Description |
|---|---|
| IHyperLink | Returns hyperlink initialized object. |
Add(IShape)
Defines a new hyperlink.
Declaration
IHyperLink Add(IShape shape)Parameters
| Type | Name | Description |
|---|---|---|
| IShape | shape | Shape object that represents the new hyperlink is attached to. |
Returns
| Type | Description |
|---|---|
| IHyperLink | A hyperlink in the shape |
Add(IShape, ExcelHyperLinkType, String, String)
Defines a new hyperlink for the shape object.
Declaration
IHyperLink Add(IShape shape, ExcelHyperLinkType hyperlinkType, string address, string screenTip)Parameters
| Type | Name | Description |
|---|---|---|
| IShape | shape | Shape object. |
| ExcelHyperLinkType | hyperlinkType | The type of the hyperlink. |
| System.String | address | The address of the hyperlink. |
| System.String | screenTip | The screen tip to be displayed when the mouse pointer is paused over the hyperlink. |
Returns
| Type | Description |
|---|---|
| IHyperLink | Returns hyperlink initialized object. |
RemoveAt(Int32)
Removes HyperLink object from the collection.
Declaration
void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | HyperLink index to remove. |