LatexDocument
OfficeIMO.Latex
Parsed LaTeX document with lossless syntax and bounded profile semantics.
Inheritance
- object
- LatexDocument
Usage
Explore 6 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 6
- Method LatexDocument.Load
- Method LatexDocument.LoadAsync
- Method LatexDocument.Parse
- Method LatexParseResult.RequireValue
- Property LatexParseResult.Document
- Property LatexParseResult.Value
Methods
public LatexMacroExpansionResult ExpandSimpleMacros(string value) #Explicitly expands structurally safe simple definitions when enabled by parse options.
Parameters
- value string
Returns
LatexMacroExpansionResultpublic static LatexDocument Load(string path, LatexParseOptions? options = null, Encoding? encoding = null) #Loads decoded text using Unicode BOM detection when no encoding is specified.
Parameters
- path string
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
Returns
LatexDocumentpublic static LatexDocument Load(Stream stream, LatexParseOptions? options = null, Encoding? encoding = null) #Loads and parses a LaTeX document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
Returns
LatexDocumentpublic static async Task<LatexDocument> LoadAsync(string path, LatexParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously loads and parses a LaTeX file.
Parameters
- path string
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<LatexDocument>public static async Task<LatexDocument> LoadAsync(Stream stream, LatexParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously loads and parses a LaTeX document from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<LatexDocument>public static LatexParseResult LoadResult(string path, LatexParseOptions? options = null, Encoding? encoding = null) #Loads decoded text with syntax and recovery diagnostics using Unicode BOM detection when no encoding is specified.
Parameters
- path string
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
Returns
LatexParseResultpublic static LatexParseResult LoadResult(Stream stream, LatexParseOptions? options = null, Encoding? encoding = null) #Loads a LaTeX document from a caller-owned stream with syntax and recovery diagnostics.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
Returns
LatexParseResultpublic static LatexParseResult LoadResult(Stream stream, LatexParseOptions? options, Encoding? encoding, CancellationToken cancellationToken) #Loads a caller-owned stream with byte and character limits and cooperative cancellation.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexParseOptions?
- encoding System.Text.Encoding?
- cancellationToken System.Threading.CancellationToken
Returns
LatexParseResultpublic static async Task<LatexParseResult> LoadResultAsync(string path, LatexParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously loads a LaTeX file with syntax and recovery diagnostics.
Parameters
- path string
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<LatexParseResult>public static async Task<LatexParseResult> LoadResultAsync(Stream stream, LatexParseOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously loads a LaTeX stream with syntax and recovery diagnostics.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexParseOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Task<LatexParseResult>public static LatexDocument Parse(string source, LatexParseOptions? options = null) #Parses LaTeX source into the typed document model without executing it.
Parameters
- source string
- options OfficeIMO.Latex.LatexParseOptions? = null
Returns
LatexDocumentpublic static LatexDocument Parse(string source, LatexParseOptions? options, CancellationToken cancellationToken) #Parses LaTeX source into the typed model without executing it and cooperatively observes cancellation.
Parameters
- source string
- options OfficeIMO.Latex.LatexParseOptions?
- cancellationToken System.Threading.CancellationToken
Returns
LatexDocumentpublic static LatexParseResult ParseResult(string source, LatexParseOptions? options = null) #Parses LaTeX source with syntax and recovery diagnostics without executing it.
Parameters
- source string
- options OfficeIMO.Latex.LatexParseOptions? = null
Returns
LatexParseResultpublic static LatexParseResult ParseResult(string source, LatexParseOptions? options, CancellationToken cancellationToken) #Parses LaTeX source with diagnostics and cooperatively observes cancellation.
Parameters
- source string
- options OfficeIMO.Latex.LatexParseOptions?
- cancellationToken System.Threading.CancellationToken
Returns
LatexParseResultpublic void Save(string path, LatexWriterOptions? options = null, Encoding? encoding = null) #Saves the current document text to a file.
Parameters
- path string
- options OfficeIMO.Latex.LatexWriterOptions? = null
- encoding System.Text.Encoding? = null
public void Save(Stream stream, LatexWriterOptions? options = null, Encoding? encoding = null) #Writes the current document text to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexWriterOptions? = null
- encoding System.Text.Encoding? = null
public async Task SaveAsync(string path, LatexWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously saves the current document text to a file.
Parameters
- path string
- options OfficeIMO.Latex.LatexWriterOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic Task SaveAsync(Stream stream, LatexWriterOptions? options = null, Encoding? encoding = null, CancellationToken cancellationToken = default) #Asynchronously writes the current document text to a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.Latex.LatexWriterOptions? = null
- encoding System.Text.Encoding? = null
- cancellationToken System.Threading.CancellationToken = default
Returns
Taskpublic byte[] ToBytes(LatexWriterOptions? options = null, Encoding? encoding = null) #Encodes the current document text.
Parameters
- options OfficeIMO.Latex.LatexWriterOptions? = null
- encoding System.Text.Encoding? = null
Returns
byte[]public string ToLatex(LatexWriterOptions? options) #Writes using explicit options.
Parameters
- options OfficeIMO.Latex.LatexWriterOptions?
Returns
stringInherited Methods
Properties
public IReadOnlyList<LatexDiagnostic> Diagnostics { get; } #Parser and recovery diagnostics.
public IReadOnlyList<LatexCommand> Commands { get; } #Commands including unknown commands.
public IReadOnlyList<LatexEnvironment> Environments { get; } #Nested environments.
public IReadOnlyList<LatexHeading> Headings { get; } #Part/chapter/section headings.
public IReadOnlyList<LatexParagraph> Paragraphs { get; } #Paragraph source regions in the document body.
public IReadOnlyList<LatexList> Lists { get; } #Itemize, enumerate, and description lists.
public IReadOnlyList<LatexFigure> Figures { get; } #Figure environments and included graphics.
public IReadOnlyList<LatexReference> References { get; } #Cross-reference commands.
public IReadOnlyList<LatexFootnote> Footnotes { get; } #Source-backed footnote commands with editable bodies and optional explicit marks, in source order.
public IReadOnlyList<LatexMacroDefinition> MacroDefinitions { get; } #Document-local new/renew/provide command definitions.
public LatexCommand? DocumentClassCommand { get; } #Document class command, when present.
public bool IsRecognizedProfile { get; } #True for article, report, or book documents with a document environment.