InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IHyperlinkAppearanceData Class Referenceabstract
Inheritance diagram for IHyperlinkAppearanceData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPERLINKAPPEARANCEDATA }
 
enum  HyperlinkHilight { kNoHyperlinkHilight = 0, kInvertHyperlinkHilight = 1, kInsetHyperlinkHilight = 2, kOutlineHyperlinkHilight = 3 }
 
enum  HyperlinkOutlineLineStyle { kHyperlinkSolidOutline = 0, kHyperlinkDashedOutline = 1 }
 

Public Member Functions

virtual void SetVisible (const bool16 bIsVisible)=0
 
virtual bool16 GetVisible () const =0
 
virtual void SetBorderLineWidth (const int32 strokeWidthInPixels)=0
 
virtual int32 GetBorderLineWidth () const =0
 
virtual void SetHyperlinkHilight (IHyperlinkAppearanceData::HyperlinkHilight hilightType)=0
 
virtual HyperlinkHilight GetHyperlinkHilight () const =0
 
virtual void SetBorderColorUID (const UID interfaceColorUID)=0
 
virtual const UID GetBorderColorUID () const =0
 
virtual void SetHyperlinkOutlineLineStyle (HyperlinkOutlineLineStyle style)=0
 
virtual HyperlinkOutlineLineStyle GetHyperlinkOutlineLineStyle () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual const UID IHyperlinkAppearanceData::GetBorderColorUID () const
pure virtual

Get the color of the hyperlink border

Parameters
none
Returns
const UID - UID of the UI color to use
virtual int32 IHyperlinkAppearanceData::GetBorderLineWidth () const
pure virtual

Get the thickness of the border of the hyperlink

Parameters
none
Returns
int32 - Thickness in pixels
virtual HyperlinkHilight IHyperlinkAppearanceData::GetHyperlinkHilight () const
pure virtual

Get the hilight style

Returns
HyperlinkHilight - The hilight style (This only matters when the file is exported to PDF
virtual HyperlinkOutlineLineStyle IHyperlinkAppearanceData::GetHyperlinkOutlineLineStyle () const
pure virtual

Get the outline style

Parameters
none
Returns
HyperlinkOutlineLineStyle - Style to use
virtual bool16 IHyperlinkAppearanceData::GetVisible () const
pure virtual

Get whether this hyperlink is visible in the layout window

Parameters
none
Returns
bool16 - kTrue == visible
virtual void IHyperlinkAppearanceData::SetBorderColorUID (const UID interfaceColorUID)
pure virtual

Set the color of the hyperlink border

Parameters
interfaceColorUID- UID of the UI color to use
virtual void IHyperlinkAppearanceData::SetBorderLineWidth (const int32 strokeWidthInPixels)
pure virtual

Set the thickness of the border of the hyperlink

Parameters
strokeWidthInPixels- 1 == thin, 2 == medium, 3 == thick
virtual void IHyperlinkAppearanceData::SetHyperlinkHilight (IHyperlinkAppearanceData::HyperlinkHilight hilightType)
pure virtual

Set the hilight style

Parameters
hilightType- The hilight style (This only matters when the file is exported to PDF
virtual void IHyperlinkAppearanceData::SetHyperlinkOutlineLineStyle (HyperlinkOutlineLineStyle style)
pure virtual

Set the outline style

Parameters
style- kHyperlinkSolidOutline == solid line, kHyperlinkDashedOutline == dashed line
virtual void IHyperlinkAppearanceData::SetVisible (const bool16 bIsVisible)
pure virtual

Set whether this hyperlink is visible in the layout window

Parameters
bIsVisible- kTrue == Visible