SubDocument.CreatePosition(Int32) Method

Creates a new position in the current document.

Namespace: DevExpress.XtraRichEdit.API.Native

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

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

Declaration

C#

DocumentPosition CreatePosition(
    int start
)

VB.NET

Function CreatePosition(
    start As Integer
) As DocumentPosition

Parameters

Name	Type	Description
start	Int32	An integer value specifying the start position.

Returns

Type	Description
DocumentPosition	A DocumentPosition object representing the position in the current document.

Example

The following code sample calls the SubDocument.CreatePosition method to obtain the document position at the given index and inserts a text in it:

C#

using (var wordProcessor = new RichEditDocumentServer())
{
    Document document = wordProcessor.Document;
    DocumentPosition pos1 = document.CreatePosition(2);
    document.InsertText(pos1,"The Word Processing Document API is a non-visual .NET library.\r
    It allows you to automate frequent word processing tasks.\n");
}

VB.NET

Using wordProcessor = New RichEditDocumentServer()
    Dim document As Document = wordProcessor.Document
    Dim pos1 As DocumentPosition = document.CreatePosition(2)
    document.InsertText(pos1, "The Word Processing Document API is a non-visual .NET library. It allows you to automate frequent word processing tasks")
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CreatePosition(Int32) 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#

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/Range.cs#L13

document.LoadDocument("Documents//Grimm.docx", DocumentFormat.OpenXml);
DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/RangeActions.cs#L13

document.LoadDocument("Documents//Grimm.docx", DocumentFormat.OpenXml);
DocumentPosition myStart = document.CreatePosition(69);
DocumentRange myRange = document.CreateRange(myStart, 216);

word-document-api-examples/CS/CodeExamples/ContentControlsActions.cs#L23

// Insert a form to enter a name:
var namePosition = document.CreatePosition(document.Paragraphs[0].Range.End.ToInt() - 1);
var nameControl = contentControls.InsertPlainTextControl(namePosition);

winforms-richedit-layout-api-practical-usage/CS/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.cs#L12

SubDocument subDocument = currentDocument.CaretPosition.BeginUpdateDocument();
DocumentPosition docPosition = subDocument.CreatePosition(currentDocument.CaretPosition.ToInt() == 0 ? 0 : currentDocument.CaretPosition.ToInt() - 1);

winforms-richedit-layout-api/CS/LayoutApiSimpleExample/Form1.cs#L82

SubDocument subDoc = richEditControl1.Document.CaretPosition.BeginUpdateDocument();
DocumentPosition pos = subDoc.CreatePosition(richEditControl1.Document.CaretPosition.ToInt() == 0 ? 0 : richEditControl1.Document.CaretPosition.ToInt() - 1);
LayoutPageArea pageArea = richEditControl1.DocumentLayout.GetElement(pos, LayoutType.PageArea) as LayoutPageArea;

VB.NET

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/Notes.vb#L12

'Insert a footnote at the end of the 6th paragraph:
Dim footnotePosition As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition(document.Paragraphs(CInt((5))).Range.[End].ToInt() - 1)
document.Footnotes.Insert(footnotePosition)

wpf-richedit-document-api/VB/DXRichEditControlAPISample/CodeExamples/RangeActions.vb#L10

document.LoadDocument("Documents//Grimm.docx", DocumentFormat.OpenXml)
Dim myStart As DocumentPosition = document.CreatePosition(69)
Dim myRange As DocumentRange = document.CreateRange(myStart, 216)

word-document-api-examples/VB/CodeExamples/NotesActions.vb#L29

' Insert a footnote at the end of the sixth paragraph.
Dim footnotePosition As DevExpress.XtraRichEdit.API.Native.DocumentPosition = document.CreatePosition(document.Paragraphs(CInt((5))).Range.[End].ToInt() - 1)
document.Footnotes.Insert(footnotePosition)

winforms-richedit-layout-api-practical-usage/VB/WindowsFormsApplication1/DocumentLayoutHelper/RichEditDocumentLayoutAnalyzer.vb#L15

Dim subDocument As SubDocument = currentDocument.CaretPosition.BeginUpdateDocument()
Dim docPosition As DocumentPosition = subDocument.CreatePosition(If(currentDocument.CaretPosition.ToInt() = 0, 0, currentDocument.CaretPosition.ToInt() - 1))

winforms-richedit-layout-api/VB/LayoutApiSimpleExample/Form1.vb#L69

Dim subDoc As SubDocument = richEditControl1.Document.CaretPosition.BeginUpdateDocument()
Dim pos As DocumentPosition = subDoc.CreatePosition(If(richEditControl1.Document.CaretPosition.ToInt() = 0, 0, richEditControl1.Document.CaretPosition.ToInt() - 1))
Dim pageArea As LayoutPageArea = TryCast(richEditControl1.DocumentLayout.GetElement(pos, LayoutType.PageArea), LayoutPageArea)