Aspose::Cells::IHyperlink Class Referenceabstract

Encapsulates the object that represents a hyperlink. More...

Inherits Object.

Public Member Functions

virtual intrusive_ptr< Aspose::Cells::Systems::String > GetAddress ()=0
 Represents the address of a hyperlink. More...
 
virtual void SetAddress (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Represents the address of a hyperlink. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetTextToDisplay ()=0
 Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink. More...
 
virtual void SetTextToDisplay (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink. More...
 
virtual intrusive_ptr< Aspose::Cells::ICellAreaGetIArea ()=0
 Gets the range of hyperlink. More...
 
virtual intrusive_ptr< Aspose::Cells::Systems::String > GetScreenTip ()=0
 Gets the screen tip text for the specified hyperlink. More...
 
virtual void SetScreenTip (intrusive_ptr< Aspose::Cells::Systems::String > value)=0
 Sets the screen tip text for the specified hyperlink. More...
 
virtual Aspose::Cells::TargetModeType GetLinkType ()=0
 Gets the link type. More...
 
virtual void Delete ()=0
 Deletes this hyperlink More...
 

Detailed Description

Encapsulates the object that represents a hyperlink.

[C++]
//Instantiating a Workbook object
intrusive_ptr<Aspose::Cells::IWorkbook> workbook = Factory::CreateIWorkbook();
//Adding a new worksheet to the Workbook object
workbook->GetIWorksheets()->Add();
//Obtaining the reference of the newly added worksheet by passing its sheet index
intrusive_ptr<IWorksheet> worksheet = workbook->GetIWorksheets()->GetObjectByIndex(0);
//Adding a hyperlink to a URL at "A1" cell
worksheet->GetIHyperlinks()->Add(new String("A1"), 1, 1, new String("http://www.aspose.com"));
//Saving the Excel file
workbook->Save(new String("C:\\IHyperlinkTest.xls"));

Member Function Documentation

◆ Delete()

virtual void Aspose::Cells::IHyperlink::Delete ( )
pure virtual

Deletes this hyperlink

◆ GetAddress()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IHyperlink::GetAddress ( )
pure virtual

Represents the address of a hyperlink.

◆ GetIArea()

virtual intrusive_ptr<Aspose::Cells::ICellArea> Aspose::Cells::IHyperlink::GetIArea ( )
pure virtual

Gets the range of hyperlink.

◆ GetLinkType()

virtual Aspose::Cells::TargetModeType Aspose::Cells::IHyperlink::GetLinkType ( )
pure virtual

Gets the link type.

◆ GetScreenTip()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IHyperlink::GetScreenTip ( )
pure virtual

Gets the screen tip text for the specified hyperlink.

◆ GetTextToDisplay()

virtual intrusive_ptr<Aspose::Cells::Systems::String> Aspose::Cells::IHyperlink::GetTextToDisplay ( )
pure virtual

Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.

◆ SetAddress()

virtual void Aspose::Cells::IHyperlink::SetAddress ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Represents the address of a hyperlink.

◆ SetScreenTip()

virtual void Aspose::Cells::IHyperlink::SetScreenTip ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Sets the screen tip text for the specified hyperlink.

◆ SetTextToDisplay()

virtual void Aspose::Cells::IHyperlink::SetTextToDisplay ( intrusive_ptr< Aspose::Cells::Systems::String >  value)
pure virtual

Represents the text to be displayed for the specified hyperlink. The default value is the address of the hyperlink.