IdxRichEditSubDocument.BeginUpdateParagraphs(IdxRichEditDocumentRange) Method

Starts to update the properties of one or more paragraphs to which the specified document range belongs.

Declaration

delphi

function BeginUpdateParagraphs(const ARange: IdxRichEditDocumentRange): IdxRichEditParagraphProperties;

Parameters

Name	Type	Description
ARange	IdxRichEditDocumentRange

The target document range.

Returns

Type	Description
IdxRichEditParagraphProperties

The target paragraph’s properties.

Remarks

A BeginUpdateParagraphs function call obtains properties of one or more paragraphs to which the target document range belongs. The EndUpdateParagraphs procedure accepts these paragraph settings and applies the changes made between BeginUpdateParagraphs and EndUpdateParagraphs calls.

Code Example: Customize Paragraph Settings

The following code example justifies the paragraph where the caret is located and sets a 2-centimeter first line indent:

Delphi
C++

delphi

var
  ADocument: IdxRichEditDocument;
  AParagraphProperties: IdxRichEditParagraphProperties;
begin
  ADocument := dxRichEditControl1.Document;
  ADocument.&Unit := TdxRichEditDocumentUnit.Centimeter;
  // Obtains properties of the paragraph where the caret is located
  AParagraphProperties := ADocument.BeginUpdateParagraphs(ADocument.Selection);
  AParagraphProperties.Alignment := TdxRichEditParagraphAlignment.Justify;
  AParagraphProperties.FirstLineIndentType := TdxRichEditParagraphFirstLineIndent.Indented;
  AParagraphProperties.FirstLineIndent := 2;
  ADocument.EndUpdateParagraphs(AParagraphProperties); // Applies the changes to the current paragraph
end;

cpp

_di_IdxRichEditDocument ADocument;
  _di_IdxRichEditParagraphProperties AParagraphProperties;
  // ...
  ADocument = dxRichEditControl1->Document;
  ADocument->Unit = TdxRichEditDocumentUnit::Centimeter;
  // Obtains properties of the paragraph where the caret is located
  AParagraphProperties = ADocument->BeginUpdateParagraphs(ADocument->Selection);
  AParagraphProperties->Alignment = TdxRichEditParagraphAlignment::Justify;
  AParagraphProperties->FirstLineIndentType = TdxRichEditParagraphFirstLineIndent::Indented;
  AParagraphProperties->FirstLineIndent := 2;
  ADocument->EndUpdateParagraphs(AParagraphProperties); // Applies the changes to the current paragraph