PDFVisualAnnotationToolTip¶

Namespace: O2S.Components.PDF4NET.View

Defines the way how tooltips are displayed for annotations.

public class PDFVisualAnnotationToolTip

Inheritance Object → PDFVisualAnnotationToolTip
Implements

Constructors¶

PDFVisualAnnotationToolTip()¶

Initializes a new PDFVisualAnnotationToolTip object.

public PDFVisualAnnotationToolTip()

Properties¶

BackColor¶

Gets or sets the background color for the annotation tooltip.

public Color BackColor { get; set; }

Property Value

Color
The background of the annotation tooltip.

Remarks

Use the BackColor and PDFVisualAnnotationToolTip.ForeColor properties to modify the color scheme used by annotation tooltips.

Contents¶

Gets or sets the contents of annotation tooltip.

public string Contents { get; set; }

Property Value

String
The contents of the annotation tooltip.

Remarks

Use the PDFVisualAnnotationToolTip.Title and Contents properties to specify the text that is displayed in annotation tooltips. The text can contain annotation property names enclosed in curly brackets that are replaced with actual values when the tooltip is displayed.
For example, the default value of the Contents property is "{Contents}", which means that the contents of the annotation is displayed as the body of the tooltip. You can use other property names to display different information about the annotation, such as {Author}, {Subject}, {Contents}, {ID}, {CreationDate}, {ModificationDate}, etc.
If the property name is not recognized, it is replaced with an empty string. For example, if you set the Contents property to "{UnknownProperty}", the body of the tooltip will be empty because {UnknownProperty} is not a recognized annotation property name.

ForeColor¶

Gets or sets the foreground color for the annotation tooltip.

public Color ForeColor { get; set; }

Property Value

Color
The foreground of the annotation tooltip.

Remarks

Use the PDFVisualAnnotationToolTip.BackColor and ForeColor properties to modify the color scheme used by annotation tooltips.

Title¶

Gets or sets the title of annotation tooltip.

public string Title { get; set; }

Property Value

String
The title of the annotation tooltip.

Remarks

Use the Title and PDFVisualAnnotationToolTip.Contents properties to specify the text that is displayed in annotation tooltips. The text can contain annotation property names enclosed in curly brackets that are replaced with actual values when the tooltip is displayed.
For example, the default value of the Title property is "{Subject}", which means that the subject of the annotation is displayed as the title of the tooltip. You can use other property names to display different information about the annotation, such as {Author}, {Subject}, {Contents}, {ID}, {CreationDate}, {ModificationDate}, etc.
If the property name is not recognized, it is replaced with an empty string. For example, if you set the Title property to "{UnknownProperty}", the title of the tooltip will be empty because {UnknownProperty} is not a recognized annotation property name.

Events¶

PropertyChanged¶

Gets or sets the event that is fired when a property has changed.

public event PropertyChangedEventHandler PropertyChanged;