Class HyperLinksCollection
Collection of hyperlinks.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.XlsIO.Implementation.Collections
Assembly: Syncfusion.XlsIO.Base.dll
Syntax
public class HyperLinksCollection : CollectionBaseEx<HyperLinkImpl>, IList<HyperLinkImpl>, ICollection<HyperLinkImpl>, IEnumerable<HyperLinkImpl>, IEnumerable, IHyperLinks, IParentApplication, ICloneParentConstructors
HyperLinksCollection(IApplication, Object)
Creates collection and sets its Application and Parent values.
Declaration
public HyperLinksCollection(IApplication application, object parent)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object that represents the Excel application. |
| System.Object | parent | Parent object of this collection. |
HyperLinksCollection(IApplication, Object, Boolean)
Creates collection and sets its Application and Parent values.
Declaration
public HyperLinksCollection(IApplication application, object parent, bool isReadOnly)Parameters
| Type | Name | Description |
|---|---|---|
| IApplication | application | Application object that represents the Excel application. |
| System.Object | parent | Parent object of this collection. |
| System.Boolean | isReadOnly | Indicates whether read-only collection should be created. |
Properties
IsReadOnly
Indicates whether collection is in read-only mode. Read-only.
Declaration
public bool IsReadOnly { get; }Property Value
| Type |
|---|
| System.Boolean |
Item[Int32]
Returns single entry from the collection. Read-only.
Declaration
public IHyperLink this[int index] { get; }Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index |
Property Value
| Type |
|---|
| IHyperLink |
Methods
Add(IHyperLink)
Adds new hyperlink to the collection.
Declaration
public int Add(IHyperLink link)Parameters
| Type | Name | Description |
|---|---|---|
| IHyperLink | link | Hyperlink to add. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index in the collection of the new hyperlink. |
Add(IRange)
Defines a new hyperlink.
Declaration
public IHyperLink Add(IRange range)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | range | Name object to add. |
Returns
| Type |
|---|
| IHyperLink |
Add(IRange, ExcelHyperLinkType, String, String)
Defines a new hyperlink for the range object.
Declaration
public 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
public IHyperLink Add(IShape shape)Parameters
| Type | Name | Description |
|---|---|---|
| IShape | shape | shape object to add. |
Returns
| Type |
|---|
| IHyperLink |
Add(IShape, ExcelHyperLinkType, String, String)
Defines a new hyperlink for the shape object.
Declaration
public 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. |
AddRange(IList<HyperLinkImpl>)
Declaration
public void AddRange(IList<HyperLinkImpl> collection)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.Generic.IList<HyperLinkImpl> | collection |
AddToHash(HyperLinkImpl)
Declaration
public void AddToHash(HyperLinkImpl link)Parameters
| Type | Name | Description |
|---|---|---|
| HyperLinkImpl | link |
Clone(Object)
Creates a new object that is a copy of the current instance.
Declaration
public override 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. |
Overrides
CreateHyperlinkStyles()
Creates hyperlink styles if necessary.
Declaration
public void CreateHyperlinkStyles()GetHyperlinkByCellIndex(Int64)
Gets last hyperlink by cell index.
Declaration
public IHyperLink GetHyperlinkByCellIndex(long lCellIndex)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int64 | lCellIndex | Cell index. |
Returns
| Type | Description |
|---|---|
| IHyperLink | Returns Hyper link if contain; otherwise null. |
GetRangeHyperlinks(IRange)
Gets collection of hyperlinks for the specified range.
Declaration
public HyperLinksCollection GetRangeHyperlinks(IRange range)Parameters
| Type | Name | Description |
|---|---|---|
| IRange | range | Range to get hyperlinks for. |
Returns
| Type | Description |
|---|---|
| HyperLinksCollection | Collection of hyperlinks for the specified range. |
Parse(IList, Int32)
Creates collection from IList.
Declaration
public int Parse(IList data, int iPos)Parameters
| Type | Name | Description |
|---|---|---|
| System.Collections.IList | data | IList with necessary Biff records. |
| System.Int32 | iPos | Start offset in the array. |
Returns
| Type | Description |
|---|---|
| System.Int32 | Index of the first record after hyperlinks records. |
RemoveAt(Int32)
Removes item at the specified index.
Declaration
public void RemoveAt(int index)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | index | Item index to remove. |
Serialize(OffsetArrayList)
Saves collection into list of BiffRecords.
Declaration
public void Serialize(OffsetArrayList records)Parameters
| Type | Name | Description |
|---|---|---|
| OffsetArrayList | records | OffsetArrayList with BiffRecords. |
Exceptions
| Type | Condition |
|---|---|
| System.ArgumentNullException | If records parameter is NULL. |