HtmlAddressingOptions.AddPinnedTopic Method

Namespace

Kampute.DocToolkit.Routing

Assembly

Kampute.DocToolkit.dll

Definition

Adds a topic to the collection of pinned topics.

public bool AddPinnedTopic(string topicId, string relativePath)

Parameters

topicId string: The identifier of the topic to add to the pinned topics.
relativePath string: The relative path associated with the topic.

Returns

bool: true if the topic was successfully added; otherwise, false if a topic with the same name or path already exists.

Exceptions

ArgumentException: Thrown when topicId is null or empty, or if relativePath is not relative or contains invalid characters.