API Reference
DocBookDocument
Source-preserving DocBook 4/5 document with a bounded typed common-structure API and extension access.
Inheritance
- Object
- DocBookDocument
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
- Method DocBookDocument.CreateArticle
- Method DocBookDocument.CreateBook
- Method DocBookDocument.FromOfficeDocumentModel
- Method DocBookDocument.Load
- Method DocBookDocument.Load
- Method DocBookDocument.LoadAsync
- Method DocBookDocument.Parse
Methods
public DocBookNode AddParagraph(String text) #DocBookNodeAdds a top-level paragraph, creating a chapter container first for a book.
Parameters
- text System.String
public DocBookNode AddSection(String title) #DocBookNodeAdds a top-level section, creating a chapter container first for a book.
Parameters
- title System.String
public static DocBookDocument CreateArticle(DocBookProfile profile = DocBook52) #DocBookDocumentCreates an article using the exact selected writer profile.
Parameters
- profile OfficeIMO.DocBook.DocBookProfile = DocBook52
public static DocBookDocument CreateBook(DocBookProfile profile = DocBook52) #DocBookDocumentCreates a book using the exact selected writer profile.
Parameters
- profile OfficeIMO.DocBook.DocBookProfile = DocBook52
public static DocBookConversionResult<DocBookDocument> FromOfficeDocumentModel(OfficeDocumentModel model, Nullable<DocBookDocumentKind> kind = null, Nullable<DocBookProfile> profile = null, DocBookConversionOptions options = null) #DocBookConversionResult<DocBookDocument>Creates an article or book from the shared recursive common structure.
Parameters
- model OfficeIMO.OfficeDocumentModel
- kind System.Nullable{OfficeIMO.DocBook.DocBookDocumentKind} = null
- profile System.Nullable{OfficeIMO.DocBook.DocBookProfile} = null
- options OfficeIMO.DocBook.DocBookConversionOptions = null
public static DocBookDocument Load(String path, DocBookReadOptions options = null, CancellationToken cancellationToken = default) #DocBookDocumentLoads a DocBook file.
Parameters
- path System.String
- options OfficeIMO.DocBook.DocBookReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static DocBookDocument Load(Stream stream, DocBookReadOptions options = null, CancellationToken cancellationToken = default) #DocBookDocumentLoads DocBook from a caller-owned stream while preserving seekable position.
Parameters
- stream System.IO.Stream
- options OfficeIMO.DocBook.DocBookReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static async Task<DocBookDocument> LoadAsync(Stream stream, DocBookReadOptions options = null, CancellationToken cancellationToken = default) #Task<DocBookDocument>Loads DocBook asynchronously from a caller-owned stream.
Parameters
- stream System.IO.Stream
- options OfficeIMO.DocBook.DocBookReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
public static DocBookDocument Parse(String text, DocBookReadOptions options = null, CancellationToken cancellationToken = default) #DocBookDocumentParses DocBook text using secure, bounded XML settings.
Parameters
- text System.String
- options OfficeIMO.DocBook.DocBookReadOptions = null
- cancellationToken System.Threading.CancellationToken = default
public Void Save(String path, DocBookWriteOptions options = null) #VoidSaves using an atomic same-directory file commit.
Parameters
- path System.String
- options OfficeIMO.DocBook.DocBookWriteOptions = null
public Task SaveAsync(String path, DocBookWriteOptions options = null, CancellationToken cancellationToken = default) #TaskSaves asynchronously using an atomic same-directory file commit.
Parameters
- path System.String
- options OfficeIMO.DocBook.DocBookWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
public String ToDocBook(DocBookWriteOptions options = null) #StringReturns DocBook XML, preserving the exact unchanged source by default.
Parameters
- options OfficeIMO.DocBook.DocBookWriteOptions = null
public DocBookConversionResult<OfficeDocumentModel> ToOfficeDocumentModel(String sourcePath = null, DocBookConversionOptions options = null, CancellationToken cancellationToken = default) #DocBookConversionResult<OfficeDocumentModel>Converts the typed common structure to the shared recursive document model.
Parameters
- sourcePath System.String = null
- options OfficeIMO.DocBook.DocBookConversionOptions = null
- cancellationToken System.Threading.CancellationToken = default
public DocBookValidationResult Validate(DocBookValidationOptions options = null, CancellationToken cancellationToken = default) #DocBookValidationResultValidates the bounded OfficeIMO common-structure profile. The returned result explicitly does not represent a complete external DTD, RELAX NG, Schematron, XInclude, assembly, or vocabulary-extension validation run.
Parameters
- options OfficeIMO.DocBook.DocBookValidationOptions = null
- cancellationToken System.Threading.CancellationToken = default
public Void Write(Stream destination, DocBookWriteOptions options = null) #VoidWrites to a caller-owned stream.
Parameters
- destination System.IO.Stream
- options OfficeIMO.DocBook.DocBookWriteOptions = null
public Task WriteAsync(Stream destination, DocBookWriteOptions options = null, CancellationToken cancellationToken = default) #TaskWrites asynchronously to a caller-owned stream.
Parameters
- destination System.IO.Stream
- options OfficeIMO.DocBook.DocBookWriteOptions = null
- cancellationToken System.Threading.CancellationToken = default
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public DocBookProfile Profile { get; } #Exact writer and bounded-validation profile selected for this document.
public DocBookSchemaProfile SchemaProfile { get; } #Exact official schema identifiers associated with Profile.
public DocBookDocumentKind Kind { get; } #Document root kind.
public Boolean IsModified { get; } #True after a mutation through this API.
public DocBookNode Root { get; } #Root element as a typed common node.
public XDocument Xml { get; } #Underlying XML for extension inspection and advanced lossless editing.
public String Title { get; set; } #Document title from the root metadata/title.