eDocEngine VCL Professional Help » Symbol Reference » Namespaces of Helper Classes » gtExPDFEng Namespace » TgtPDFCircleAnnot Class

Gnostice eDocEngine VCL Developer Guide
TgtPDFCircleAnnot Class

This class represents a circle PDF annotation.

Pascal
public TgtPDFCircleAnnot = class(TgtPDFAnnot);
C++
public: class TgtPDFCircleAnnot : public TgtPDFAnnot;

gtExPDFEng

procedure TForm1.Demo_TgtPDFCircleAnnot;
var
  gtPDFCircleAnnot1: TgtPDFCircleAnnot;
  gtPDFEngine1: TgtPDFEngine;
begin
  gtPDFEngine1 := TgtPDFEngine.Create(Nil);

  // Create a circle annotation
  gtPDFCircleAnnot1 := TgtPDFCircleAnnot.Create;
  gtPDFCircleAnnot1.BorderStyle := brDashed;
  // Set border dash pattern to 6-point dashes
  // and 2-point gaps
  gtPDFCircleAnnot1.BorderPattern := '6 2';
  // Set border to be "cloudy"
  gtPDFCircleAnnot1.Cloudy := True;
  // Set border cloudiness to maximum
  gtPDFCircleAnnot1.CloudIntensity := 2;

  gtPDFCircleAnnot1.BorderWidth := 4;
  gtPDFCircleAnnot1.InteriorColor := clRed;
  gtPDFCircleAnnot1.DifferRect := gtRect(0.5, 0.1, 0.2, 1);
  gtPDFCircleAnnot1.BorderColor := clGreen;

  gtPDFCircleAnnot1.Rect := gtRect(1, 2, 3, 4);
  gtPDFCircleAnnot1.Contents :=
    'Dashes are 6-points wide and gaps are 2-points wide';
  gtPDFCircleAnnot1.Title := 'Circle Annotation Demo';
  gtPDFCircleAnnot1.Subject := 'About border pattern';

  with gtPDFEngine1 do
  begin
    Preferences.ShowSetupDialog := False;
    Preferences.OpenAfterCreate := True;
    FileName := 'circle_annotation.pdf';

    BeginDoc;
    // Add caret annotation
    AddAnnotItem(gtPDFCircleAnnot1);
    EndDoc;
  end;
end;

 

Properties
TgtPDFCircleAnnot Class
 
Name 
Description 
 
Specifies border color of the annotation. 
 
Specifies border pattern of the annotation. 
 
Specifies style of the annotation border. 
 
Specifies width of the border. 
 
Specifies the intensity of the "cloudy" effect on the browser. 
 
Specifies whether the border of the annotation should have a cloudy effect
 
Specifies text that needs to be used as the contents of the annotation's popup window. 
 
Specifies difference between the annotation rectangle and the actual bounding box of the annotation. 
 
Specifies color with which the border of the annotation will be filled. 
 
Rect 
Specifies the location of the annotation on its page. 
 
Specifies text that needs to be used as the subject in the annotation's popup window. 
 
Specifies text that needs to be used as the title in the annotation's popup window. 
Methods
TgtPDFCircleAnnot Class
 
Name 
Description 
 
Creates a new instance of this class. 
 
Destroys this instance.