API Reference
Class
AsciiDocReferenceCatalog
A source-ordered snapshot of explicit anchors, generated section IDs, and footnotes, including compound blocks.
Inheritance
- Object
- AsciiDocReferenceCatalog
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
Methods
public static AsciiDocReferenceCatalog Create(AsciiDocDocument document, Int32 maximumNestingDepth = 64, CancellationToken cancellationToken = default) #Returns:
AsciiDocReferenceCatalogBuilds a bounded snapshot without preprocessing includes or fetching resources.
Parameters
- document OfficeIMO.AsciiDoc.AsciiDocDocument
- maximumNestingDepth System.Int32 = 64
- cancellationToken System.Threading.CancellationToken = default
public String GetBlockId(AsciiDocBlock block) #Returns:
StringGets the catalog's explicit or generated ID for a block, or null when it has none.
Parameters
- block OfficeIMO.AsciiDoc.AsciiDocBlock
public String GetFootnoteLabel(AsciiDocFootnoteInline footnote) #Returns:
StringFinds the stable catalog label for a source footnote or returns null.
Parameters
- footnote OfficeIMO.AsciiDoc.AsciiDocFootnoteInline
Inherited Methods
public override Boolean Equals(Object obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object
Properties
public IReadOnlyDictionary<String, AsciiDocReferenceTarget> Targets { get; } #Explicit and generated anchor targets, keyed with ordinal comparison.
public IReadOnlyDictionary<String, AsciiDocFootnoteInline> Footnotes { get; } #Footnote definitions in source order. Repeated references share one definition.
public IReadOnlyList<AsciiDocReferenceDiagnostic> Diagnostics { get; } #Duplicate targets, conflicting definitions, and dangling references.