ResolveReferenceLinksComponent.CreateMemberIdResolver Method

Definition

Namespace

Sandcastle.Tools.BuildComponents

Assembly

Sandcastle.Tools.BuildComponents.dll

CreateMemberIdResolver(XPathNavigator)

This is used to create a member ID URL resolver for the component to use in looking up help website URLs.

protected virtual IMemberIdUrlResolver CreateMemberIdResolver(XPathNavigator configuration)

Parameters

configuration XPathNavigator

The component configuration

Returns

IMemberIdUrlResolver

An IMemberIdUrlResolver instance

Remarks

This can be overridden in derived classes to provide persistent caches with backing stores other than the default dictionary serialized to a binary file. It also allows sharing the cache across instances by placing it in the Data dictionary using the key name SharedMemberUrlCacheId.

If overridden, the UpdateUrlCache() method should also be overridden to persist changes to the cache if needed.

CreateMemberIdResolver(IDictionary<string, string>, bool)

This is used to create a member ID URL resolver for the component to use in looking up help website URLs.

protected virtual IMemberIdUrlResolver CreateMemberIdResolver(IDictionary<string, string> cache, bool isShared)

Parameters

cache IDictionary<string, string>

A cache of existing URLs or null to use the default cache.

isShared bool

True if the cache is shared, false if not. If not shared, the cache will be disposed of when the instance is disposed of. If cache is null, this parameter is ignored.

Returns

IMemberIdUrlResolver

An IMemberIdUrlResolver instance