SubDocument.GetSubDocumentType() Method

Returns the subdocument type.

Namespace: DevExpress.XtraRichEdit.API.Native

Assembly: DevExpress.RichEdit.v20.2.Core.dll

NuGet Package: DevExpress.RichEdit.Core

NuGet Packages: DevExpress.RichEdit.Core, DevExpress.WindowsDesktop.RichEdit.Core

Declaration

C#

SubDocumentType GetSubDocumentType()

VB.NET

Function GetSubDocumentType As SubDocumentType

Returns

Type	Description
SubDocumentType	A SubDocumentType enumeration member.

Remarks

Use the GetSubDocumentType method to obtain whither the current subdocument is the main document body, header, footer, comment, text box, footnote or endnote.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetSubDocumentType() method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/CS/RichEditControl_CheckBox/Form1.cs#L48

SubDocument document = caretPosition.BeginUpdateDocument();
if (document.GetSubDocumentType() == GetLocation(character.Parent))
{

VB.NET

how-to-insert-a-checkbox-into-a-richeditcontrol-document-t600135/VB/RichEditControl_CheckBox/Form1.vb#L45

Dim document As SubDocument = caretPosition.BeginUpdateDocument()
If document.GetSubDocumentType() = GetLocation(character.Parent) Then
    Dim characterRange As DocumentRange = document.CreateRange(character.Range.Start, 1)