Represents Microsoft Excel Hyperlink object. More...

#include <wxAutoExcelHyperlinks.h>

Inheritance diagram for wxAutoExcel::wxExcelHyperlink:

Public Member Functions
void	AddToFavorites ()
	Adds a shortcut to the workbook or hyperlink to the Favorites folder.

void	CreateNewDocument (const wxString &fileName, bool editNow, bool overwrite)
	Creates a new document linked to the specified hyperlink.

void	Delete ()
	Deletes the object.

void	Follow (wxXlTribool newWindow=wxDefaultXlTribool, wxXlTribool addHistory=wxDefaultXlTribool, MsoExtraInfoMethod *method=NULL, const wxString &headerInfo=wxEmptyString)
	Displays a cached document, if it�s already been downloaded.

wxString	GetAddress ()
	Returns a String value that represents the address of the target document.

void	SetAddress (const wxString &address)
	Sets a String value that represents the address of the target document.

wxString	GetEmailSubject ()
	Returns the text string of the specified hyperlink�s e-mail subject line.

void	SetEmailSubject (const wxString &emailSubject)
	Sets the text string of the specified hyperlink�s e-mail subject line.

wxString	GetName ()
	Returns a String value that represents the name of the object.

wxExcelRange	GetRange ()
	Returns a Range Represents the range the specified hyperlink is attached to.

wxString	GetScreenTip ()
	Returns the ScreenTip text for the specified hyperlink.

void	SetScreenTip (const wxString &screenTip)
	Sets the ScreenTip text for the specified hyperlink.

wxExcelShape	GetShape ()
	Returns a Shape Represents the shape attached to the specified hyperlink.

wxString	GetSubAddress ()
	Returns the location within the document associated with the hyperlink.

void	SetSubAddress (const wxString &subAddress)
	Sets the location within the document associated with the hyperlink.

wxString	GetTextToDisplay ()
	Returns the text to be displayed for the specified hyperlink.

void	SetTextToDisplay (const wxString &textToDisplay)
	Sets the text to be displayed for the specified hyperlink.

MsoHyperlinkType	GetType ()
	Returns a Long value, containing a MsoHyperlinkType constant, that represents the location of the HTML frame.

virtual wxString	GetAutoExcelObjectName_ () const
	Returns "Hyperlink".

Public Member Functions inherited from wxAutoExcel::wxExcelObject
bool	IsOk_ () const
	Returns true if the object has a valid dispatch.

wxString	GetAutomationObjectName_ (bool stripUnderscores=false) const
	Returns object name as provided by IDispatch->GetTypeInfo()->GetDocumentation(MEMBERID_NIL, &name, NULL, NULL, NULL).

wxSharedPtr< wxAutomationObject >	GetAutomationObject_ ()
	Returns the underlying wxAutomationObject.

	operator bool () const
	Returns true if the object has a valid dispatch and its last automation call (if any), i.e.

WXLCID	GetAutomationLCID_ () const
	Returns the locale identifier used in automation calls.

bool	SetAutomationLCID_ (WXLCID lcid)
	Sets the locale identifier to be used in automation calls.

bool	GetPropertyAndMethodNames_ (wxArrayString &propertyNames, wxArrayString &methodNames, bool includeHidden=false)
	Returns lists of property and method names the automation interface exposes.

bool	GetUnimplementedObject_ (const wxString &name, wxAutomationObject &object)
	Helper function for receiving an automation object not implemented in wxAutoExcel, see FAQ on how to use.

Additional Inherited Members
Public Types inherited from wxAutoExcel::wxExcelObject
enum	ErrorFlags { Err_DoNothing = 0 , Err_LogOnInvalidDispatch = 1 , Err_AssertOnInvalidDispatch = 1 << 1 , Err_ThrowOnInvalidDispatch = 1 << 2 , Err_LogOnInvalidArgument = 1 << 3 , Err_AssertOnInvalidArgument = 1 << 4 , Err_ThrowOnInvalidArgument = 1 << 5 , Err_LogOnFailedInvoke = 1 << 6 , Err_AssertOnFailedInvoke = 1 << 7 , Err_ThrowOnFailedInvoke = 1 << 8 , Err_LogOnInvalidReturnType = 1 << 9 , Err_AssertOnInvalidReturnType = 1 << 10 , Err_ThrowOnInvalidReturnType = 1 << 11 , Err_LogOnOtherError = 1 << 12 , Err_AssertOnOtherError = 1 << 13 , Err_ThrowOnOtherError = 1 << 14 }
	Flags affecting the behaviour of wxExcelObject and its descendants when an error occurs during accessing an Excel object property or calling its method. More...

Static Public Member Functions inherited from wxAutoExcel::wxExcelObject
static unsigned	GetErrorMode_ ()
	Sets the error mode to the combination of wxExcelObject::ErrorFlags.

static void	SetErrorMode_ (unsigned mode)
	Sets the error mode as the combination of wxExcelObject::ErrorFlags.

static bool	GetUnimplementedCollectionItem_ (wxAutomationObject &collection, const long index, wxAutomationObject &item, bool asProperty)
	Helper function for obtaining an item from MS Excel collection not implemented in wxAutoExcel, see FAQ on how to use.

