OdDbHyperlink Class

API Reference > OdDb Classes > OdDbHyperlink Class

OdDbHyperlink Class

Class Hierarchy

Syntax

C++

class OdDbHyperlink;

DbHyperlink.h

This class is the base class for Hyperlink objects.

Corresponding C++ library: TD_Db

OdDbHyperlink objects contain the following data:

Name	Description
Hyperlink Name	Filename or URL.
Sublocation	Named view, range of cells, etc.
Description	Display name for a Hyperlink.

OdDbEntityHyperlinkPE
OdDbHyperlink
OdDbHyperlinkCollection

	Name	Description
	~OdDbHyperlink	Virtual destructor. Destroys an object of the OdDbHyperlink class and releases all resources that were used by the object.
	OdDbHyperlink	Default constructor. Creates a new object of the OdDbHyperlink class.

OdDbHyperlink Enumerations

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

OdDbHyperlink Methods

	Name	Description
	description	Returns the description associated with this Hyperlink object.
	flags	Gets flags for this Hyperlink object.
	getDisplayString	Returns the display string associated with this Hyperlink object.
	getNestedLevel	This is getNestedLevel, a member of class OdDbHyperlink.
	isOutermostContainer	Returns true if and only if this Hyperlink object is associated with the outermost container.
	name	Returns the name associated with this Hyperlink object.
	setDescription	Sets the description associated with this Hyperlink object.
	setFlags	Sets flags for this Hyperlink object.
	setName	Sets the name associated with this Hyperlink object.
	setSubLocation	Sets the sublocation associated with this Hyperlink object.
	subLocation	Returns the sublocation associated with this Hyperlink object.

Copyright © 2002–2020. Open Design Alliance. All rights reserved.

Send feedback about this topic