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 Filename or URL. Sublocation Named view, range of cells, etc. Description Display name for a Hyperlink.

See also

OdDbEntityHyperlinkPE OdDbHyperlink OdDbHyperlinkCollection

<group OdDb_Classes>

Definition at line 55 of file DbHyperlink.h.

Member Enumeration Documentation

HLinkFlags

enum OdDbHyperlink::HLinkFlags

This enumeration specifies flags that can be set for a hyperlink object.

Enumerator
kUndefined	Undefined
kConvertDwgToDwf	Convert DWG to DWF

Definition at line 61 of file DbHyperlink.h.

Constructor & Destructor Documentation

OdDbHyperlink()

OdDbHyperlink::OdDbHyperlink ( )

inline

Default constructor. Creates a new object of the OdDbHyperlink class.

Definition at line 72 of file DbHyperlink.h.

~OdDbHyperlink()

virtual OdDbHyperlink::~OdDbHyperlink ( )

inlinevirtual

Virtual destructor. Destroys an object of the OdDbHyperlink class and releases all resources that were used by the object.

Definition at line 78 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

Gets flags for this Hyperlink object.

Remarks

Flag values are defined by the HLinkFlags enumeration.

getDisplayString()

virtual const OdString OdDbHyperlink::getDisplayString ( ) const

pure virtual

Returns the display string associated with this Hyperlink object.

Remarks

Returns "<Name> - <SubLocation>" if the description set by setDescription() 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

Sets flags for this Hyperlink object.

Parameters

lFlags

[in] Flags to set.

Remarks

Flag values are defined by the HLinkFlags enumeration.

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