alexa
menu

MAUI

  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Search Results for

    Show / Hide Table of Contents

    Class HyperLinksCollection

    Collection of hyperlinks.

    Inheritance
    object
    CollectionBase<HyperLinkImpl>
    CollectionBaseEx<HyperLinkImpl>
    HyperLinksCollection
    Implements
    IList<HyperLinkImpl>
    ICollection<HyperLinkImpl>
    IEnumerable<HyperLinkImpl>
    IEnumerable
    IHyperLinks
    IParentApplication
    ICloneParent
    Inherited Members
    CollectionBase<HyperLinkImpl>.Add(HyperLinkImpl)
    CollectionBase<HyperLinkImpl>.Capacity
    CollectionBase<HyperLinkImpl>.Clear()
    CollectionBase<HyperLinkImpl>.Contains(HyperLinkImpl)
    CollectionBase<HyperLinkImpl>.CopyTo(HyperLinkImpl[], int)
    CollectionBase<HyperLinkImpl>.Count
    CollectionBase<HyperLinkImpl>.GetEnumerator()
    CollectionBase<HyperLinkImpl>.IndexOf(HyperLinkImpl)
    CollectionBase<HyperLinkImpl>.InnerList
    CollectionBase<HyperLinkImpl>.Insert(int, HyperLinkImpl)
    CollectionBase<HyperLinkImpl>.List
    CollectionBase<HyperLinkImpl>.Remove(HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.AppImplementation
    CollectionBaseEx<HyperLinkImpl>.Application
    CollectionBaseEx<HyperLinkImpl>.Changed
    CollectionBaseEx<HyperLinkImpl>.ChangeName(IDictionary, ValueChangedEventArgs)
    CollectionBaseEx<HyperLinkImpl>.Cleared
    CollectionBaseEx<HyperLinkImpl>.Clearing
    CollectionBaseEx<HyperLinkImpl>.ClearMaxValues()
    CollectionBaseEx<HyperLinkImpl>.EnsureCapacity(int)
    CollectionBaseEx<HyperLinkImpl>.FindParent(Type)
    CollectionBaseEx<HyperLinkImpl>.FindParent(Type, bool)
    CollectionBaseEx<HyperLinkImpl>.GenerateDefaultName(ICollection<HyperLinkImpl>, string)
    CollectionBaseEx<HyperLinkImpl>.GenerateDefaultName(ICollection, string)
    CollectionBaseEx<HyperLinkImpl>.GenerateDefaultName(string, params ICollection[])
    CollectionBaseEx<HyperLinkImpl>.Inserted
    CollectionBaseEx<HyperLinkImpl>.Inserting
    CollectionBaseEx<HyperLinkImpl>.OnClear()
    CollectionBaseEx<HyperLinkImpl>.OnClearComplete()
    CollectionBaseEx<HyperLinkImpl>.OnInsert(int, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.OnInsertComplete(int, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.OnRemove(int, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.OnRemoveComplete(int, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.OnSet(int, HyperLinkImpl, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.OnSetComplete(int, HyperLinkImpl, HyperLinkImpl)
    CollectionBaseEx<HyperLinkImpl>.Parent
    CollectionBaseEx<HyperLinkImpl>.QuietMode
    CollectionBaseEx<HyperLinkImpl>.Removed
    CollectionBaseEx<HyperLinkImpl>.Removing
    CollectionBaseEx<HyperLinkImpl>.Set
    CollectionBaseEx<HyperLinkImpl>.SetParent(object)
    CollectionBaseEx<HyperLinkImpl>.Setting
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Syncfusion.XlsIO.Implementation.Collections
    Assembly: Syncfusion.XlsIO.NET.dll
    Syntax
    public class HyperLinksCollection : CollectionBaseEx<HyperLinkImpl>, IList<HyperLinkImpl>, ICollection<HyperLinkImpl>, IEnumerable<HyperLinkImpl>, IEnumerable, IHyperLinks, IParentApplication, ICloneParent

    Constructors

    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.

    object parent

    Parent object of this collection.

    HyperLinksCollection(IApplication, object, bool)

    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.

    object parent

    Parent object of this collection.

    bool 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
    bool

    this[int]

    Returns single entry from the collection. Read-only.

    Declaration
    public IHyperLink this[int index] { get; }
    Parameters
    Type Name Description
    int 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
    int

    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.

    string address

    The address of the hyperlink.

    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.

    string address

    The address of the hyperlink.

    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
    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
    object parent

    Parent object for a copy of this instance.

    Returns
    Type Description
    object

    A new object that is a copy of this instance.

    Overrides
    CollectionBaseEx<HyperLinkImpl>.Clone(object)

    CreateHyperlinkStyles()

    Creates hyperlink styles if necessary.

    Declaration
    public void CreateHyperlinkStyles()

    GetHyperlinkByCellIndex(long)

    Gets last hyperlink by cell index.

    Declaration
    public IHyperLink GetHyperlinkByCellIndex(long lCellIndex)
    Parameters
    Type Name Description
    long 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, int)

    Creates collection from IList.

    Declaration
    public int Parse(IList data, int iPos)
    Parameters
    Type Name Description
    IList data

    IList with necessary Biff records.

    int iPos

    Start offset in the array.

    Returns
    Type Description
    int

    Index of the first record after hyperlinks records.

    RemoveAt(int)

    Removes item at the specified index.

    Declaration
    public void RemoveAt(int index)
    Parameters
    Type Name Description
    int index

    Item index to remove.

    Serialize(OffsetArrayList)

    Saves collection into list of BiffRecords.

    Declaration
    [CLSCompliant(false)]
    public void Serialize(OffsetArrayList records)
    Parameters
    Type Name Description
    OffsetArrayList records

    OffsetArrayList with BiffRecords.

    Exceptions
    Type Condition
    ArgumentNullException

    If records parameter is NULL.

    Implements

    IList<T>
    ICollection<T>
    IEnumerable<T>
    IEnumerable
    IHyperLinks
    IParentApplication
    ICloneParent

    Extension Methods

    CalcEngineHelper.ToArray<T>(IEnumerable<T>)
    In this article
    Back to top Generated by DocFX
    Copyright © 2001 - 2026 Syncfusion Inc. All Rights Reserved