IShapeOptionList.AsHyperLink Method
Overloads
IShapeOptionList.AsHyperLink(TShapeOption, TDrawingHyperlink)
Returns an hyperlink property if it exists, otherwise the default value.
You will normally want to use this property with TShapeOption.pihlShape since that is the property that holds the link for the objects. Note that this overload won't return a LinkBase, you need to call the overload taking an ExcelFile for that.
Syntax
Unit: FlexCel.Core
function IShapeOptionList.AsHyperLink(const key: TShapeOption; const Default: TDrawingHyperlink): TDrawingHyperlink; overload; virtual; abstract;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
key |
TShapeOption |
Property Name. |
| const |
Default |
TDrawingHyperlink |
What to return if the property does not exist. |
See also
IShapeOptionList.AsHyperLink(TCoreExcelFile, TShapeOption, TDrawingHyperlink)
Returns an hyperlink property if it exists, otherwise the default value.
You will normally want to use this property with TShapeOption.pihlShape since that is the property that holds the link for the objects.
Syntax
Unit: FlexCel.Core
function IShapeOptionList.AsHyperLink(const xls: TCoreExcelFile; const key: TShapeOption; const Default: TDrawingHyperlink): TDrawingHyperlink; overload; virtual; abstract;
Parameters
| <-> |
Parameter |
Type |
Description |
| const |
xls |
TCoreExcelFile |
Excel file containing the hyperlink. Might be null. If not null, it is used to search for a hyperlink base. |
| const |
key |
TShapeOption |
Property Name. |
| const |
Default |
TDrawingHyperlink |
What to return if the property does not exist. |
See also