Class PdfTextAnnotation
PDF text annotation
Inherited Members
Namespace: IronPdf.Annotations
Assembly: IronPdf.dll
Syntax
public class PdfTextAnnotation : PdfAnnotation
Use PdfTextAnnotation in IronPDF when a C# application works with PDF annotations. It represents PDF text annotation.
PdfTextAnnotation matters when an application needs to configure or invoke PDF annotations from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.
To use PdfTextAnnotation, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include State. Assign options or invoke methods on the instance to configure or perform the operation. The draw text and bitmap covers typical usage in C# end to end.
using IronPdf;
// Obtain PdfTextAnnotation from the relevant entry point in the IronPDF API
void Configure(PdfTextAnnotation instance)
{
var current = instance.State;
}For the broader workflow, see the extract text and images guide in the IronPDF C# documentation. For broader context, the PDF annotations portion of the IronPDF C# API contains related types that work with PdfTextAnnotation directly. PdfTextAnnotation instances inherit additional members from PdfAnnotation that may be relevant in advanced scenarios. In application code, treat PdfTextAnnotation as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant PdfTextAnnotation property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of PdfTextAnnotation. Application code typically obtains or instantiates a single PdfTextAnnotation and shares it across multiple IronPDF operations rather than recreating it per call.
Constructors
PdfTextAnnotation(Rectangle, Color, String, String, String, Boolean)
Declaration
public PdfTextAnnotation(Rectangle rectangle, Color color, string name, string contents, string state, bool hidden)
Parameters
| Type | Name | Description |
|---|---|---|
| IronSoftware.Drawing.Rectangle | rectangle | |
| IronSoftware.Drawing.Color | color | |
| System.String | name | |
| System.String | contents | |
| System.String | state | |
| System.Boolean | hidden |
Properties
State
The state to which the original annotation should be set: marked, unmarked, accepted, rejected, cancelled, completed or none.
Declaration
public string State { get; }
Property Value
| Type | Description |
|---|---|
| System.String |