PDFKit.NET 5.0

https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0
Admin
A .NET library designed for creating and manipulating PDF documents, offering functionalities for...
Tokens:195,362
Snippets:1,441
Trust Score:8.7
Update:1 year ago
Show doc for...
Tokens:
Raw
### ColorStopCollection Constructor API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Brushes.ColorStopCollection.%23ctor(TallComponents.PDF.Colors.Color,TallComponents.PDF.Colors

Provides the API documentation for the ColorStopCollection constructor, detailing its signature and the purpose of its 'start' and 'end' Color parameters.

```APIDOC
Constructor: ColorStopCollection
  Namespace: TallComponents.PDF.Brushes
  Class: ColorStopCollection
  Signature: public ColorStopCollection(Color start, Color end)
  Description: Create a new collection with 2 initial color stops positioned at 0 and 1 with colors start and end, respectively.
  Parameters:
    start (Color): This is the color of the color stop at position 0.
    end (Color): This is the color of the color stop at position 1.
```

--------------------------------

### LaunchAction() Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.LaunchAction

Initializes a new instance of the LaunchAction class. This constructor creates an action that, when executed, will start an external application. By default, the fileName property of the created LaunchAction will be an empty string.

```APIDOC
Namespace: TallComponents.PDF.Actions
Class: LaunchAction

Constructor: LaunchAction()
  Description: Creates a new LaunchAction that starts an external Application.
  Default Behavior: By default the fileName will be ''.
```

--------------------------------

### MessageCollection.Count Property Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Diagnostics.MessageCollection

Gets the number of messages in the MessageCollection. This property is read-only and returns an Int32.

```APIDOC
Namespace: TallComponents.PDF.Diagnostics
Class: MessageCollection

Property: Count
Type: Int32
Access: get

public Int32 Count { get; }
```

--------------------------------

### GoToAction Constructor API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.GoToAction.%23ctor(TallComponents.PDF.Navigation

Detailed API documentation for the `GoToAction` constructor, outlining its parameters and their types and descriptions.

```APIDOC
Constructor: GoToAction
  Parameters:
    destination:
      Type: Destination
      Description: The destination
```

--------------------------------

### LineShape Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Shapes.LineShape.%23ctor(System.Double,System.Double,System.Double,System.Double,TallComponents.PDF.Pens

API documentation for the LineShape constructor, detailing its parameters, their types, and descriptions for creating a new line shape with specified start and end points and a pen.

```APIDOC
LineShape:
  __init__(Double startX, Double startY, Double endX, Double endY, Pen pen)
    startX (Double): Horizontal position of start point.
    startY (Double): Vertical position of start point.
    endX (Double): Horizontal position of end point.
    endY (Double): Vertical position of end point.
    pen (Pen): Used to draw the line.
```

--------------------------------

### C# Property: Count

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.FragmentCollection

Gets the number of fragment objects in this collection. This read-only property returns an Int32 value.

```C#
public
Int32
 Count
 {
get;
}
```

--------------------------------

### ColorStop Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Brushes.ColorStop.%23ctor(TallComponents.PDF.Colors.Color,System

API documentation for the ColorStop constructor, detailing its signature, purpose, and parameters.

```APIDOC
ColorStop Constructor:
  Namespace: TallComponents.PDF.Brushes
  Class: ColorStop
  Description: Create a new color stop with given color and position.
  Signature: public ColorStop(Color color, Double position)
  Parameters:
    color: Color - The color of this color stop.
    position: Double - The position of this color stop.
```

--------------------------------

### Summary Class Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Diagnostics.Summary

Initializes a new instance of the TallComponents.PDF.Diagnostics.Summary class. This constructor takes no parameters.

```APIDOC
Namespace: TallComponents.PDF.Diagnostics
Class: Summary

Summary():
  Description: Create a new summary instance.
  Parameters: None
  Return Type: Summary
```

--------------------------------

### C# Property Syntax for Width

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.PageSize

Defines the C# syntax for the 'Width' property, showing it as a public Double with get and set accessors.

```C#
public
Double
 Width
 {
get;
set;
}
```

--------------------------------

### TallComponents.PDF.JavaScript.JavaScript.Run Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.JavaScript.JavaScript.Run(TallComponents.PDF

Detailed API documentation for the `Run` method, including its signature, parameters, and return type.

```APIDOC
Namespace: TallComponents.PDF.JavaScript
Class: JavaScript
Method: Run
  Syntax: public Void Run(Document context)
  Parameters:
    context: Document - The context to run in.
  Returns: Void
```

--------------------------------

### C# Syntax for ScaleY Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Transforms.ScaleTransform

Provides the C# syntax for the ScaleY property, showing it as a public Double type with both get and set accessors.

```C#
public
Double
 ScaleY
 {
get;
set;
}
```

--------------------------------

### C# GoToAction Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.GoToAction.%23ctor(TallComponents.PDF.Navigation

Provides the C# syntax for the `GoToAction` constructor, which initializes a new instance with a specified `Destination` object.

```C#
public GoToAction(Destination destination)
```

--------------------------------

### C# ArcShape.Sweep Property Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.ArcShape

Defines the C# syntax for the 'Sweep' property of the ArcShape class, which allows getting and setting the sweep angle.

```C#
public
Double
 Sweep
 {
get;
set;
}
```

--------------------------------

### BookmarkCollection Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Navigation.BookmarkCollection

Initializes a new empty instance of the BookmarkCollection class. This constructor takes no parameters and sets up an empty collection ready for adding bookmarks.

```APIDOC
Namespace: TallComponents.PDF.Navigation
Class: BookmarkCollection
Constructor:
  BookmarkCollection()
    Description: Create a new empty collection.
```

--------------------------------

### C#: Get Count Property of WidgetCollection

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Widgets.WidgetCollection

Illustrates the C# syntax for accessing the 'Count' property, which returns the number of widgets in a 'WidgetCollection' instance.

```C#
public Int32 Count
{
get;
}
```

--------------------------------

### CieBasedColor Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Colors.CieBasedColor

Provides the API documentation for the CieBasedColor constructor, including its namespace and class context. This constructor initializes a new instance of the CieBasedColor class within the TallComponents.PDF.Colors namespace and takes no parameters.

```APIDOC
Namespace: TallComponents.PDF.Colors
Class: CieBasedColor
Constructor:
  public CieBasedColor()
```

--------------------------------

### TallComponents.PDF.Shapes.BezierShape.Y1 Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.BezierShape

Defines the Y1 property, which specifies the vertical position of the start control point for a BezierShape. This property is readable and writable.