Detailed Description

Represents Microsoft Excel Hyperlink object.

Member Function Documentation

◆ AddToFavorites()

void wxAutoExcel::wxExcelHyperlink::AddToFavorites ( )

Adds a shortcut to the workbook or hyperlink to the Favorites folder.

MSDN documentation for Hyperlink.AddToFavorites.

◆ CreateNewDocument()

void wxAutoExcel::wxExcelHyperlink::CreateNewDocument	(	const wxString &	fileName,
		bool	editNow,
		bool	overwrite
	)

Creates a new document linked to the specified hyperlink.

MSDN documentation for Hyperlink.CreateNewDocument.

◆ Delete()

void wxAutoExcel::wxExcelHyperlink::Delete ( )

Deletes the object.

MSDN documentation for Hyperlink.Delete.

◆ Follow()

void wxAutoExcel::wxExcelHyperlink::Follow	(	wxXlTribool	newWindow = `wxDefaultXlTribool`,
		wxXlTribool	addHistory = `wxDefaultXlTribool`,
		MsoExtraInfoMethod *	method = `NULL`,
		const wxString &	headerInfo = `wxEmptyString`
	)

Displays a cached document, if it�s already been downloaded.

Otherwise, this method resolves the hyperlink, downloads the target document, and displays the document in the appropriate application.

MSDN documentation for Hyperlink.Follow.

◆ GetAddress()

wxString wxAutoExcel::wxExcelHyperlink::GetAddress ( )

Returns a String value that represents the address of the target document.

MSDN documentation for Hyperlink.Address.

◆ SetAddress()

void wxAutoExcel::wxExcelHyperlink::SetAddress ( const wxString & address )

Sets a String value that represents the address of the target document.

MSDN documentation for Hyperlink.Address.

◆ GetEmailSubject()

wxString wxAutoExcel::wxExcelHyperlink::GetEmailSubject ( )

Returns the text string of the specified hyperlink�s e-mail subject line.

The subject line is appended to the hyperlink�s address.

MSDN documentation for Hyperlink.EmailSubject.

◆ SetEmailSubject()

void wxAutoExcel::wxExcelHyperlink::SetEmailSubject ( const wxString & emailSubject )

Sets the text string of the specified hyperlink�s e-mail subject line.

The subject line is appended to the hyperlink�s address.

MSDN documentation for Hyperlink.EmailSubject.

◆ GetName()

wxString wxAutoExcel::wxExcelHyperlink::GetName ( )

Returns a String value that represents the name of the object.

MSDN documentation for Hyperlink.Name.

◆ GetRange()

wxExcelRange wxAutoExcel::wxExcelHyperlink::GetRange ( )

Returns a Range Represents the range the specified hyperlink is attached to.

MSDN documentation for Hyperlink.Range.

◆ GetScreenTip()

wxString wxAutoExcel::wxExcelHyperlink::GetScreenTip ( )

Returns the ScreenTip text for the specified hyperlink.

MSDN documentation for Hyperlink.ScreenTip.

◆ SetScreenTip()

void wxAutoExcel::wxExcelHyperlink::SetScreenTip ( const wxString & screenTip )

Sets the ScreenTip text for the specified hyperlink.

MSDN documentation for Hyperlink.ScreenTip.

◆ GetShape()

wxExcelShape wxAutoExcel::wxExcelHyperlink::GetShape ( )

Returns a Shape Represents the shape attached to the specified hyperlink.

MSDN documentation for Hyperlink.Shape.

◆ GetSubAddress()

wxString wxAutoExcel::wxExcelHyperlink::GetSubAddress ( )

Returns the location within the document associated with the hyperlink.

MSDN documentation for Hyperlink.SubAddress.

◆ SetSubAddress()

void wxAutoExcel::wxExcelHyperlink::SetSubAddress ( const wxString & subAddress )

Sets the location within the document associated with the hyperlink.

MSDN documentation for Hyperlink.SubAddress.

◆ GetTextToDisplay()

wxString wxAutoExcel::wxExcelHyperlink::GetTextToDisplay ( )

Returns the text to be displayed for the specified hyperlink.

The default value is the address of the hyperlink.

MSDN documentation for Hyperlink.TextToDisplay.

◆ SetTextToDisplay()

void wxAutoExcel::wxExcelHyperlink::SetTextToDisplay ( const wxString & textToDisplay )

Sets the text to be displayed for the specified hyperlink.

The default value is the address of the hyperlink.

MSDN documentation for Hyperlink.TextToDisplay.

◆ GetType()

MsoHyperlinkType wxAutoExcel::wxExcelHyperlink::GetType ( )

Returns a Long value, containing a MsoHyperlinkType constant, that represents the location of the HTML frame.

MSDN documentation for Hyperlink.Type.

◆ GetAutoExcelObjectName_()

virtual wxString wxAutoExcel::wxExcelHyperlink::GetAutoExcelObjectName_ ( ) const

inlinevirtual

Returns "Hyperlink".

Reimplemented from wxAutoExcel::wxExcelObject.

Public Member Functions

Additional Inherited Members