OdDbHyperlink Class Reference

#include <DbHyperlink.h>

Public Types
enum	HLinkFlags { kUndefined = 0, kConvertDwgToDwf = 0x1 }

Public Member Functions
	OdDbHyperlink ()
virtual	~OdDbHyperlink ()
virtual const OdString	name () const =0
virtual void	setName (const OdString &name)=0
virtual const OdString	description () const =0
virtual void	setDescription (const OdString &description)=0
virtual const OdString	subLocation () const =0
virtual void	setSubLocation (const OdString &subLocation)=0
virtual const OdString	getDisplayString () const =0
virtual bool	isOutermostContainer () const =0
virtual int	getNestedLevel () const =0
virtual OdInt32	flags () const =0
virtual void	setFlags (OdInt32 lFlags)=0

Detailed Description

This class is the base class for Hyperlink objects.

Corresponding C++ library: TD_Db

Remarks

OdDbHyperlink objects contain the following data:

Description Hyperlink Name A filename or URL. Sublocation A named view, range of cells, etc. Description A display name for the Hyperlink.

See also

OdDbEntityHyperlinkPE OdDbHyperlink OdDbHyperlinkCollection

<group OdDb_Classes>

Definition at line 56 of file DbHyperlink.h.

Member Enumeration Documentation

HLinkFlags

enum OdDbHyperlink::HLinkFlags

Flags that can be set on the hyperlink object

Enumerator
kUndefined
kConvertDwgToDwf

Definition at line 62 of file DbHyperlink.h.

Constructor & Destructor Documentation

OdDbHyperlink()

OdDbHyperlink::OdDbHyperlink ( )

inline

Definition at line 68 of file DbHyperlink.h.

~OdDbHyperlink()

virtual OdDbHyperlink::~OdDbHyperlink ( )

inlinevirtual

Definition at line 69 of file DbHyperlink.h.

Member Function Documentation

description()

virtual const OdString OdDbHyperlink::description ( ) const

pure virtual

Returns the description associated with this Hyperlink object.

flags()

virtual OdInt32 OdDbHyperlink::flags ( ) const

pure virtual

Get flags that can be set on the hyperlink object

getDisplayString()

virtual const OdString OdDbHyperlink::getDisplayString ( ) const

pure virtual

Returns the display string associated with this Hyperlink object.

Remarks

Returns "<Name> - <SubLocation>" if description() is null.

getNestedLevel()

virtual int OdDbHyperlink::getNestedLevel ( ) const

pure virtual

Returns the nesting level of this Hyperlink object.

isOutermostContainer()

virtual bool OdDbHyperlink::isOutermostContainer ( ) const

pure virtual

Returns true if and only if this Hyperlink object is associated with the outermost container.

name()

virtual const OdString OdDbHyperlink::name ( ) const

pure virtual

Returns the name associated with this Hyperlink object.

setDescription()

virtual void OdDbHyperlink::setDescription ( const OdString &  description )

pure virtual

Sets the description associated with this Hyperlink object.

Parameters

description

[in] Description for this Hyperlink object.

Remarks

"<Name> - <SubLocation>" will be returned by getDisplayString() if description is null.

setFlags()

virtual void OdDbHyperlink::setFlags ( OdInt32  lFlags )

pure virtual

Set flags that can be set on the hyperlink object

setName()

virtual void OdDbHyperlink::setName ( const OdString &  name )

pure virtual

Sets the name associated with this Hyperlink object.

Parameters

name	[in] Name for this Hyperlink object.

setSubLocation()

virtual void OdDbHyperlink::setSubLocation ( const OdString &  subLocation )

pure virtual

Sets the sublocation associated with this Hyperlink object.

Parameters

subLocation

[in] Sublocation for this Hyperlink object.

subLocation()

virtual const OdString OdDbHyperlink::subLocation ( ) const

pure virtual

Returns the sublocation associated with this Hyperlink object.

---

The documentation for this class was generated from the following file:

• DbHyperlink.h