Back to Devexpress

ContentControlCollection.InsertPlainTextControl(DocumentPosition) Method

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

latest5.5 KB
Original Source

ContentControlCollection.InsertPlainTextControl(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
ContentControlPlainText InsertPlainTextControl(
    DocumentPosition position
)
vb
Function InsertPlainTextControl(
    position As DocumentPosition
) As ContentControlPlainText

Parameters

NameTypeDescription
positionDocumentPosition

The document position where the content control should be located.

|

Returns

TypeDescription
ContentControlPlainText

The plain text content control.

|

Example

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.InsertPlainTextControl(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.InsertPlainTextControl(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

The following code snippets (auto-collected from DevExpress Examples) contain references to the InsertPlainTextControl(DocumentPosition) 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.

wpf-richedit-document-api/CS/DXRichEditControlAPISample/CodeExamples/ContentControlActions.cs#L21

csharp
var namePosition = document.CreatePosition(document.Paragraphs[0].Range.End.ToInt() - 1);
var nameControl = contentControls.InsertPlainTextControl(namePosition);

winforms-richedit-document-api/CS/RichEditAPISample/CodeExamples/ContentControls.cs#L22

csharp
var namePosition = document.CreatePosition(document.Paragraphs[0].Range.End.ToInt() - 1);
var nameControl = contentControls.InsertPlainTextControl(namePosition);

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

csharp
var namePosition = document.CreatePosition(document.Paragraphs[0].Range.End.ToInt() - 1);
var nameControl = contentControls.InsertPlainTextControl(namePosition);

winforms-richedit-document-api/VB/RichEditAPISample/CodeExamples/ContentControls.vb#L20

vb
Dim namePosition = document.CreatePosition(document.Paragraphs(CInt((0))).Range.[End].ToInt() - 1)
Dim nameControl = contentControls.InsertPlainTextControl(namePosition)
' Insert text in a content control:

See Also

ContentControlCollection Interface

ContentControlCollection Members

DevExpress.XtraRichEdit.API.Native Namespace