IReadOnlyTopicCollection Interface
- Namespace
- Kampute.DocToolkit.Collections
- Assembly
- Kampute.DocToolkit.dll
Definition
Represents a read-only collection of top-level topics in a documentation context.
public interface IReadOnlyTopicCollection : IReadOnlyCollection<TopicModel>- Extends
- Implemented by
Remarks
This interface provides immutable access to topic instances in a documentation context. It allows efficient lookup by topic identifier or URI reference for cross-referencing topics within documentation.
Properties
| Context | Gets the documentation context associated with this collection of topics. |
| Flatten | Gets all topics in the collection, including all nested topics. |
Methods
| TryFindBySubpath(string, out TopicModel) | Attempts to find a file-backed topic in the topic hierarchy by its subpaths. |
| TryGetByFilePath(string, out TopicModel) | Attempts to lookup a file-backed topic in the topic hierarchy by its exact source file path. |
| TryGetById(string, out TopicModel) | Attempts to lookup a topic in the topic hierarchy by its qualified identifier. |
| TryResolve(string, out TopicModel) | Attempts to resolve a topic in the collection based on the provided reference string. |