ReferenceItemCollection.AddReference Method

ReferenceItemCollectionAddReference Method

Add a new GAC or file reference item to the collection

Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public ReferenceItem AddReference(
	string referenceName,
	string hintPath
)

Public Function AddReference ( 
	referenceName As String,
	hintPath As String
) As ReferenceItem

public:
ReferenceItem^ AddReference(
	String^ referenceName, 
	String^ hintPath
)

member AddReference : 
        referenceName : string * 
        hintPath : string -> ReferenceItem

Parameters

referenceName: Type: SystemString
The reference name. This will be the GAC name or the base filename for file reference.
hintPath: Type: SystemString
The hint path for file references. For GAC references, this should be null.

Return Value

Type: ReferenceItem
The ReferenceItem added to the project. If the named item already exists in the collection a reference to the existing item is returned.

Remarks

The ReferenceItem constructor is internal so that we control creation of the items and can associate them with a project element.

Reference

ReferenceItemCollection Class

SandcastleBuilder.Utils Namespace