Back to Devexpress

ContentControlCollection.InsertRichTextControl(DocumentPosition) Method

officefileapi-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-contentcontrolcollection-dot-insertrichtextcontrol-x28-devexpress-dot-xtrarichedit-dot-api-dot-native-dot-documentposition-x29.md

latest3.3 KB
Original Source

ContentControlCollection.InsertRichTextControl(DocumentPosition) Method

Creates a plain text content control at the specified document position.

Namespace : DevExpress.XtraRichEdit.API.Native

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

NuGet Package : DevExpress.RichEdit.Core

Declaration

csharp
ContentControlRichText InsertRichTextControl(
    DocumentPosition position
)
vb
Function InsertRichTextControl(
    position As DocumentPosition
) As ContentControlRichText

Parameters

NameTypeDescription
positionDocumentPosition

The document position where the content control should be located.

|

Returns

TypeDescription
ContentControlRichText

The rich text content control.

|

Example

The code sample below creates a rich text content control:

csharp
using DevExpress.XtraRichEdit.API.Native;
using DevExpress.XtraRichEdit;

using (var wordProcessor = new RichEditDocumentServer()) {

    wordProcessor.LoadDocument("Content Controls.docx");
    Document document = wordProcessor.Document;
    var contentControls = document.ContentControls;

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

    // Insert a text to a content control:
    var nameTextPosition = document.CreatePosition(nameControl.Range.Start.ToInt() + 1);
    document.InsertText(nameTextPosition, "Click to enter a name");
}
vb
Imports DevExpress.XtraRichEdit.API.Native
Imports DevExpress.XtraRichEdit

Using wordProcessor = New RichEditDocumentServer()

  wordProcessor.LoadDocument("Content Controls.docx")
  Dim document As Document = wordProcessor.Document
  Dim contentControls = document.ContentControls

  ' Insert a form to enter a name:
  Dim namePosition = document.CreatePosition(document.Paragraphs(0).Range.End.ToInt() - 1)
  Dim nameControl = contentControls.InsertRichTextControl(namePosition)

  ' Insert a text to a content control:
  Dim nameTextPosition = document.CreatePosition(nameControl.Range.Start.ToInt() + 1)
  document.InsertText(nameTextPosition, "Click to enter a name")
End Using

See Also

ContentControlCollection Interface

ContentControlCollection Members

DevExpress.XtraRichEdit.API.Native Namespace