```APIDOC
Namespace: TallComponents.PDF.Shapes
Class: BezierShape

Property: Y1
  Description: Vertical position of the start control point.
  Type: Double
  Syntax:
    public Double Y1 { get; set; }
```

--------------------------------

### Get Count Property Syntax in C#

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Pens.DashCollection

Illustrates the syntax for accessing the `Count` property of the `DashCollection` class, which returns the number of dashes. This property is read-only.

```C#
public
Int32
 Count
 {
get;
}
```

--------------------------------

### Pkcs7Sha1SignatureHandler Constructor API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.DigitalSignatures.Pkcs7Sha1SignatureHandler.%23ctor(TallComponents.PDF.DigitalSignatures

API documentation for the Pkcs7Sha1SignatureHandler constructor, which initializes a new instance of the class using a Pkcs12Store to sign with its first key.

```APIDOC
public Pkcs7Sha1SignatureHandler(
  Pkcs12Store keyStore
)

Parameters:
  keyStore:
    Type: Pkcs12Store
    Description: A key store.
```

--------------------------------

### PieShape Constructor API Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Shapes.PieShape.%23ctor(System.Double,System.Double,System.Double,System.Double,TallComponents.PDF.Pens.Pen,TallComponents.PDF.Brushes.Brush,System.Double,System

This API documentation details the constructor for the PieShape class, which allows creation of a new pie shape by specifying its center coordinates, radii, drawing pen, fill brush, and start and sweep angles. It requires all parameters to be provided for instantiation.

```APIDOC
PieShape Constructor:
  public PieShape(
    Double centerX,
    Double centerY,
    Double radiusX,
    Double radiusY,
    Pen pen,
    Brush brush,
    Double start,
    Double sweep
  )
    centerX: Double - X-position of the center of the pie.
    centerY: Double - Y-position of the center of the pie.
    radiusX: Double - Horizontal radius.
    radiusY: Double - Vertical radius.
    pen: Pen - Used to draw the curves of the pie.
    brush: Brush - The brush that is used to fill this shape if closed.
    start: Double - Start angle (0 corresponds to 3 o-clock).
    sweep: Double - Sweep angle, counter-clockwise.
```

--------------------------------

### Get Message Property of ImportDataException

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Data.ImportDataException

Retrieves the descriptive message associated with the current ImportDataException instance. This read-only property provides details about the exception that occurred.

```C#
public
String
 Message
 {
get;
}
```

```APIDOC
Property: Message
  Namespace: TallComponents.PDF.Forms.Data
  Class: ImportDataException
  Description: Gets a message that describes the current exception.
  Type: String
  Access: get
```

--------------------------------

### ListOption Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Forms.Fields.ListOption.%23ctor(System

Provides the API documentation for the ListOption constructor, including its signature and parameter details.

```APIDOC
Constructor: ListOption
Namespace: TallComponents.PDF.Forms.Fields
Class: ListOption
Description: Creates a new List option.

Syntax:
public ListOption(String name)

Parameters:
  name (String): Both the ExportName and the DisplayName.
```

--------------------------------

### ParsableName Property Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Colors.Color

Defines the syntax for the `ParsableName` property, which is a read-only string property of the `TallComponents.PDF.Colors.Color` class, used to get the parsable name of a color.

```C#
public
String
 ParsableName
 {
get;
}
```

--------------------------------

