Vcl.ComCtrls.TCustomRichEdit.RenderRange

From RAD Studio API Documentation
Jump to: navigation, search

Delphi

function RenderRange(RenderTarget: TCanvas; FormatTarget: TCanvas = nil; RangeStart: Integer = 0;
RangeEnd: Integer = -1; MeasureOnly: Boolean = False): Integer;

C++

int __fastcall RenderRange(Vcl::Graphics::TCanvas* RenderTarget, Vcl::Graphics::TCanvas* FormatTarget = (Vcl::Graphics::TCanvas*)(0x0), int RangeStart = 0x0, int RangeEnd = 0xffffffff, bool MeasureOnly = false);

Properties

Type Visibility Source Unit Parent
function public
Vcl.ComCtrls.pas
Vcl.ComCtrls.hpp
Vcl.ComCtrls TCustomRichEdit

Description

RenderRange provides an alternative to the general-purpose Print method.

RenderRange allows custom ranges of the rich edit content to be rendered to any specified TCanvas. The parameters are as follows:

  • RenderTarget- A canvas representing the device to render to.
Note: If RenderRange is being used to send output to a device, the Printer.Canvas is typically used here. It might be different when building a print preview window.
  • FormatTarget- A canvas representing the target device to format for, typically Printer.Canvas. If this parameter is nil (default value) then it defaults to the same as RenderTarget.
  • RangeStart- The character position index next to the first character in the range to be rendered by this call. The default value 0 indicates the beginning of the richedit control's content.
  • RangeEnd- The character position following the last character in the range to be rendered by this call. The default value -1 indicates the last character in the richedit control's content.
  • MeasureOnly- When it is False (default) then the text is rendered, if it is True the text is just measured.