SnapSubDocument Interface

Provides the essential Snap document functionality.

Namespace: DevExpress.Snap.Core.API

Assembly: DevExpress.Snap.v21.2.Core.dll

NuGet Package: DevExpress.Snap.Core

Declaration

C#

[ComVisible(true)]
public interface SnapSubDocument :
    SubDocument,
    ISnapFieldOwner

VB.NET

<ComVisible(True)>
Public Interface SnapSubDocument
    Inherits SubDocument,
             ISnapFieldOwner

Related API Members

The following members return SnapSubDocument objects:

• SnapDocumentPosition.BeginUpdateDocument()
• SnapDocumentRange.BeginUpdateDocument
• SnapEntity.SubDocument
• SnapSection.BeginUpdateFooter()
• SnapSection.BeginUpdateFooter(HeaderFooterType)
• SnapSection.BeginUpdateHeader()
• SnapSection.BeginUpdateHeader(HeaderFooterType)

Remarks

The SnapSubDocument interface delivers the basic document functionality that is common for the header, footer and the main document body. Specific functionality is provided by the SnapDocument interface.

To modify a document obtained via selection or the caret position, use the SnapDocumentRange.BeginUpdateDocument or SnapDocumentPosition.BeginUpdateDocument methods. To make sure that the modifications are properly finalized, call the corresponding EndUpdateDocument method.