### Accept Method API Documentation for TallComponents.PDF.Actions.LaunchAction

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Actions.LaunchAction.Accept(TallComponents.PDF.Actions.ActionVisitor,System

Documents the 'Accept' method within the 'TallComponents.PDF.Actions.LaunchAction' class, detailing its purpose, parameters, and return value for use with an 'ActionVisitor'.

```APIDOC
Class: TallComponents.PDF.Actions.LaunchAction
Method: Accept
Description: Accept this action.

Syntax:
  public Object Accept(
    ActionVisitor visitor,
    Object argument
  )

Parameters:
  visitor: ActionVisitor
    The visitor used to Accept this action.
  argument: Object
    An additional argument passed to the Visit method (may be ).

Returns:
  Object
```

--------------------------------

### Get ColorStop from ColorStopCollection by index (C#)

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Brushes.ColorStopCollection.Item(System

Retrieves the ColorStop object at the specified zero-based index from the ColorStopCollection. This is a read-only property.

```C#
public ColorStop Item[Int32 index] { get; }
```

--------------------------------

### APIDOC: TallComponents.PDF.Actions.LaunchAction.Clone Method

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Actions.LaunchAction

Comprehensive API documentation for the `Clone` method, including its namespace, class, purpose, and return type with description.

```APIDOC
Namespace: TallComponents.PDF.Actions
Class: LaunchAction
Method: Clone()
  Description: Clone this action.
  Returns: Action
    Description: The cloned named action.
```

--------------------------------

### C# Syntax: Get UnknownMarkup Name Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Markups.UnknownMarkup

Provides the C# syntax for accessing the read-only 'Name' property of the UnknownMarkup class, which returns a String.

```C#
public
String
 Name
 {
get;
}
```

--------------------------------

### TallComponents.PDF.Navigation.Bookmark Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Navigation.Bookmark

Provides the syntax and description for creating a new empty instance of the Bookmark class within the TallComponents.PDF.Navigation namespace.

```C#
public
Bookmark(
)
```

```APIDOC
Namespace: TallComponents.PDF.Navigation
Class: Bookmark
Constructor:
  Bookmark()
    Description: Create a new empty bookmark.
```

--------------------------------

### TallComponents.PDF.JavaScript.JavaScript.Text Property API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.JavaScript.JavaScript

Documents the 'Text' property within the 'TallComponents.PDF.JavaScript.JavaScript' class. This property is used to get or set the JavaScript code associated with an object.

```APIDOC
Namespace: TallComponents.PDF.JavaScript
Class: JavaScript
Property: Text
  Description: The JavaScript Code.
  Syntax:
    public String Text
    {
    get;
    set;
    }
  Property Value: String
```

--------------------------------

### TallComponents.PDF.Annotations.AnnotationVisitor.Visit Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.AnnotationVisitor.Visit(TallComponents.PDF.Annotations.Markups.FreeText,System

Detailed API documentation for the `Visit` method, including its purpose, syntax, parameters, and return type.

```APIDOC
Namespace: TallComponents.PDF.Annotations
Class: AnnotationVisitor
Method: Visit
  Description: Visit a free text markup (annotation). Not implementing this functionality calls the markup overload.
  Syntax: public Object Visit(FreeText annotation, Object argument)
  Returns:
    Type: Object
  Parameters:
    annotation:
      Type: FreeText
      Description: The visitor must handle a free text markup (annotation).
    argument:
      Type: Object
      Description: The additional argument passed to the Accept method (can be ).
```

--------------------------------

### C# Property Syntax for DocumentInfo.Title

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.DocumentInfo

Defines the C# syntax for the 'Title' property, which allows getting and setting the document's title within the TallComponents.PDF.DocumentInfo class.

```C#
public
String
	Title
	{
get;
set;
}
```

--------------------------------

### TallComponents.PDF.IndexRange.To Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.IndexRange

Defines the 'To' property within the TallComponents.PDF.IndexRange class. This property represents the end index of a range and is of type Int32, supporting both get and set operations.

```APIDOC
public
Int32
 To
{
get;
set;
}
```

--------------------------------

### TallComponents.PDF.Actions.ActionCollection.Accept Method Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Actions.ActionCollection.Accept(TallComponents.PDF.Actions.ActionVisitor,System

Comprehensive API documentation for the `Accept` method, including its C# signature, parameters, and return type, enabling a visitor pattern for action processing.

```C#
public
Void
 Accept(
[ActionVisitor]
 visitor
,
Object
 argument
)
```

```APIDOC
Namespace: TallComponents.PDF.Actions
Class: ActionCollection

Method: Accept
  Description: Accept all actions in this collection (in the order the collection contains the actions).
  Syntax: public Void Accept(ActionVisitor visitor, Object argument)
  Returns: Void
  Parameters:
    visitor: ActionVisitor
      Description: The visitor to accept.
    argument: Object
      Description: An additional argument passed to the Visit method (may be ).
```

--------------------------------

### C# CMap Property Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Fonts.ResolveCMapEventArgs

Defines the syntax for the CMap property, a public Stream type, within the TallComponents.PDF.Fonts.ResolveCMapEventArgs class. It supports both getting and setting the CMap value.

```C#
public
Stream
 CMap
{
get;
set;
}
```

--------------------------------

### VeriSignSignatureHandler Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.DigitalSignatures.VeriSignSignatureHandler.%23ctor(TallComponents.PDF.DigitalSignatures

This snippet provides the syntax for initializing a new VeriSignSignatureHandler instance. It requires a Pkcs12Store object, which contains the keys used for digital signatures. The constructor will use the first key found in the provided store.

```APIDOC
VeriSignSignatureHandler Constructor:
  public VeriSignSignatureHandler(
    Pkcs12Store keyStore
  )
    keyStore: Pkcs12Store - A key store.
```

--------------------------------

### OutputIntent Class Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Prepress.OutputIntent.%23ctor(TallComponents.PDF.Prepress

Documents the constructor for the TallComponents.PDF.Prepress.OutputIntent class. This constructor initializes a new instance of the OutputIntent class, requiring a specified output intent type.

```APIDOC
Namespace: TallComponents.PDF.Prepress
Class: OutputIntent

Constructor:
  OutputIntent(
    type: OutputIntentType
  )

Parameters:
  type: OutputIntentType
    Description: The type of the output intent.
```

--------------------------------

### Get Prefixes Property in TallComponents.PDF.Extensions.ExtensionCollection

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Extensions.ExtensionCollection

Defines the Prefixes property within the TallComponents.PDF.Extensions.ExtensionCollection class. This read-only property returns an array of strings, representing the prefixes that define the extensions.

```APIDOC
TallComponents.PDF.Extensions.ExtensionCollection.Prefixes Property:
  Type: String[]
  Access: get
  Description: The prefixes defining the extensions.
  Syntax:
    public String[] Prefixes { get; }
```

--------------------------------

### TallComponents.PDF.Pens.DashPattern.Phase Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Pens.DashPattern

Defines the 'Phase' property of the 'TallComponents.PDF.Pens.DashPattern' class. This property is a Double type with both getter and setter, controlling the starting offset within a dash pattern.

```APIDOC
Namespace: TallComponents.PDF.Pens
Class: DashPattern
Property: Phase
  Description: The phase of the pattern. The phase determines the distance within the pattern at which the line starts drawing.
  Type: Double
  Accessors: get, set
  Syntax Example: public Double Phase { get; set; }
```

--------------------------------

### TallComponents.PDF.Tags.Tag Constructor Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Tags.Tag.%23ctor(System.String,TallComponents.PDF.Tags

Detailed API documentation for the `Tag` class constructor, including its signature and parameter descriptions.

```APIDOC
Namespace: TallComponents.PDF.Tags
Class: Tag

Constructor:
  Description: Creates a Tag instance with the specified parameters.
  Syntax: public Tag(String type, Tag parentTag)
  Parameters:
    type:
      Type: String
      Description: The type of the created Tag.
    parentTag:
      Type: Tag
      Description: The parent of the created Tag.
```

--------------------------------

### TextFindCriteria Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.TextExtraction.TextFindCriteria.%23ctor(System.String,System.Boolean,System

Documents the constructor for the TextFindCriteria class, explaining how to create an instance with specified text, whole word matching, and case sensitivity.

```APIDOC
TextFindCriteria Constructor:
  Syntax: public TextFindCriteria(String text, Boolean matchWholeWord, Boolean matchCase)
  Parameters:
    text (String): Find this text.
    matchWholeWord (Boolean): Find only whole occurrences.
    matchCase (Boolean): Find only occurrences that match case.
```

--------------------------------

### PieShape Constructor API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Shapes.PieShape.%23ctor(System.Double,System.Double,System.Double,System.Double,TallComponents.PDF.Pens.Pen,TallComponents.PDF.Brushes

Detailed API documentation for the `PieShape` constructor, including its signature and a description of each parameter required to instantiate a new pie shape.

```C#
public PieShape(
    Double centerX,
    Double centerY,
    Double radiusX,
    Double radiusY,
    [Pen] pen,
    [Brush] brush
)
```

```APIDOC
Parameters:
- centerX (Double): X-position of the center of the pie.
- centerY (Double): Y-position of the center of the pie.
- radiusX (Double): Horizontal radius.
- radiusY (Double): Vertical radius.
- pen (Pen): Used to draw the curves of the pie.
- brush (Brush): The brush that is used to fill this shape if closed.
```

--------------------------------

### RectangleShape Width Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.RectangleShape

Documents the 'Width' property of the 'TallComponents.PDF.Shapes.RectangleShape' class, including its C# syntax and data type. This property allows getting and setting the width of a rectangle.

```C#
public
Double
 Width
 {
get;
set;
}
```

```APIDOC
Property Name: Width
Namespace: TallComponents.PDF.Shapes
Class: RectangleShape
Type: Double
Description: Width of this rectangle.
Accessors: get, set
```

--------------------------------

### FreeHandPath.Closed Property Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.FreeHandPath

Defines the syntax for the 'Closed' property of the TallComponents.PDF.Shapes.FreeHandPath class. This property is a Boolean type that can be both read (get) and written (set), indicating whether the path is closed.

```APIDOC
public
Boolean
Closed
{
get;
set;
}
```

--------------------------------

### ListOption Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Forms.Fields.ListOption.%23ctor(System.String,System

Initializes a new instance of the ListOption class with specified export and display names.

```APIDOC
ListOption Constructor:
  public ListOption(String exportName, String displayName)
    Parameters:
      exportName (String): Name as exported.
      displayName (String): Name as displayed.
```

--------------------------------

### APIDOC: TallComponents.PDF.Actions.LaunchAction.Path Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Actions.LaunchAction

Documents the 'Path' property of the 'TallComponents.PDF.Actions.LaunchAction' class. This property specifies the complete path of the application to be launched. It is a String type and supports both getting and setting its value.

```APIDOC
TallComponents.PDF.Actions.LaunchAction.Path Property:
  Description: The complete path of the application to launch.
  Type: String
  Access: get; set;
  Syntax: public String Path {
get;
set;
}
```

--------------------------------

### CreateXFAHost Method API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.JavaScript.Scripting.JavaScriptFactory

Provides the API specification for the `CreateXFAHost` method, including its namespace, class, syntax, and return value, for creating custom JavaScript xfa.host objects.

```APIDOC
Namespace: TallComponents.PDF.JavaScript.Scripting
Class: JavaScriptFactory

Method: CreateXFAHost
  Description: Override this method to create a custom JavaScript xfa.host object.
  Syntax: protected internal XFAHost CreateXFAHost()
  Returns:
    Type: XFAHost
    Description: Custom JavaScript xfa.host object
```

--------------------------------

### APIDOC: TallComponents.PDF.TextExtraction.TextMatchEnumerator.Reset Method

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.TextExtraction.TextMatchEnumerator

Documents the Reset method of the TextMatchEnumerator class, which resets the enumerator to its initial position before the first item, allowing subsequent calls to MoveNext to start from the beginning.

```APIDOC
TallComponents.PDF.TextExtraction.TextMatchEnumerator.Reset()
  Description: Resets the enumerator before the first item. After calling MoveNext, Current points to the first text match.
  Syntax: public Void Reset()
  Returns: Void
```

--------------------------------

### TallComponents.PDF.Brushes.TilingBrush Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Brushes.TilingBrush

Defines the public constructor for the TilingBrush class, which initializes a new instance with an empty pattern cell. This constructor takes no parameters.

```APIDOC
Namespace: TallComponents.PDF.Brushes
Class: TilingBrush

Constructor:
  TilingBrush()
    Description: Creates a new TilingBrush with an empty pattern cell.
    Syntax: public TilingBrush()
```

--------------------------------

### RotationOffsetY Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Transforms.RotateTransform

Defines the `RotationOffsetY` property within the `TallComponents.PDF.Transforms.RotateTransform` class. This property is of type `Double` and allows getting or setting the y-coordinate of the rotation center, relative to the origin of the shape.

```APIDOC
public
Double
RotationOffsetY
{
get;
set;
}
```

--------------------------------

### TallComponents.PDF.Layer Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Layer.%23ctor(System.String,System

Provides the syntax and parameter details for creating a new instance of the TallComponents.PDF.Layer class.

```APIDOC
Namespace: TallComponents.PDF
Class: Layer

Constructor:
  public Layer(String name, Boolean visible)

Parameters:
  name: String - The name of this layer.
  visible: Boolean - The state if this layer should be visible or invisible by default.
```

--------------------------------

### XFAHost Class Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.JavaScript.Scripting.XFAHost

Documents the constructor for the XFAHost class, which is used to initialize new instances of the XFAHost object. This constructor takes no parameters.

```APIDOC
Class: XFAHost
  Constructor:
    XFAHost()
      Description: Creates a new XFAHost object.
      Syntax: public XFAHost()
```

--------------------------------

### TallComponents.PDF.Tags.AttributeGroupCollection.Item Property (C# APIDOC)

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Tags.AttributeGroupCollection.Item(System

Defines an indexer property for the AttributeGroupCollection class, allowing access to AttributeGroup objects by their integer index. It supports both getting and setting AttributeGroup instances.

```APIDOC
Namespace: TallComponents.PDF.Tags
Class: AttributeGroupCollection

Property: Item (Indexer)
  Description: Returns or sets the AttributeGroup at a particular index.

  Syntax:
    public AttributeGroup Item[Int32 index] { get; set; }

  Parameters:
    index: Int32
      Description: The index of the AttributeGroup that has to be returned or set.

  Property Value:
    AttributeGroup
      Description: The requested AttributeGroup.
```

--------------------------------

### API Documentation for FreeHandStartSegment.Y Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.FreeHandStartSegment

Provides a detailed API reference for the 'Y' property of the TallComponents.PDF.Shapes.FreeHandStartSegment class, including its namespace, class, description, type, and C# syntax for getting and setting the value.

```APIDOC
Namespace: TallComponents.PDF.Shapes
Class: FreeHandStartSegment
Property: Y
  Description: Vertical position of start point.
  Type: Double
```

```C#
public
Double
 Y
{
get;
set;
}
```

--------------------------------

### API Documentation for TallComponents.PDF.Actions.UriAction.Accept Method

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Actions.UriAction.Accept(TallComponents.PDF.Actions.ActionVisitor,System

Detailed API specification for the `Accept` method, including its full signature, parameter types and descriptions, and the return type. This method is crucial for implementing the visitor pattern within the TallComponents.PDF.Actions framework.

```APIDOC
Accept Method:
  Syntax:
    public Object Accept(
      ActionVisitor visitor,
      Object argument
    )
  Parameters:
    visitor: ActionVisitor
      The visitor used to Accept this action.
    argument: Object
      An additional argument passed to the Visit method (may be ).
  Returns:
    Object
```

--------------------------------

### AnnotationVisitor Class Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Annotations.AnnotationVisitor

Provides the syntax for initializing a new instance of the `AnnotationVisitor` class. This default constructor requires no parameters.

```APIDOC
public
AnnotationVisitor(
)
```

--------------------------------

### TallComponents.PDF.Shapes.FreeHandLineSegment Y1 Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.FreeHandLineSegment

Defines the `Y1` property, which represents the vertical position of the end point for a `FreeHandLineSegment`. This property is of type `Double` and supports both getting and setting its value.

```C#
public
Double
 Y1
 {
get;
set;
}
```

```APIDOC
Namespace: TallComponents.PDF.Shapes
Class: FreeHandLineSegment
  Property: Y1
    Description: Vertical position of end point.
    Type: Double
    Access: get, set
```

--------------------------------

### TallComponents.PDF.Forms.Fields.ValueField.Value Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Fields.ValueField

Describes the 'Value' property of the TallComponents.PDF.Forms.Fields.ValueField class. This property gets or sets the value associated with the field. It can throw an ObjectDisposedException if the field was removed from the field collection (dynamic XFA).

```C#
public String Value { get; set; }
```

--------------------------------

### MessageBox Method API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.JavaScript.Scripting.XFAHost.MessageBox(System.String,System.String,TallComponents.PDF.JavaScript.Scripting.AlertIcon,TallComponents.PDF.JavaScript.Scripting

Detailed API documentation for the `MessageBox` method, including its full signature, return type, and descriptions for all parameters.

```APIDOC
Method: MessageBox
Namespace: TallComponents.PDF.JavaScript.Scripting
Class: XFAHost

Signature:
protected AlertResult MessageBox(
  String message,
  String title,
  AlertIcon icon,
  AlertButtons buttons
)

Returns:
AlertResult

Parameters:
  message (String): Message to display.
  title (String): Title of the dialog window.
  icon (AlertIcon): Icon to display.
  buttons (AlertButtons): Buttons to display.
```

--------------------------------

### TallComponents.PDF.Forms.Fields.Lock.Action Property API Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Fields.Lock

Defines the `Action` property of the `Lock` class, which specifies the set of fields to be locked. It is a public property with a `LockAction` type, allowing both get and set operations.

```C#
public LockAction Action
{
    get;
    set;
}
```

--------------------------------

### TallComponents.PDF.Spacing Class Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Spacing

Provides the API documentation for the constructor of the TallComponents.PDF.Spacing class, which initializes a new instance of the class.

```APIDOC
Class: TallComponents.PDF.Spacing
  Constructor: Spacing()
    Description: Initializes a new instance of the Spacing class.
    Syntax: public
Spacing(
)
```

--------------------------------

### Get Bitmap Width Property in TallComponents.PDF

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Bitmap

Describes the `Width` property of the `TallComponents.PDF.Bitmap` class, which returns the bitmap's width in pixels. It includes the C# syntax and a structured API definition.

```C#
public
Int32
	Width
	{
get;
}
```

```APIDOC
Namespace: TallComponents.PDF
Class: TallComponents.PDF.Bitmap
  Property: Width
    Type: Int32
    Accessors: get
    Description: Bitmap width in pixels.
```

--------------------------------

### FreeHandStartSegment Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Shapes.FreeHandStartSegment

Defines the public constructor for the FreeHandStartSegment class, which allows for the creation of new instances without any parameters.

```APIDOC
public
FreeHandStartSegment(
)
```

--------------------------------

### C# Syntax for VerticalAlignment Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Widgets.Widget

Illustrates the C# syntax for defining the `VerticalAlignment` property, which allows getting and setting the vertical text alignment. This property is specifically applicable to Xfa documents.

```C#
public
VerticalAlignment
VerticalAlignment
{
get;
set;
}
```

--------------------------------

### LaunchAction Constructor Syntax and Parameters

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.LaunchAction.%23ctor(System

Initializes a new instance of the LaunchAction class, specifying the complete path to the external application to be launched. This constructor is part of the TallComponents.PDF.Actions namespace.

```APIDOC
LaunchAction Constructor:
  public LaunchAction(String path)
    path (String): The complete path of the application to launch.
```

--------------------------------

### Summary Class Constructor

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/classes/TallComponents.PDF.Diagnostics

Documents the default constructor for the `Summary` class, used to create a new instance.

```APIDOC
Summary()
  Create a new summary instance.
```

--------------------------------

### TallComponents.PDF.Annotations.Annotation.Accept Method Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.Annotation.Accept(TallComponents.PDF.Annotations.AnnotationVisitor,System

Detailed API documentation for the `Accept` method of the `TallComponents.PDF.Annotations.Annotation` class, including its C# signature, parameters, and return type.

```C#
public Object Accept(AnnotationVisitor visitor, Object argument)
```

```APIDOC
Method: Accept
Namespace: TallComponents.PDF.Annotations
Class: Annotation
Description: Accept this annotation.

Syntax:
  public Object Accept(AnnotationVisitor visitor, Object argument)

Parameters:
  visitor: AnnotationVisitor
    Description: The visitor to accept.
  argument: Object
    Description: An additional argument passed to the Visit method (may be ).

Returns:
  Object
```

--------------------------------

### APIDOC: TallComponents.PDF.Metadata.MetadataString.Value Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Metadata.MetadataString

API documentation for the `Value` property of the `MetadataString` class. It specifies the property's namespace, class, type, and accessors (get and set), indicating it holds a string value.

```APIDOC
Namespace: TallComponents.PDF.Metadata
Class: MetadataString
Property: Value
  Description: The value.
  Type: String
  Accessors: get, set
```

--------------------------------

### XFAHost Class Print Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.JavaScript.Scripting.XFAHost.Print(System.Boolean,System.Int32,System.Int32,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System

Detailed API documentation for the `Print` method, including its signature, return type, and a comprehensive description of each parameter and its effect on the printing process.

```APIDOC
Namespace: TallComponents.PDF.JavaScript.Scripting
Class: XFAHost

Method Print:
  Description: Override this method to provide custom xfa.host.print() behaviour
  Syntax: protected Void Print(
    Boolean displayPrintDialog,
    Int32 startPage,
    Int32 endPage,
    Boolean displayCancelDialog,
    Boolean shrinkPage,
    Boolean printAsImage,
    Boolean printInReverseOrder,
    Boolean printAnnotations
  )
  Returns: Void
  Parameters:
    displayPrintDialog (Boolean): True (default) Displays a print dialog box and prompts the user for printing setup information and confirmation of the action. False Does not display a print dialog box. Printing proceeds without prompting the user for information or confirmation.
    startPage (Int32): A valid string representing the page number of the beginning of the range to print. Page values are 0-based, so you represent page 1 with a value of 0. The start page is included in the printing.
    endPage (Int32): A valid string representing the page number of the end of the range to print. Page values are 0-based, so you represent page 1 with a value of 0. The end page is included in the printing.
    displayCancelDialog (Boolean): True (default) Does not display a cancel dialog box during the printing process. False Displays a cancel dialog box to stop the printing process.
    shrinkPage (Boolean): True (default) Shrinks the page (if necessary) to fit within the imageable area of the printed page. False Does not shrink the page to fit within the imageable area of the printed page.
    printAsImage (Boolean): True (default) Prints each page as an image. False Prints each page as a page of text.
    printInReverseOrder (Boolean): True (default) Prints the pages in reverse order. False Prints the pages in order.
    printAnnotations (Boolean): True (default) Prints all annotations. False Does not print annotations.
```

--------------------------------

### C# Property WideNarrowRatio API Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Fields.Barcodes.Code2of5InterleavedBarcodeField

Defines the `WideNarrowRatio` property within the `TallComponents.PDF.Forms.Fields.Barcodes.Code2of5InterleavedBarcodeField` class. This property allows getting and setting a double value to specify the wide narrow ratio for the barcode.

```C#
public
Double
 WideNarrowRatio
{
get;
set;
}
```

--------------------------------

### SignatureWidget Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Annotations.Widgets.SignatureWidget.%23ctor(System.Double,System.Double,System.Double,System

Provides the detailed API documentation for the SignatureWidget constructor, including its syntax and descriptions for all required parameters.

```APIDOC
Syntax:
public SignatureWidget(
  Double left,
  Double bottom,
  Double width,
  Double height
)

Parameters:
  left: Double
    The left position for this widget.
  bottom: Double
    The bottom position for this widget.
  width: Double
    The width for this widget.
  height: Double
    The height for this widget.
```

--------------------------------

### API Documentation: TallComponents.PDF.Annotations.Markups.Popup.Open Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Markups.Popup

Documents the 'Open' property of the TallComponents.PDF.Annotations.Markups.Popup class. This boolean property determines if a pop-up annotation should be displayed open when initially rendered. It provides both get and set accessors.

```APIDOC
Namespace: TallComponents.PDF.Annotations.Markups
Class: Popup
Property: Open
  Description: The pop-up should initially be displayed open.
  Type: Boolean
  Syntax:
    public Boolean Open
    {
      get;
      set;
    }
```

--------------------------------

### API Definition: Line.StartStyle Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Markups.Line

Defines the 'StartStyle' property for the 'TallComponents.PDF.Annotations.Markups.Line' class. This property allows getting and setting the line end style at the beginning of a line annotation, using the 'LineEndStyle' enumeration.

```APIDOC
Namespace: TallComponents.PDF.Annotations.Markups
Class: Line
  Property: StartStyle
    Description: The line end style at the start of the line.
    Syntax:
      public LineEndStyle StartStyle
      {
      get;
      set;
      }
    Property Value:
      Type: LineEndStyle
```

--------------------------------

### Accept Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.Markups.FileAttachment.Accept(TallComponents.PDF.Annotations.AnnotationVisitor,System

Detailed API documentation for the `Accept` method of the `TallComponents.PDF.Annotations.Markups.FileAttachment` class, including its signature, return type, and parameter descriptions.

```APIDOC
Method: Accept
  Namespace: TallComponents.PDF.Annotations.Markups
  Class: FileAttachment
  Description: Accept this annotation.
  Signature: public Object Accept(AnnotationVisitor visitor, Object argument)
  Returns: Object
  Parameters:
    visitor (AnnotationVisitor): The visitor used to Accept this annotation.
    argument (Object): An additional argument passed to the Visit method (may be ).
```

--------------------------------

### TallComponents.PDF.Actions.UriAction.IsMap Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Actions.UriAction

Defines the IsMap property within the TallComponents.PDF.Actions.UriAction class, which is a boolean flag indicating whether mouse position is tracked when a URI is resolved. It provides both get and set accessors.

```C#
public
Boolean IsMap
{
get;
set;
}
```

```APIDOC
Property Name: IsMap
Type: Boolean
Access: Get, Set
```

--------------------------------

### C# OpenOptions Default Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.OpenOptions

This snippet shows the basic syntax for instantiating the `OpenOptions` class using its default, parameterless constructor. It initializes a new instance of the class.

```C#
public
OpenOptions(
)
```

--------------------------------

### TallComponents.PDF.Fonts.FontLicensingRights Enum Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/enums/TallComponents.PDF.Fonts

Defines various font licensing rights that determine how a font may be embedded and used in documents, including permissions for installation, editing, previewing, and embedding restrictions.

```APIDOC
Enum FontLicensingRights:
  Namespace: TallComponents.PDF.Fonts
  Description: Font licensing rights.

  Fields:
    Unknown: The font licensing rights could not be determined.
    InstallableEmbedding: This setting indicates that the font may be embedded and permanently installed on the remote system by an application. The user of the remote system acquires the identical rights, obligations and licenses for that font as the original purchaser of the font, and is subject to the same end-user license agreement, copyright, design patent, and/or trademark as was the original purchaser.
    RestrictedLicenseEmbedding: This setting indicates that the font must not be modified, embedded or exchanged in any manner without first obtaining permission of the legal owner. Caution: For Restricted License embedding to take effect, it must be the only level of embedding selected.
    PreviewAndPrintEmbedding: This setting indicates that the font may be embedded, and temporarily loaded on the remote system. Documents containing Preview & Print fonts must be opened "read-only;" no edits can be applied to the document.
    EditableEmbedding: This setting indicates that the font may be embedded but must only be installed temporarily on other systems. In contrast to Preview & Print fonts, documents containing Editable fonts may be opened for reading, editing is permitted, and changes may be saved.
    NoSubsetting: This setting indicates that the font may not be subsetted prior to embedding. Other embedding restrictions may also apply.
    BitmapEmbeddingOnly: This setting indicates that only bitmaps contained in the font may be embedded. No outline data may be embedded. If there are no bitmaps available in the font, then the font is considered unembeddable and the embedding services will fail. Other embedding restrictions may also apply.
```

--------------------------------

### TextMarkup Class Constructor API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Annotations.Markups.TextMarkup.%23ctor(System.Double,System.Double,System.Double,System

Detailed API documentation for the `TallComponents.PDF.Annotations.Markups.TextMarkup` constructor, including its signature and parameter descriptions for defining the markup's position and size.

```APIDOC
Constructor: TextMarkup
  Namespace: TallComponents.PDF.Annotations.Markups
  Class: TextMarkup
  Description: Create a new text markup.
  Syntax:
    public TextMarkup(
      Double left,
      Double bottom,
      Double width,
      Double height
    )
  Parameters:
    left (Double): The left position for this text markup.
    bottom (Double): The bottom position for this text markup.
    width (Double): The width for this text markup.
    height (Double): The height for this text markup.
```

--------------------------------

### Bookmark Class Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Navigation.Bookmark.%23ctor(System

Defines the constructor for the TallComponents.PDF.Navigation.Bookmark class. This constructor initializes a new empty bookmark and assigns it the specified title.

```APIDOC
public Bookmark(
  String title
)

Parameters:
  title: String - The title for the new bookmark.
```

--------------------------------

### WideNarrowRatio Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Shapes.Barcodes.Code3of9BarcodeShape

Defines the `WideNarrowRatio` property within the `TallComponents.PDF.Shapes.Barcodes.Code3of9BarcodeShape` class. This property is of type `Double` and allows both getting and setting its value, representing the ratio of wide bars/spaces to narrow bars/spaces in a barcode.

```C#
public
Double
WideNarrowRatio
{
get;
set;
}
```

--------------------------------

### C# Syntax for MetadataString.Value Property

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Metadata.MetadataString

This C# code snippet defines the `Value` property within the `MetadataString` class. It is a public property of type `String` that allows both reading (get) and writing (set) of its value.

```csharp
public
String
 Value
 {
get;
set;
}
```

--------------------------------

### APIDOC: StandardSignatureHandler.Create Method Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.DigitalSignatures.StandardSignatureHandler.Create(TallComponents.PDF.DigitalSignatures

Comprehensive API documentation for the `Create` method of the `StandardSignatureHandler` class. This method facilitates the creation of a signature handler instance, optimized for signing certificates, by utilizing a PKCS#12 key store.

```APIDOC
Namespace: TallComponents.PDF.DigitalSignatures
Class: StandardSignatureHandler

Method: Create
  Description: Create a new StandardSignatureHandler best suited for a signing certificate.
  Syntax: public StandardSignatureHandler Create(Pkcs12Store keyStore)
  Parameters:
    keyStore:
      Type: Pkcs12Store
      Description: The key store containing the private key.
  Returns: StandardSignatureHandler
```

--------------------------------

### Code3of9BarcodeField.WideNarrowRatio Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Fields.Barcodes.Code3of9BarcodeField

Defines the WideNarrowRatio property within the TallComponents.PDF.Forms.Fields.Barcodes.Code3of9BarcodeField class. This public property is of type Double and provides both get and set accessors, used to specify the wide narrow ratio for the barcode.

```APIDOC
public
Double
WideNarrowRatio
{
get;
set;
}
```

--------------------------------

### GoToAction Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.GoToAction

Defines the syntax for creating a new instance of the GoToAction class, which represents a GoTo action in PDF documents. This constructor takes no parameters.

```APIDOC
public
GoToAction(
)
```

--------------------------------

### Annotation.Width Property API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Annotations.Annotation

Detailed API documentation for the Width property within the TallComponents.PDF.Annotations.Annotation class. This property allows getting and setting the width of an annotation, and its value type is Double.

```APIDOC
Namespace: TallComponents.PDF.Annotations
Class: Annotation
Property: Width
  Description: Width of this annotation.
  Syntax:
    public Double Width { get; set; }
  Value Type: Double
```

--------------------------------

### UriAction Class Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.UriAction.%23ctor(System

Documents the constructor for the TallComponents.PDF.Actions.UriAction class, which initializes a new action to open a specified URI in an external web browser. It details the required parameters and their descriptions.

```APIDOC
TallComponents.PDF.Actions.UriAction Class:
  Constructor:
    UriAction(uri: String)
      uri: The uniform resource identifier (uri) for this Uri action.
```

--------------------------------

### C# Property Definition for StartX

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Brushes.AxialGradientBrush

Defines the `StartX` property, a `Double` type, which represents the horizontal position of the gradient fill's starting point. This property is part of the `AxialGradientBrush` class and is both readable and writable.

```C#
public
Double
 StartX
 {
get;
set;
}
```

--------------------------------

### APIDOC: TallComponents.PDF.Actions.ActionVisitor.Visit Method

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Actions.ActionVisitor.Visit(TallComponents.PDF.Actions.GoToAction,System

Documents the `Visit` method of the `ActionVisitor` class, which handles `GoToAction` objects. This method allows for custom processing of `GoToAction` instances within a visitor pattern, providing an additional argument for context.

```APIDOC
Method: Visit
  Namespace: TallComponents.PDF.Actions
  Class: ActionVisitor
  Signature: public Object Visit(GoToAction action, Object argument)
  Returns: Object
  Parameters:
    action: GoToAction
      Description: The visitor must handle a GoToAction.
    argument: Object
      Description: The additional argument passed to the Accept method (can be ).
```

--------------------------------

### APIDOC TallComponents.PDF.Navigation.Bookmark.Title Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Navigation.Bookmark

Comprehensive API documentation for the 'Title' property of the 'Bookmark' class within the 'TallComponents.PDF.Navigation' namespace. This property allows getting and setting the string value representing the bookmark's title.

```APIDOC
Namespace: TallComponents.PDF.Navigation
Class: Bookmark
  Property: Title
    Description: Title of this bookmark.
    Type: String
    Access: public get; set;
```

--------------------------------

### RadioButtonValue Property API Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Fields.RadioButtonField

Defines the RadioButtonValue property within the TallComponents.PDF.Forms.Fields.RadioButtonField class. This property allows getting and setting the currently selected RadioButtonOption. It returns null if no option is selected.

```APIDOC
Namespace: TallComponents.PDF.Forms.Fields
Class: RadioButtonField
Property: RadioButtonValue
  Description: The value for this field. Returns null if no Option is selected.
  Type: RadioButtonOption
  Syntax:
    public RadioButtonOption RadioButtonValue { get; set; }
```

--------------------------------

### API Documentation for AnnotationVisitor.Visit Method

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.AnnotationVisitor.Visit(TallComponents.PDF.Annotations.Widgets.SignatureWidget,System

Provides the API signature, parameters, and return type for the Visit method, which is used to process SignatureWidget annotations.

```APIDOC
Namespace: TallComponents.PDF.Annotations
Class: AnnotationVisitor
Method: Visit

Signature:
public Object Visit(SignatureWidget annotation, Object argument)

Parameters:
  annotation (SignatureWidget): The visitor must handle a signature widget.
  argument (Object): The additional argument passed to the Accept method (can be ).

Returns:
  Object
```

--------------------------------

### GoToAction Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Actions.GoToAction.%23ctor(TallComponents.PDF

Documents the constructor for the TallComponents.PDF.Actions.GoToAction class, which initializes a new GoTo action based on a specified Page object. This action navigates to the given page, embedding it as an internal destination with PageDisplay set to FitEntire.

```APIDOC
GoToAction Constructor:
  Namespace: TallComponents.PDF.Actions
  Class: GoToAction
  Signature: public GoToAction(Page page)
  Parameters:
    page:
      Type: Page
      Description: The page to go to. The page will be embedded in an internal destination, with PageDisplay set to FitEntire.
```

--------------------------------

### XfdfFormData.Path Property Definition

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Forms.Data.XfdfFormData

Defines the 'Path' property of the TallComponents.PDF.Forms.Data.XfdfFormData class. This property is used to get or set the file path of the PDF document that an XFDF file was exported from or is intended to be imported into. The property is of type String.

```APIDOC
Namespace: TallComponents.PDF.Forms.Data
Class: XfdfFormData
Property: Path
  Type: String
  Accessors:
    get
    set
```

--------------------------------

### RadialGradientBrush.Y Property Definition and API Reference

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/properties/TallComponents.PDF.Brushes.RadialGradientBrush

Defines the 'Y' property of the RadialGradientBrush class, including its C# syntax for getting and setting the value, and detailed API documentation covering its type, accessors, and purpose.

```C#
public
Double
 Y
 {
get;
set;
}
```

```APIDOC
Namespace: TallComponents.PDF.Brushes
Class: RadialGradientBrush
Property: Y
  Description: The vertical position of the center point of both circles. This position is relative to the origin of the shape to which the brush is applied.
  Type: Double
  Accessors: get, set
```

--------------------------------

### Add Method API Documentation for WidgetCollection

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.Widgets.WidgetCollection.Add(TallComponents.PDF.Annotations.Widgets

Detailed API documentation for the `Add` method of the `TallComponents.PDF.Annotations.Widgets.WidgetCollection` class, including its signature, parameters, and return value.

```APIDOC
Method: Add
  Namespace: TallComponents.PDF.Annotations.Widgets
  Class: WidgetCollection
  Description: Adds a widget to the end of this collection.
  Note: This collection can be associated with a page or a field. The page or field property on the added widget will be updated to reflect this association.
  Syntax: public Void Add(Widget widget)
  Returns: Void
  Parameters:
    widget:
      Type: Widget
      Description: The widget to add.
```

--------------------------------

### Get Index of Bookmark in Collection (C# API)

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Navigation.BookmarkCollection.IndexOf(TallComponents.PDF.Navigation

Documents the `IndexOf` method of the `TallComponents.PDF.Navigation.BookmarkCollection` class, which returns the zero-based index of a specified `Bookmark` object within the collection. It returns -1 if the bookmark is not found.

```APIDOC
Method: IndexOf
Namespace: TallComponents.PDF.Navigation
Class: BookmarkCollection

Description: Returns the index of the specified bookmark in the collection.

Syntax:
public Int32 IndexOf(
  Bookmark bookmark
)

Parameters:
  bookmark:
    Type: Bookmark
    Description: The bookmark to locate in this collection.

Returns:
  Type: Int32
  Description: The zero-based index of the item found in the collection; otherwise, -1.
```

--------------------------------

### TallComponents.PDF.Annotations.Widgets.PushButtonWidget.Accept Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.Annotations.Widgets.PushButtonWidget.Accept(TallComponents.PDF.Annotations.AnnotationVisitor,System

Documents the `Accept` method, which allows an `AnnotationVisitor` to process this annotation. It takes a visitor and an optional argument, returning an `Object`.

```APIDOC
Method: Accept
Namespace: TallComponents.PDF.Annotations.Widgets
Class: PushButtonWidget

Signature:
public Object Accept(
    AnnotationVisitor visitor,
    Object argument
)

Parameters:
  visitor: AnnotationVisitor
    Description: The visitor used to Accept this annotation.
  argument: Object
    Description: An additional argument passed to the Visit method (may be null).

Returns:
  Object
```

--------------------------------

### RemoveRange Method API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/methods/TallComponents.PDF.PageCollection.RemoveRange(System.Int32,System

Detailed API documentation for the `RemoveRange` method of the `TallComponents.PDF.PageCollection` class. This method is used to remove a specified number of contiguous pages from a collection, starting at a given index.

```APIDOC
Class: TallComponents.PDF.PageCollection
  Method: RemoveRange
    Description: Removes multiple contiguous pages from the collection.
    Syntax: public Void RemoveRange(Int32 startIndex, Int32 count)
    Returns: Void
    Parameters:
      startIndex:
        Type: Int32
        Description: The zero-based start index for the page to be removed.
      count:
        Type: Int32
        Description: The number of contiguous pages to be removed.
```

--------------------------------

### TextFindCriteria Class Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.TextExtraction.TextFindCriteria

Defines the syntax for creating a new instance of the TextFindCriteria class with its default properties. This constructor takes no arguments and is publicly accessible.

```APIDOC
public
TextFindCriteria(
)
```

--------------------------------

### LineShape Constructor API Documentation

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.Shapes.LineShape.%23ctor(System.Double,System.Double,System.Double,System

API documentation for the LineShape constructor, detailing its signature and the purpose of each parameter for initializing a new line shape with start and end points.

```APIDOC
LineShape:
  Constructor: public LineShape(Double startX, Double startY, Double endX, Double endY)
    Parameters:
      startX: Double - Horizontal position of start point.
      startY: Double - Vertical position of start point.
      endX: Double - Horizontal position of end point.
      endY: Double - Vertical position of end point.
```

--------------------------------

### VeriSignSignatureHandler Constructor Syntax

Source: https://tallcomponents.com/products/pdfkit5/help/classes/TallComponents.PDF.Fonts.Font/?build=netstandard2.0/constructors/TallComponents.PDF.DigitalSignatures.VeriSignSignatureHandler.%23ctor(TallComponents.PDF.DigitalSignatures.Pkcs12Store,System

Defines the constructor signature for VeriSignSignatureHandler, used to initialize an instance with a PKCS#12 key store and a key name.

```C#
public VeriSignSignatureHandler(
  [Pkcs12Store] keyStore,
  String name
)
```
Tokens:
Raw