Application Interface Reference

This is the Application Object is providing public callable methods. More...

Inherited by ApplicationImpl.

Public Member Functions
Sub	addApplicationListener (pListener As GDApplicationListener)
Function	displayUI ()
Function	exploreProjectFolder (pProject As GDProject)
Function	getActiveProject () As GDProject
Function	getCommandFactory () As GDCommandFactory
Function	getProjectProperty (pProject As GDProject, pPropertyName As String, Optional stripDelimiter As Boolean=True) As String
Function	getSettings () As ApplicationSettings
Function	hideUI ()
Function	isEventsEnabled () As Boolean
Function	isUIDisplayed () As Boolean
Sub	removeApplicationListener (pListener As GDApplicationListener)
Sub	setEventsEnabled (pValue As Boolean)
Sub	setVBInstance (pVBInstance As VBIDE::VBE, pCurrentAddinInstance As AddIn)
	Initializer of the Application object with current instance of VBIDE.VBE and the Add-in.
Function	storeDocumentableDescription (pDocumentable As GDDocumentable) As String
Function	writeClassDocument (pClass As GDClass, Optional quite As Boolean=False)
	Writes the Documentation tags for the Class Object.
Function	writeOperationDocument (pOperation As GDOperation)
	Writes the Documentation tags for the Operation Object.

Detailed Description

This is the Application Object is providing public callable methods.

Callable methods from external clients are published in Application Object.

Copyright

VBDoxyAddin by javacioc is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. Based on a work at http://sourceforge.net/p/vbdoxyaddin.

Member Function Documentation

Sub Application::addApplicationListener

(

pListener As

GDApplicationListener

)

Parameters

[in,out]

pListener

Function Application::displayUI

(

)

Return values

Variant

Function Application::exploreProjectFolder

(

pProject As

GDProject

)

Parameters

[in,out]

pProject

Return values

Variant

Function Application::getActiveProject

(

)

Return values

GDProject

Function Application::getCommandFactory

(

)

Return values

GDCommandFactory

Function Application::getProjectProperty	(	pProject As	GDProject,
		pPropertyName As	String,
		Optional stripDelimiter As	Boolean = True
	)

Parameters

[in,out]	pProject	The Project in which find the Property
[in,out]	pPropertyName	The PropertyName
[in,out]	stripDelimiter

Return values

String

The PropertyValue

Function Application::getSettings

(

)

Return values

ApplicationSettings

Function Application::hideUI

(

)

Return values

Variant

Function Application::isEventsEnabled

(

)

Return values

Boolean

Function Application::isUIDisplayed

(

)

Return values

Boolean

Sub Application::removeApplicationListener

(

pListener As

GDApplicationListener

)

Parameters

[in,out]

pListener

Sub Application::setEventsEnabled

(

pValue As

Boolean

)

Parameters

[in,out]

pValue

Sub Application::setVBInstance	(	pVBInstance As VBIDE::VBE	,
		pCurrentAddinInstance As	AddIn
	)

Initializer of the Application object with current instance of VBIDE.VBE and the Add-in.

Return values

VBIDE.VBE

This setter method is called once from the AddinConnector Designer to initialize the VBDoxyAddin Application. In the AddinInstance_OnConnection event of the AddinConnector Designer, this method is called passing the required objects got from the Event's parameters.

Parameters

[in,out]	pVBInstance	The instance of the Visual Basic IDE Environment.
[in,out]	pCurrentAddinInstance	The instance of the Add-in is initializing the Application

Function Application::storeDocumentableDescription

(

pDocumentable As

GDDocumentable

)

Parameters

[in,out]

pDocumentable

Return values

String

Function Application::writeClassDocument	(	pClass As	GDClass,
		Optional quite As	Boolean = False
	)

Writes the Documentation tags for the Class Object.

The tagged Doxygen commands are written in the block comment at the topmost lines of the codemodule.

Parameters

[in,out]	pClass	The Class Object to document. It will prompt to the user if documenting operation is also required.
[in,out]	quite	If true the operations will be documented too, without prompting to the user.

Return values

Variant

The function is returning always Nothing.

Function Application::writeOperationDocument

(

pOperation As

GDOperation

)

Writes the Documentation tags for the Operation Object.

The tagged doxygen commands are written in a block comment immediately preceding the operation signature.

Parameters

[in,out]

pOperation

The Operation Object to Document.

Return values

Variant

The function is returning always Nothing.