SubDocument Interface

Exposes properties and methods representing essential document functionality.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v24.1.Core.dll

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.Win.Navigation

Declaration

C#

[ComVisible(true)]
public interface SubDocument

VB.NET

<ComVisible(True)>
Public Interface SubDocument

Related API Members

The following members return SubDocument objects:

Show 11 links

• Comment.BeginUpdate()
• DocumentLayout.BeginUpdateDocument(RangedLayoutElement)
• DocumentPosition.BeginUpdateDocument()
• DocumentRange.BeginUpdateDocument()
• Note.BeginUpdate()
• NoteCollection.BeginUpdateSeparator(NoteSeparatorType)
• Section.BeginUpdateFooter()
• Section.BeginUpdateFooter(HeaderFooterType)
• Section.BeginUpdateHeader()
• Section.BeginUpdateHeader(HeaderFooterType)
• TextBox.Document

Remarks

The SubDocument interface delivers the basic document functionality that is common for the header, footer and the main document body. Specific functionality belongs to the Document interface.

To modify a document obtained via selection or the caret position, use the DocumentRange.BeginUpdateDocument or the DocumentPosition.BeginUpdateDocument methods, returning the SubDocument interface. Make sure to properly finalize modifications, by calling the corresponding EndUpdateDocument methods.