API Reference
MarkdownNativeDocument
Native, AST-backed projection of a parsed markdown document for UI hosts that need structured blocks and source spans.
Inheritance
- Object
- MarkdownNativeDocument
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 IEnumerable<TBlock> BlocksOfType<TBlock>() #IEnumerable<TBlock>Enumerates top-level native blocks of the requested projection type.
Type Parameters
- TBlock
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownAbbreviationDefinition abbreviationDefinition, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces an abbreviation definition.
Parameters
- abbreviationDefinition OfficeIMO.Markdown.MarkdownAbbreviationDefinition
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeAbbreviationDefinitionField field, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces an abbreviation definition field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeAbbreviationDefinitionField
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownSourceSpan sourceSpan, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a source span.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeBlock block, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native block.
Parameters
- block OfficeIMO.Markdown.MarkdownNativeBlock
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeInline inline, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native inline.
Parameters
- inline OfficeIMO.Markdown.MarkdownNativeInline
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeListItem listItem, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces the source-backed content span of a native list item.
Parameters
- listItem OfficeIMO.Markdown.MarkdownNativeListItem
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeListItemParagraph paragraph, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a paragraph owned by a native list item.
Parameters
- paragraph OfficeIMO.Markdown.MarkdownNativeListItemParagraph
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownReferenceLinkDefinition referenceDefinition, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a reference-style link definition.
Parameters
- referenceDefinition OfficeIMO.Markdown.MarkdownReferenceLinkDefinition
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeTableCell tableCell, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native table cell.
Parameters
- tableCell OfficeIMO.Markdown.MarkdownNativeTableCell
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeTableRow tableRow, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native table row payload.
Parameters
- tableRow OfficeIMO.Markdown.MarkdownNativeTableRow
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeDefinitionListGroup definitionGroup, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native definition-list group.
Parameters
- definitionGroup OfficeIMO.Markdown.MarkdownNativeDefinitionListGroup
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeDefinitionListTerm definitionTerm, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native definition-list term.
Parameters
- definitionTerm OfficeIMO.Markdown.MarkdownNativeDefinitionListTerm
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeDefinitionListDefinition definition, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native definition-list definition body.
Parameters
- definition OfficeIMO.Markdown.MarkdownNativeDefinitionListDefinition
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeInlineMetadata metadata, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces source-backed inline metadata.
Parameters
- metadata OfficeIMO.Markdown.MarkdownNativeInlineMetadata
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeSourceTrivia trivia, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces document-level source trivia.
Parameters
- trivia OfficeIMO.Markdown.MarkdownNativeSourceTrivia
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeReferenceLinkDefinitionField field, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a reference-style link definition field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeReferenceLinkDefinitionField
- replacementMarkdown System.String
public MarkdownNativeSourceEdit CreateReplaceEdit(MarkdownNativeBlockSourceField field, String replacementMarkdown) #MarkdownNativeSourceEditCreates a non-mutating source edit that replaces a native block source field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeBlockSourceField
- replacementMarkdown System.String
public IEnumerable<MarkdownNativeBlock> DescendantBlocksAndSelf() #IEnumerable<MarkdownNativeBlock>Enumerates all native blocks in document order, including nested blocks.
public IEnumerable<MarkdownNativeAbbreviationDefinitionField> EnumerateAbbreviationDefinitionFields() #IEnumerable<MarkdownNativeAbbreviationDefinitionField>Enumerates source-backed abbreviation definition fields in document order.
public IEnumerable<MarkdownNativeAbbreviationDefinitionField> EnumerateAbbreviationDefinitionFields(String name) #IEnumerable<MarkdownNativeAbbreviationDefinitionField>Enumerates source-backed abbreviation definition fields with the supplied field name in document order.
Parameters
- name System.String
public IEnumerable<MarkdownNativeBlockSourceField> EnumerateBlockSourceFields() #IEnumerable<MarkdownNativeBlockSourceField>Enumerates source-backed block fields in document order.
public IEnumerable<MarkdownNativeBlockSourceField> EnumerateBlockSourceFields(String name) #IEnumerable<MarkdownNativeBlockSourceField>Enumerates source-backed block fields with the supplied field name in document order.
Parameters
- name System.String
public IEnumerable<MarkdownNativeDefinitionListDefinition> EnumerateDefinitionListDefinitions() #IEnumerable<MarkdownNativeDefinitionListDefinition>Enumerates all native definition-list definitions in document order, including nested definition lists.
public IEnumerable<MarkdownNativeDefinitionListGroup> EnumerateDefinitionListGroups() #IEnumerable<MarkdownNativeDefinitionListGroup>Enumerates all native definition-list groups in document order, including nested definition lists.
public IEnumerable<MarkdownNativeDefinitionListTerm> EnumerateDefinitionListTerms() #IEnumerable<MarkdownNativeDefinitionListTerm>Enumerates all native definition-list terms in document order, including nested definition lists.
public IEnumerable<MarkdownNativeInlineMetadata> EnumerateInlineMetadata() #IEnumerable<MarkdownNativeInlineMetadata>Enumerates all source-backed native inline metadata leaves in document order.
public IEnumerable<MarkdownNativeInlineMetadata> EnumerateInlineMetadata(String name) #IEnumerable<MarkdownNativeInlineMetadata>Enumerates source-backed native inline metadata leaves with the supplied metadata name in document order.
Parameters
- name System.String
public IEnumerable<MarkdownNativeInline> EnumerateInlines() #IEnumerable<MarkdownNativeInline>Enumerates all native inline runs in document order.
public IEnumerable<MarkdownNativeListItem> EnumerateListItems() #IEnumerable<MarkdownNativeListItem>Enumerates all native list items in document order, including nested list items.
public IEnumerable<MarkdownNativeReferenceLinkDefinitionField> EnumerateReferenceLinkDefinitionFields() #IEnumerable<MarkdownNativeReferenceLinkDefinitionField>Enumerates source-backed reference-style link definition fields in document order.
public IEnumerable<MarkdownNativeReferenceLinkDefinitionField> EnumerateReferenceLinkDefinitionFields(String name) #IEnumerable<MarkdownNativeReferenceLinkDefinitionField>Enumerates source-backed reference-style link definition fields with the supplied field name in document order.
Parameters
- name System.String
public IEnumerable<MarkdownNativeSourceTrivia> EnumerateSourceTrivia(MarkdownNativeSourceTriviaKind kind) #IEnumerable<MarkdownNativeSourceTrivia>Enumerates document-level source trivia of the requested kind in source order.
Parameters
- kind OfficeIMO.Markdown.MarkdownNativeSourceTriviaKind
public IEnumerable<MarkdownNativeTableCell> EnumerateTableCells() #IEnumerable<MarkdownNativeTableCell>Enumerates all native table cells in document order, including cells in nested tables.
public IEnumerable<MarkdownNativeTableRow> EnumerateTableRows() #IEnumerable<MarkdownNativeTableRow>Enumerates all native table rows in document order, including rows in nested tables.
public MarkdownAbbreviationDefinition FindAbbreviationDefinitionAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownAbbreviationDefinitionFinds the first abbreviation definition whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeAbbreviationDefinitionField FindAbbreviationDefinitionFieldAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeAbbreviationDefinitionFieldFinds the first abbreviation definition field whose span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeBlock FindBlockAtLine(Int32 lineNumber) #MarkdownNativeBlockFinds the first native block whose source span contains the supplied 1-based line.
Parameters
- lineNumber System.Int32
public MarkdownNativeBlock FindBlockAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeBlockFinds the first native block whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeBlock FindBlockById(String id) #MarkdownNativeBlockFinds a native block by deterministic id.
Parameters
- id System.String
public MarkdownNativeBlockSourceField FindBlockSourceFieldAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeBlockSourceFieldFinds the first source-backed block field whose span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeDefinitionListDefinition FindDefinitionListDefinitionAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeDefinitionListDefinitionFinds the deepest native definition-list definition whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeDefinitionListGroup FindDefinitionListGroupAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeDefinitionListGroupFinds the deepest native definition-list group whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeDefinitionListTerm FindDefinitionListTermAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeDefinitionListTermFinds the native definition-list term whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeInline FindInlineAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeInlineFinds the first native inline whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeInline FindInlineById(String id) #MarkdownNativeInlineFinds a native inline by deterministic id.
Parameters
- id System.String
public MarkdownNativeInlineMetadata FindInlineMetadataAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeInlineMetadataFinds the first native inline metadata leaf whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeListItem FindListItemAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeListItemFinds the deepest native list item whose content or marker source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeListItem FindListItemById(String id) #MarkdownNativeListItemFinds a native list item by deterministic id.
Parameters
- id System.String
public MarkdownReferenceLinkDefinition FindReferenceLinkDefinitionAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownReferenceLinkDefinitionFinds the first reference-style link definition whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeReferenceLinkDefinitionField FindReferenceLinkDefinitionFieldAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeReferenceLinkDefinitionFieldFinds the first reference-style link definition field whose span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeSourceTrivia FindSourceTriviaAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeSourceTriviaFinds the first document-level source trivia whose span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeTableCell FindTableCellAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeTableCellFinds the deepest native table cell whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public MarkdownNativeTableRow FindTableRowAtPosition(Int32 lineNumber, Int32 columnNumber) #MarkdownNativeTableRowFinds the deepest native table row whose source span contains the supplied 1-based line and column.
Parameters
- lineNumber System.Int32
- columnNumber System.Int32
public static MarkdownNativeDocument FromParseResult(MarkdownParseResult parseResult, String sourceMarkdown = null, MarkdownNativeDocumentSourceKind sourceKind = ReaderInput) #MarkdownNativeDocumentBuilds a native projection from an existing syntax-backed parse result.
Parameters
- parseResult OfficeIMO.Markdown.MarkdownParseResult
- sourceMarkdown System.String = null
- sourceKind OfficeIMO.Markdown.MarkdownNativeDocumentSourceKind = ReaderInput
public IReadOnlyList<MarkdownNativeBlock> GetBlockPath(String id) #IReadOnlyList<MarkdownNativeBlock>Returns the top-level-to-target block path for a block id.
Parameters
- id System.String
public static MarkdownNativeDocument Parse(String markdown, MarkdownReaderOptions options = null) #MarkdownNativeDocumentParses markdown into the typed object model, syntax tree, diagnostics, and native block projection.
Parameters
- markdown System.String
- options OfficeIMO.Markdown.MarkdownReaderOptions = null
public MarkdownNativeDocumentSnapshot ToSnapshot() #MarkdownNativeDocumentSnapshotCreates a UI-safe snapshot of this document without parser object references.
public Boolean TryCreateOriginalSourceSlice(MarkdownAbbreviationDefinition abbreviationDefinition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs an abbreviation definition when trivia was preserved.
Parameters
- abbreviationDefinition OfficeIMO.Markdown.MarkdownAbbreviationDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownAbbreviationDefinition abbreviationDefinition, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs an abbreviation definition when trivia was preserved.
Parameters
- abbreviationDefinition OfficeIMO.Markdown.MarkdownAbbreviationDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeAbbreviationDefinitionField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs an abbreviation definition field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeAbbreviationDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeAbbreviationDefinitionField field, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs an abbreviation definition field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeAbbreviationDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs the supplied source span when trivia was preserved.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs the supplied source span when trivia was preserved.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeBlock block, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native block when trivia was preserved.
Parameters
- block OfficeIMO.Markdown.MarkdownNativeBlock
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeBlock block, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native block when trivia was preserved.
Parameters
- block OfficeIMO.Markdown.MarkdownNativeBlock
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeBlockSourceField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native block source field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeBlockSourceField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeBlockSourceField field, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native block source field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeBlockSourceField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeSourceTrivia trivia, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs document-level source trivia when trivia was preserved.
Parameters
- trivia OfficeIMO.Markdown.MarkdownNativeSourceTrivia
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeSourceTrivia trivia, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs document-level source trivia when trivia was preserved.
Parameters
- trivia OfficeIMO.Markdown.MarkdownNativeSourceTrivia
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeInline inline, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native inline when trivia was preserved.
Parameters
- inline OfficeIMO.Markdown.MarkdownNativeInline
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeInline inline, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native inline when trivia was preserved.
Parameters
- inline OfficeIMO.Markdown.MarkdownNativeInline
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeInlineMetadata metadata, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs source-backed inline metadata when trivia was preserved.
Parameters
- metadata OfficeIMO.Markdown.MarkdownNativeInlineMetadata
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeInlineMetadata metadata, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs source-backed inline metadata when trivia was preserved.
Parameters
- metadata OfficeIMO.Markdown.MarkdownNativeInlineMetadata
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeListItem listItem, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs the source-backed content span of a native list item when trivia was preserved.
Parameters
- listItem OfficeIMO.Markdown.MarkdownNativeListItem
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeListItem listItem, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs the source-backed content span of a native list item when trivia was preserved.
Parameters
- listItem OfficeIMO.Markdown.MarkdownNativeListItem
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeListItemParagraph paragraph, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a paragraph owned by a native list item when trivia was preserved.
Parameters
- paragraph OfficeIMO.Markdown.MarkdownNativeListItemParagraph
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeListItemParagraph paragraph, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a paragraph owned by a native list item when trivia was preserved.
Parameters
- paragraph OfficeIMO.Markdown.MarkdownNativeListItemParagraph
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownReferenceLinkDefinition referenceDefinition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a reference-style link definition when trivia was preserved.
Parameters
- referenceDefinition OfficeIMO.Markdown.MarkdownReferenceLinkDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownReferenceLinkDefinition referenceDefinition, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a reference-style link definition when trivia was preserved.
Parameters
- referenceDefinition OfficeIMO.Markdown.MarkdownReferenceLinkDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeReferenceLinkDefinitionField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a reference-style link definition field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeReferenceLinkDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeReferenceLinkDefinitionField field, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a reference-style link definition field when trivia was preserved.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeReferenceLinkDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeTableCell tableCell, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native table cell when trivia was preserved.
Parameters
- tableCell OfficeIMO.Markdown.MarkdownNativeTableCell
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeTableCell tableCell, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native table cell when trivia was preserved.
Parameters
- tableCell OfficeIMO.Markdown.MarkdownNativeTableCell
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeTableRow tableRow, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native table row when trivia was preserved.
Parameters
- tableRow OfficeIMO.Markdown.MarkdownNativeTableRow
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeTableRow tableRow, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native table row when trivia was preserved.
Parameters
- tableRow OfficeIMO.Markdown.MarkdownNativeTableRow
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListGroup definitionGroup, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native definition-list group when trivia was preserved.
Parameters
- definitionGroup OfficeIMO.Markdown.MarkdownNativeDefinitionListGroup
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListGroup definitionGroup, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native definition-list group when trivia was preserved.
Parameters
- definitionGroup OfficeIMO.Markdown.MarkdownNativeDefinitionListGroup
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListTerm definitionTerm, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native definition-list term when trivia was preserved.
Parameters
- definitionTerm OfficeIMO.Markdown.MarkdownNativeDefinitionListTerm
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListTerm definitionTerm, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native definition-list term when trivia was preserved.
Parameters
- definitionTerm OfficeIMO.Markdown.MarkdownNativeDefinitionListTerm
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListDefinition definition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the original reader input that backs a native definition-list definition body when trivia was preserved.
Parameters
- definition OfficeIMO.Markdown.MarkdownNativeDefinitionListDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateOriginalSourceSlice(MarkdownNativeDefinitionListDefinition definition, out MarkdownSourceSlice slice, out MarkdownOriginalSourceSliceFailureReason failureReason) #BooleanCreates a source slice over the original reader input that backs a native definition-list definition body when trivia was preserved.
Parameters
- definition OfficeIMO.Markdown.MarkdownNativeDefinitionListDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
- failureReason OfficeIMO.Markdown.MarkdownOriginalSourceSliceFailureReason@
public Boolean TryCreateSourceMapping(MarkdownSourceSpan sourceSpan, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a source span, including normalized text and original text when it maps safely.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeBlock block, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native block, including normalized text and original text when it maps safely.
Parameters
- block OfficeIMO.Markdown.MarkdownNativeBlock
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeBlockSourceField field, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native block source field, including normalized text and original text when it maps safely.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeBlockSourceField
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeSourceTrivia trivia, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for document-level source trivia, including normalized text and original text when it maps safely.
Parameters
- trivia OfficeIMO.Markdown.MarkdownNativeSourceTrivia
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeInline inline, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native inline, including normalized text and original text when it maps safely.
Parameters
- inline OfficeIMO.Markdown.MarkdownNativeInline
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeInlineMetadata metadata, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for source-backed inline metadata, including normalized text and original text when it maps safely.
Parameters
- metadata OfficeIMO.Markdown.MarkdownNativeInlineMetadata
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeListItem listItem, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native list item content span, including normalized text and original text when it maps safely.
Parameters
- listItem OfficeIMO.Markdown.MarkdownNativeListItem
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeListItemParagraph paragraph, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a paragraph owned by a native list item, including normalized text and original text when it maps safely.
Parameters
- paragraph OfficeIMO.Markdown.MarkdownNativeListItemParagraph
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownReferenceLinkDefinition referenceDefinition, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a reference-style link definition, including normalized text and original text when it maps safely.
Parameters
- referenceDefinition OfficeIMO.Markdown.MarkdownReferenceLinkDefinition
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeReferenceLinkDefinitionField field, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a reference-style link definition field, including normalized text and original text when it maps safely.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeReferenceLinkDefinitionField
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownAbbreviationDefinition abbreviationDefinition, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for an abbreviation definition, including normalized text and original text when it maps safely.
Parameters
- abbreviationDefinition OfficeIMO.Markdown.MarkdownAbbreviationDefinition
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeAbbreviationDefinitionField field, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for an abbreviation definition field, including normalized text and original text when it maps safely.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeAbbreviationDefinitionField
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeTableCell tableCell, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native table cell, including normalized text and original text when it maps safely.
Parameters
- tableCell OfficeIMO.Markdown.MarkdownNativeTableCell
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeTableRow tableRow, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native table row, including normalized text and original text when it maps safely.
Parameters
- tableRow OfficeIMO.Markdown.MarkdownNativeTableRow
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeDefinitionListGroup definitionGroup, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native definition-list group, including normalized text and original text when it maps safely.
Parameters
- definitionGroup OfficeIMO.Markdown.MarkdownNativeDefinitionListGroup
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeDefinitionListTerm definitionTerm, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native definition-list term, including normalized text and original text when it maps safely.
Parameters
- definitionTerm OfficeIMO.Markdown.MarkdownNativeDefinitionListTerm
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceMapping(MarkdownNativeDefinitionListDefinition definition, out MarkdownSourceMapping mapping) #BooleanCreates a source mapping for a native definition-list definition body, including normalized text and original text when it maps safely.
Parameters
- definition OfficeIMO.Markdown.MarkdownNativeDefinitionListDefinition
- mapping OfficeIMO.Markdown.MarkdownSourceMapping@
public Boolean TryCreateSourceSlice(MarkdownAbbreviationDefinition abbreviationDefinition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs an abbreviation definition.
Parameters
- abbreviationDefinition OfficeIMO.Markdown.MarkdownAbbreviationDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeAbbreviationDefinitionField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs an abbreviation definition field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeAbbreviationDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownSourceSpan sourceSpan, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs the supplied source span.
Parameters
- sourceSpan OfficeIMO.Markdown.MarkdownSourceSpan
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeBlock block, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native block.
Parameters
- block OfficeIMO.Markdown.MarkdownNativeBlock
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeBlockSourceField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native block source field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeBlockSourceField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeSourceTrivia trivia, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs document-level source trivia.
Parameters
- trivia OfficeIMO.Markdown.MarkdownNativeSourceTrivia
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeInline inline, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native inline.
Parameters
- inline OfficeIMO.Markdown.MarkdownNativeInline
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeInlineMetadata metadata, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs source-backed inline metadata.
Parameters
- metadata OfficeIMO.Markdown.MarkdownNativeInlineMetadata
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeListItem listItem, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs the source-backed content span of a native list item.
Parameters
- listItem OfficeIMO.Markdown.MarkdownNativeListItem
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeListItemParagraph paragraph, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a paragraph owned by a native list item.
Parameters
- paragraph OfficeIMO.Markdown.MarkdownNativeListItemParagraph
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownReferenceLinkDefinition referenceDefinition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a reference-style link definition.
Parameters
- referenceDefinition OfficeIMO.Markdown.MarkdownReferenceLinkDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeReferenceLinkDefinitionField field, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a reference-style link definition field.
Parameters
- field OfficeIMO.Markdown.MarkdownNativeReferenceLinkDefinitionField
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeTableCell tableCell, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native table cell.
Parameters
- tableCell OfficeIMO.Markdown.MarkdownNativeTableCell
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeTableRow tableRow, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native table row.
Parameters
- tableRow OfficeIMO.Markdown.MarkdownNativeTableRow
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeDefinitionListGroup definitionGroup, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native definition-list group.
Parameters
- definitionGroup OfficeIMO.Markdown.MarkdownNativeDefinitionListGroup
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeDefinitionListTerm definitionTerm, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native definition-list term.
Parameters
- definitionTerm OfficeIMO.Markdown.MarkdownNativeDefinitionListTerm
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public Boolean TryCreateSourceSlice(MarkdownNativeDefinitionListDefinition definition, out MarkdownSourceSlice slice) #BooleanCreates a source slice over the normalized markdown text that backs a native definition-list definition body.
Parameters
- definition OfficeIMO.Markdown.MarkdownNativeDefinitionListDefinition
- slice OfficeIMO.Markdown.MarkdownSourceSlice@
public MarkdownRoundtripResult WriteUnchanged() #MarkdownRoundtripResultEmits the original markdown when this native document was parsed with trivia preservation and no transforms changed it.
public MarkdownRoundtripResult WriteWithSourceEdit(MarkdownNativeSourceEdit edit) #MarkdownRoundtripResultApplies one native source edit while preserving original markdown around it when the edit can be remapped safely.
Parameters
- edit OfficeIMO.Markdown.MarkdownNativeSourceEdit
public MarkdownRoundtripResult WriteWithSourceEdits(IEnumerable<MarkdownNativeSourceEdit> edits) #MarkdownRoundtripResultApplies native source edits while preserving original markdown around them when every edit can be remapped safely.
Parameters
- edits System.Collections.Generic.IEnumerable{OfficeIMO.Markdown.MarkdownNativeSourceEdit}
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public MarkdownParseResult ParseResult { get; } #Underlying parse result, including original/final syntax trees and diagnostics.
public MarkdownDoc Document { get; } #Parsed OfficeIMO markdown document.
public MarkdownSyntaxNode SyntaxTree { get; } #Original syntax tree produced before document transforms were applied.
public MarkdownSyntaxNode FinalSyntaxTree { get; } #Final syntax tree aligned with Document.
public IReadOnlyList<MarkdownDocumentTransformDiagnostic> TransformDiagnostics { get; } #Document-transform diagnostics captured during parsing.
public IReadOnlyList<MarkdownReferenceLinkDefinition> ReferenceLinkDefinitions { get; } #Effective reference-style link definitions collected during parsing.
public IReadOnlyList<MarkdownAbbreviationDefinition> AbbreviationDefinitions { get; } #Effective abbreviation definitions collected during parsing.
public String SourceMarkdown { get; } #Markdown source text whose source spans back this projection.
public MarkdownNativeDocumentSourceKind SourceKind { get; } #Identifies whether SourceMarkdown is direct reader input or renderer-preprocessed markdown.
public IReadOnlyList<MarkdownNativeBlock> Blocks { get; } #Top-level native block projection in document order.
public IReadOnlyList<MarkdownNativeSourceTrivia> SourceTrivia { get; } #Document-level source trivia such as blank lines, in source order.
public IReadOnlyList<MarkdownNativeDiagnostic> Diagnostics { get; } #Projection diagnostics including transform notices and unsupported block fallbacks.