Markdown Document Collection

https://documentation.help/PdfFileWriter/
Admin
This project is a collection of Markdown documents, uniquely identified by UUIDs, likely serving as...
Tokens:253,541
Snippets:2,695
Trust Score:9.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example Table Start Event Handler

Source: https://documentation.help/PdfFileWriter/2ada2184-5b0f-e3d9-13b4-914b3b159f0c.htm

This C# example demonstrates how to implement a table start event handler. The handler is called at the start of the table and at the top of each subsequent page to display a heading above the table.

```csharp
// example of table start event handler to display
// heading above the table on each page
void BookListTableStart
    (
    PdfTable    BookList,
    double        TableStartPos
    )
{
double PosX = 0.5 * (BookList.TableArea.Left + BookList.TableArea.Right);
double PosY = TableStartPos + TableTitleFont.Descent(16.0) + 0.05;
BookList.Contents.DrawText(TableTitleFont, 16.0, PosX, PosY,
    TextJustify.Center, DrawStyle.Normal, Color.Chocolate, "Book List PdfTable Example"); 
return;
}
```

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

### Create and Commit PdfChart Example

Source: https://documentation.help/PdfFileWriter/794eaf46-8de6-eafb-adf9-f16a28866df3.htm

Example demonstrating how to create a .NET Chart, build it, then use it to create a PdfChart object, commit it to the PDF file, and dispose of the original chart object.

```csharp
// create chart
Chart MyChart = new Chart();
// build chart
// ...
// ...
PdfImageControl ImageControl = new PdfImageControl();
ImageControl.SaveAs = SaveImageAs.IndexedImage;
PdfChart MyPdfChart = new PdfChart(Document, MyChart, ImageControl);
MyPdfChart.CommitToPdfFile();
MyChart.Dispose();
```

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

### LayerStart

Source: https://documentation.help/PdfFileWriter/d4c243bd-334b-b49c-edd4-820a1eda1a4e.htm

Marks the start of a layer. This method is inherited from PdfContents.

```APIDOC
## LayerStart()

### Description
Layer start.

### Method
LayerStart
```

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

### PdfTable.TablePageNumber Property

Source: https://documentation.help/PdfFileWriter/483c16e8-5a8b-e893-318f-72a451a48b19.htm

Gets the table's page number, starting with zero.

```APIDOC
## PdfTable.TablePageNumber Property

### Description

Gets the table's page number, starting with zero.

### Property Value

Type: Int32

### C# Signature

```csharp
public int TablePageNumber { get; }
```
```

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

### AnnotDisplayMedia Constructor

Source: https://documentation.help/PdfFileWriter/734cae72-00d1-1163-e10d-a85dd7d2d233.htm

Initializes a new instance of the AnnotDisplayMedia class. Requires a PdfDisplayMedia object.

```csharp
public AnnotDisplayMedia(
	PdfDisplayMedia DisplayMedia
)
```

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

### PdfTable.RowNumber Property

Source: https://documentation.help/PdfFileWriter/9f9fb199-defd-24e9-00cd-e4d341e8febd.htm

Gets the current row number. The row number starts with zero.

```APIDOC
## PdfTable.RowNumber Property

### Description
Gets the current row number. The row number starts with zero.

### Property Value
Type: Int32

### Example
```csharp
int currentRowNumber = table.RowNumber;
```
```

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

### DrawWPFPath.DashPhase Property

Source: https://documentation.help/PdfFileWriter/ecf8bfb3-6d9b-8a2d-0535-8883ef2822db.htm

Sets or gets the starting phase of the pen's dash pattern. This property is of type Double.

```APIDOC
## DrawWPFPath.DashPhase Property

### Description

Gets or sets the starting phase of the pen's dash pattern.

### Property Value

Type: Double
```

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

### CreateMetafile Constructor (C#)

Source: https://documentation.help/PdfFileWriter/237607d4-2d3f-c17a-291b-90f0c1506722.htm

Use this constructor to create an image metafile with specified width and height in pixels. Requires PdfFileWriter namespace.

```csharp
public CreateMetafile(
	int Width,
	int Height
)
```

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

### DrawWPFPath.DashPhase Property

Source: https://documentation.help/PdfFileWriter/ecf8bfb3-6d9b-8a2d-0535-8883ef2822db.htm

Sets or gets the starting phase of the pen's dash pattern. This property is of type Double.

```csharp
public double DashPhase { get; set; }
```

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

### Start a PDF Layer - C#

Source: https://documentation.help/PdfFileWriter/49f0fc6f-5a13-21e0-b9f4-d0aa06824e85.htm

Use this method to initiate a new layer within a PDF document. Requires a PdfLayer object as a parameter.

```csharp
public void LayerStart(
	PdfLayer Layer
)
```

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

### PdfDisplayMedia Constructor

Source: https://documentation.help/PdfFileWriter/49e1f2ec-37f6-93ae-17cc-ed841efdbdc7.htm

Initializes a new instance of the PdfDisplayMedia class for display media.

```APIDOC
## PdfDisplayMedia Constructor

### Description

Display media constructor.

### Method

Constructor

### Parameters

None
```

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

### Get and Set TextBoxPageBreakLines Property

Source: https://documentation.help/PdfFileWriter/02b81870-4424-c469-2e1b-aa2663522808.htm

Gets or sets the minimum number of text lines for page break calculations. If zero, the entire TextBox is kept together. If non-zero and the TextBox is too tall, this value determines where a new page starts.

```csharp
public int TextBoxPageBreakLines { get; set; }
```

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

### Get Current Row Number

Source: https://documentation.help/PdfFileWriter/9f9fb199-defd-24e9-00cd-e4d341e8febd.htm

Retrieves the current row number of a PDF table. The row number starts at zero.

```csharp
public int RowNumber { get; }
```

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

### Initialize PdfImage Constructor (C#)

Source: https://documentation.help/PdfFileWriter/258bf232-a455-5e5b-d438-62e409c8698d.htm

This constructor is obsolete. Use the latest documentation for PdfImage initialization.

```csharp
[ObsoleteAttribute("This PdfImage constructor is obsolete. See latest documentation.", 
	false)]
public PdfImage(
	PdfDocument Document,
	Image Image,
	PdfImageControl ImageControl = null
)
```

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

### CreateMetafile.Metafile

Source: https://documentation.help/PdfFileWriter/150dc8ac-7f56-0f29-2a32-47af948be9a3.htm

Gets the image metafile object.

```APIDOC
## Metafile

### Description

Gets the image metafile object.

### Method

Getter

### Endpoint

N/A (Class property)

### Parameters

N/A

### Request Example

N/A

### Response

- **Metafile** (object) - The image metafile object.

```

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

### Create PdfTilingPattern with Brick Pattern (C#)

Source: https://documentation.help/PdfFileWriter/31bed682-b6cd-45b6-532c-c671ff17ed4d.htm

Use this method to create a tiling pattern that resembles bricks. The stroking color defines the mortar color, and the non-stroking color defines the brick color. Scale the pattern to your requirements.

```csharp
public static PdfTilingPattern SetBrickPattern(
	PdfDocument Document,
	double Scale,
	Color Stroking,
	Color NonStroking
)
```

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

### PdfTableCell.Index Property

Source: https://documentation.help/PdfFileWriter/38b6ad56-80ac-fab3-6b67-1de7b2af939f.htm

Gets the cell's index position within the Table.Cell array. This property returns the cell's column number, starting from zero.

```APIDOC
## PdfTableCell.Index Property

### Description
Gets cell's index position within Table.Cell array.

### Property Value
Type: Int32
It is the cell's column number starting with zero.
```

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

### CreateMetafile Constructor

Source: https://documentation.help/PdfFileWriter/237607d4-2d3f-c17a-291b-90f0c1506722.htm

Initializes a new instance of the CreateMetafile class with the specified width and height.

```APIDOC
## CreateMetafile Constructor

### Description

Initializes a new instance of the CreateMetafile class with the specified width and height.

### Method

Constructor

### Parameters

#### Path Parameters

* None

#### Query Parameters

* None

#### Request Body

* None

### Request Example

```csharp
new PdfFileWriter.CreateMetafile(Width, Height);
```

### Response

#### Success Response (200)

* None (Constructor)

#### Response Example

* None (Constructor)

### Parameters

* **Width** (System.Int32) - Required - Image width in pixels.
* **Height** (System.Int32) - Required - Image height in pixels.
```

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

### Get otmsUnderscoreSize Property Value

Source: https://documentation.help/PdfFileWriter/64fc0324-21d7-df67-04d1-0f26ce49c335.htm

This property is read-only and returns an integer value representing the underscore size. It requires no specific setup beyond having access to a WinOutlineTextMetric object.

```csharp
public int otmsUnderscoreSize { get; }
```

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

### Get Text Metric Character Set

Source: https://documentation.help/PdfFileWriter/3cd54de3-fad7-1a54-1e11-06755104f893.htm

This C# code snippet shows how to access the tmCharSet property, which returns the character set of the text metric as a byte. No specific setup or imports are required beyond having an instance of WinTextMetric.

```csharp
public byte tmCharSet { get; }
```

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

### CreateMetafile Constructor

Source: https://documentation.help/PdfFileWriter/150dc8ac-7f56-0f29-2a32-47af948be9a3.htm

Initializes a new instance of the CreateMetafile class to create an image metafile.

```APIDOC
## CreateMetafile constructor

### Description

Creates an image metafile.

### Method

Constructor

### Endpoint

N/A (Class constructor)

### Parameters

N/A

### Request Example

N/A

### Response

N/A (Creates an object instance)

```

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

### PdfTable.RowTopPosition Property

Source: https://documentation.help/PdfFileWriter/398778ff-93fe-0858-1310-08627f7ddf30.htm

Gets or sets the current row top position. This property can only be set during initialization. It should be set by the caller if, on the first page, the table does not start at the top of the page. The row top position is calculated for each row and is the last RowBottomPosition plus GridLineWidth. The calculation is done within the DrawRow method before any of the cells are drawn.

```APIDOC
## PdfTable.RowTopPosition Property

### Description
Gets or sets the current row top position. This property can only be set during initialization. It should be set by the caller if, on the first page, the table does not start at the top of the page. The row top position is calculated for each row and is the last RowBottomPosition plus GridLineWidth. The calculation is done within the DrawRow method before any of the cells are drawn.

### Property Value
Type: Double

### C# Signature
```csharp
public double RowTopPosition { get; set; }
```

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)
```

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

### Initialize Pdf417Encoder

Source: https://documentation.help/PdfFileWriter/8d7cf0c7-464f-1128-5bf1-85e3148b64b3.htm

Use this constructor to create a new instance of the Pdf417Encoder class. No specific setup or imports are required beyond referencing the PdfFileWriter assembly.

```csharp
public Pdf417Encoder()
```

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

### Initialize QREncoder Instance

Source: https://documentation.help/PdfFileWriter/716fd2fd-ed1a-9952-e9fb-fcbd3c4d062b.htm

Use this constructor to create a new QREncoder object. It belongs to the PdfFileWriter namespace and is available in the PdfFileWriter.dll assembly.

```csharp
public QREncoder()
```

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

### Get or Set DocumentInColor Flag

Source: https://documentation.help/PdfFileWriter/d8590c78-b4c0-1a49-4d25-71846dbff3f5.htm

This property gets or sets the DocumentInColor flag. It is a boolean value.

```csharp
public bool DocumentInColor { get; set; }
```

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

### Get PdfTableCell ClientLeft Property

Source: https://documentation.help/PdfFileWriter/f7f93f96-bda8-b12c-2e84-9cd8a4b49a68.htm

Gets the client area left side of a table cell. This property is read-only.

```csharp
public double ClientLeft { get; }
```

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

### PdfContentsLayerStart Method

Source: https://documentation.help/PdfFileWriter/49f0fc6f-5a13-21e0-b9f4-d0aa06824e85.htm

Starts a new layer in the PDF document. This method belongs to the PdfContents class within the PdfFileWriter namespace.

```APIDOC
## PdfContentsLayerStart Method

### Description
Starts a new layer in the PDF document.

### Method Signature
```csharp
public void LayerStart(
	PdfLayer Layer
)
```

### Parameters
#### Path Parameters
- **Layer** (PdfFileWriter.PdfLayer) - Required - Layer object to be started.
```

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

### Get PdfTableCell ClientTop Property

Source: https://documentation.help/PdfFileWriter/899d7ec2-3061-2e05-cdd0-0f6817dc88e6.htm

Gets the client area top side of a table cell. This property is read-only.

```csharp
public double ClientTop { get; }
```

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

### BezierD Constructor (PointD, PointD, PointD)

Source: https://documentation.help/PdfFileWriter/67848c4e-2763-3b22-7b2e-bb295d2440ef.htm

Initializes a new instance of the BezierD class from quadratic Bezier points.

```APIDOC
## BezierD Constructor (PointD, PointD, PointD)

### Description
Initializes a new instance of the BezierD class from quadratic Bezier points.

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- None

### Parameters
#### Parameters
- **QP1** (PdfFileWriter.PointD) - Required - Quadratic Bezier point 1
- **QP2** (PdfFileWriter.PointD) - Required - Quadratic Bezier point 2
- **QP3** (PdfFileWriter.PointD) - Required - Quadratic Bezier point 3

### Request Example
```csharp
// Example usage (assuming PointD objects are already created)
// PdfFileWriter.PointD p1 = new PdfFileWriter.PointD(x1, y1);
// PdfFileWriter.PointD p2 = new PdfFileWriter.PointD(x2, y2);
// PdfFileWriter.PointD p3 = new PdfFileWriter.PointD(x3, y3);
// PdfFileWriter.BezierD bezier = new PdfFileWriter.BezierD(p1, p2, p3);
```

### Response
#### Success Response (200)
- N/A (This is a constructor)

#### Response Example
- N/A
```

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

### Get Font Ascent - C#

Source: https://documentation.help/PdfFileWriter/37d3d853-b9c7-273f-8f24-a4477e319ae4.htm

Gets the font ascent for the current font and font size. This property is read-only.

```csharp
public double FontAscent { get; }
```

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

### Initialize QREncoderTables

Source: https://documentation.help/PdfFileWriter/bc8e8f6e-cdfd-f981-fc6d-28e8886047a8.htm

Initializes a new instance of the QREncoderTables class. This is a parameterless constructor.

```csharp
public QREncoderTables()
```

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

### Initialize PdfAxialShading Constructor

Source: https://documentation.help/PdfFileWriter/e0756e10-4c34-c5e8-24ee-b097132f2227.htm

Use this constructor to create a PdfAxialShading object. It requires a PdfDocument, bounding box coordinates and dimensions, and a PdfShadingFunction.

```csharp
public PdfAxialShading(
	PdfDocument Document,
	double BBoxLeft,
	double BBoxBottom,
	double BBoxWidth,
	double BBoxHeight,
	PdfShadingFunction ShadingFunction
)
```

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

### Get or Set TextBoxLineBreakFactor

Source: https://documentation.help/PdfFileWriter/2a1fd552-ae43-4025-9929-ae952d054137.htm

Gets or sets the text box line break factor. This property is of type Double.

```csharp
public double TextBoxLineBreakFactor { get; set; }
```

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

### Initialize PdfAxialShading with Document and ShadingFunction

Source: https://documentation.help/PdfFileWriter/0a916440-b262-65b9-e4d8-442f29d67e0f.htm

Use this constructor to create a PdfAxialShading object. It requires a parent PdfDocument and a PdfShadingFunction.

```csharp
public PdfAxialShading(
	PdfDocument Document,
	PdfShadingFunction ShadingFunction
)
```

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

### PdfTable.TableStartEvent Event

Source: https://documentation.help/PdfFileWriter/2ada2184-5b0f-e3d9-13b4-914b3b159f0c.htm

Sets the table start event handler. This handler is called at the start of the table and at the top of each subsequent page.

```APIDOC
## PdfTable.TableStartEvent Event

### Description
Sets the table start event handler. The handler is called at the start of the table and at the top of each subsequent page.

### Event Signature
```csharp
public event PdfTableStart TableStartEvent
```

### Value
Type: PdfFileWriterPdfTableStart
The table start event handler is called at the start of the table and at the top each subsequent page.

### Example Usage
```csharp
// example of table start event handler to display
// heading above the table on each page
void BookListTableStart
    (
    PdfTable    BookList,
    double        TableStartPos
    )
{
    double PosX = 0.5 * (BookList.TableArea.Left + BookList.TableArea.Right);
    double PosY = TableStartPos + TableTitleFont.Descent(16.0) + 0.05;
    BookList.Contents.DrawText(TableTitleFont, 16.0, PosX, PosY,
        TextJustify.Center, DrawStyle.Normal, Color.Chocolate, "Book List PdfTable Example");
    return;
}
```
```

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

### Get TextBox First Line Indent

Source: https://documentation.help/PdfFileWriter/eead1d13-69ea-8c55-4000-dbf04f6ebbb8.htm

Gets the first line indent value for a text box. This property is read-only.

```csharp
public double FirstLineIndent { get; }
```

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

### AnnotDisplayMedia Constructor

Source: https://documentation.help/PdfFileWriter/734cae72-00d1-1163-e10d-a85dd7d2d233.htm

This constructor is used to create an AnnotDisplayMedia object, which represents a display media annotation action.

```APIDOC
## AnnotDisplayMedia Constructor

### Description
Display media annotation action constructor.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **DisplayMedia** (PdfFileWriter.PdfDisplayMedia) - Description: PdfDisplayMedia
```

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

### Get PdfTableCell ClientRight Property

Source: https://documentation.help/PdfFileWriter/e697f592-4290-fc13-bc97-91e5f9b39bd7.htm

Gets the client area right side. ClientRight is calculated as FrameLeft + FrameWidth - Margin.Right.

```csharp
public double ClientRight { get; }
```

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

### Get or Set JPEG Image Quality

Source: https://documentation.help/PdfFileWriter/d44ea8da-2a96-607d-f65e-7685f9a16fb3.htm

Use this property to get or set the JPEG image quality. The value should be an integer.

```csharp
public int ImageQuality { get; set; }
```

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

### Initialize Pdf417EncoderTables

Source: https://documentation.help/PdfFileWriter/e825d869-9566-5d68-b63d-41f11b75a8e7.htm

Initializes a new instance of the Pdf417EncoderTables class. This is a basic constructor with no parameters.

```csharp
public Pdf417EncoderTables()
```

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

### PdfDocument Constructor (Double, Double, Double, String)

Source: https://documentation.help/PdfFileWriter/f8c3f9fb-943c-c5c2-9c8a-5c9f30b9767f.htm

Initializes a new PDF document with the specified width, height, scale factor, and filename. The constructor sets the page size based on the provided width and height, determines orientation (portrait or landscape), and defines the scale factor in user units (points). The document is saved to the specified file.

```APIDOC
## PdfDocument Constructor (Double, Double, Double, String)

### Description
Initializes a new PDF document with the specified width, height, scale factor, and filename. The constructor sets the page size based on the provided width and height, determines orientation (portrait or landscape), and defines the scale factor in user units (points). The document is saved to the specified file.

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)

### Parameters
#### Parameters
- **Width** (System.Double) - Description: Page Width
- **Height** (System.Double) - Description: Page height
- **ScaleFactor** (System.Double) - Description: Scale factor. User unit of measure expressed in points. For example, Inch has scale factor of 72.0.
- **FileName** (System.String) - Description: Document file name. This constructor generates a document with default page size as per width and height arguments in user units. Page orientation is portrait if width is less than height. Otherwise it is landscape.
```

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

### Get or Set Font Size

Source: https://documentation.help/PdfFileWriter/bff22a76-4489-8cb4-9dce-796b91873b55.htm

This property gets or sets the font size for table elements. It is a double-precision floating-point number.

```csharp
public double FontSize { get; set; }
```

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

### PdfBinaryWriter Constructor

Source: https://documentation.help/PdfFileWriter/09430dc0-3577-2a35-8457-07c235394427.htm

Initializes a new instance of the PdfBinaryWriter class. This is the constructor for the PDF binary writer.

```APIDOC
## PdfBinaryWriter Constructor

### Description
Initializes a new instance of the PdfBinaryWriter class.

### Method
Constructor

### Parameters
This constructor does not take any parameters.

### Request Example
```csharp
// Example of how to instantiate PdfBinaryWriter (assuming PdfFileWriter is imported)
// PdfBinaryWriter writer = new PdfBinaryWriter(outputStream);
```

### Response
#### Success Response
Initializes a new PdfBinaryWriter object.

#### Response Example
```csharp
// No direct response, object is created.
```
```

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

### Get or Set TextBoxLineExtraSpace

Source: https://documentation.help/PdfFileWriter/4ae38b90-ce5f-001a-80ac-41c5b7f1fcad.htm

This property gets or sets the extra line spacing for text box items. It is of type Double.

```csharp
public double TextBoxLineExtraSpace { get; set; }
```

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

### PdfShadingFunction Constructor (PdfDocument, GradientBrush)

Source: https://documentation.help/PdfFileWriter/1b61b5f0-c6a7-75fa-8d90-e02e10aa6444.htm

Use this constructor to create a PdfShadingFunction object. It requires a PdfDocument object and a System.Windows.Media.GradientBrush.

```csharp
public PdfShadingFunction(
	PdfDocument Document,
	GradientBrush Brush
)
```

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

### Get otmpFamilyName Property

Source: https://documentation.help/PdfFileWriter/476bf6f1-5626-c7da-607a-b1a13e4c631c.htm

Use this property to get the family name of the outline text metric. It is a read-only string property.

```csharp
public string otmpFamilyName { get; }
```

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

### Set Brush to Solid Color - C#

Source: https://documentation.help/PdfFileWriter/e6a92586-dc9b-1ab9-4f1d-500049413407.htm

Use this method to set the brush to a solid color. Requires a System.Windows.Media.SolidColorBrush object.

```csharp
public void SetBrush(
	SolidColorBrush SolidColorBrush
)
```

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

### Get or Set Text - C#

Source: https://documentation.help/PdfFileWriter/ce94c824-409b-821d-79dc-14f55618717e.htm

Use this property to get or set the text associated with kerning adjustments. It is part of the PdfFileWriter library.

```csharp
public string Text { get; set; }
```

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

### PdfImage Constructor (PdfDocument, QREncoder)

Source: https://documentation.help/PdfFileWriter/30818910-91ce-8cfa-42d9-89d7cd133e83.htm

Initializes a new instance of the PdfImage class. This constructor is obsolete.

```APIDOC
## PdfImage Constructor (PdfDocument, QREncoder)

### Description
Initializes a new instance of the PdfImage class.

**Note:** This API is now obsolete.

### Parameters

- **Document** (PdfFileWriterPdfDocument) - Description missing
- **QREncoder** (PdfFileWriterQREncoder) - Description missing

### Reference
PdfImage Class
PdfImage Overload
PdfFileWriter Namespace
```

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

### Get PdfTableCell FrameLeft Property

Source: https://documentation.help/PdfFileWriter/c4907f58-af14-fd20-3ea8-3dd07d0b4670.htm

This property gets the cell's frame left side (grid line). It is a read-only property.

```csharp
public double FrameLeft { get; }
```

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

### Get Font Line Spacing - C#

Source: https://documentation.help/PdfFileWriter/2a60b1d4-2f42-3866-8658-54655c00dcf3.htm

Gets font line spacing for the current font and font size. This property is read-only.

```csharp
public double FontLineSpacing { get; }
```

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

### DisplayOrderStartGroup Method Signature - C#

Source: https://documentation.help/PdfFileWriter/53713fbb-4dce-4334-6a0c-e2da14e17c73.htm

This is the method signature for DisplayOrderStartGroup. It optionally accepts a string for the group name.

```csharp
public void DisplayOrderStartGroup(
	string GroupName = ""
)
```

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

### PdfDisplayMedia Constructor

Source: https://documentation.help/PdfFileWriter/8166a415-9e9b-d592-1160-e5757c3e3a71.htm

Initializes a new instance of the PdfDisplayMedia class with a specified embedded media file and an optional MIME type.

```APIDOC
## PdfDisplayMedia Constructor

### Description
Initializes a new instance of the PdfDisplayMedia class.

### Method
Constructor

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
- **MediaFile** (PdfFileWriterPdfEmbeddedFile) - Required - Embedded media file.
- **MimeType** (System.String) - Optional - Mime type. If null, the program attempts to convert the file extension to a mime type. If conversion is not available, an application exception will be raised.
```

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

### Get or Set Foreground Color

Source: https://documentation.help/PdfFileWriter/18fc1ef0-a815-abd3-5b74-fba493defe53.htm

Use this property to get or set the foreground color for text and barcodes. The color is of type Color.

```csharp
public Color ForegroundColor { get; set; }
```

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

### SizeD Constructor

Source: https://documentation.help/PdfFileWriter/4ee18a9b-892d-9d01-06f9-a1df48e824db.htm

Initializes a new instance of the SizeD class with specified width and height.

```APIDOC
## SizeD Constructor (Double, Double)

### Description
Initializes a new instance of the SizeD class with the specified width and height.

### Parameters
#### Path Parameters
- **Width** (System.Double) - Description of the width.
- **Height** (System.Double) - Description of the height.

### Reference
SizeD Class
SizeD Overload
PdfFileWriter Namespace
```

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

### Get Text Kerning Adjustments - C#

Source: https://documentation.help/PdfFileWriter/d0c405f4-4543-5b3c-db7a-318396f20710.htm

Call this method to get kerning adjustment pairs for a specific text string. Requires the PdfFileWriter namespace.

```csharp
public KerningAdjust[] TextKerning(
	string Text
)
```

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

### Get Font Descent - C#

Source: https://documentation.help/PdfFileWriter/88f610a1-1088-e2b9-3811-15d088d9bf7d.htm

Call this method to get the font descent in user units for a given font size. Requires the PdfFont class.

```csharp
public double Descent(
	double FontSize
)
```

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

### TextBoxLine Constructor

Source: https://documentation.help/PdfFileWriter/59949321-b287-2e73-6a9e-53df36c876c8.htm

Initializes a new instance of the TextBoxLine class.

```APIDOC
## TextBoxLine Constructor

### Description
Initializes a new instance of the TextBoxLine class.

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)

### Version
1.1.24.0

### Signature
```csharp
public TextBoxLine(
	double Ascent,
	double Descent,
	bool EndOfParagraph,
	TextBoxSeg[] SegArray
)
```

### Parameters
#### Ascent
Type: System.Double
Line ascent.

#### Descent
Type: System.Double
Line descent.

#### EndOfParagraph
Type: System.Boolean
Line is end of paragraph.

#### SegArray
Type: PdfFileWriter.TextBoxSeg[]
Segments' array.
```

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

### Get Character Bounding Box - C#

Source: https://documentation.help/PdfFileWriter/e927693b-2979-eb14-5f6c-1d3c237b3b01.htm

Use this method to get the bounding box of a specific character with a given font size. Requires the PdfFileWriter namespace.

```csharp
public PdfRectangle CharBoundingBox(
	double FontSize,
	char CharValue
)
```

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

### Define PdfTableStart Delegate

Source: https://documentation.help/PdfFileWriter/de33fb50-2959-2cd2-3873-e258593c9673.htm

Delegate signature for the PdfTableStart event handler. Use this to create custom event handlers for when a PDF table begins to be drawn.

```csharp
public delegate void PdfTableStart(
	PdfTable Table,
	double TableStartPos
)
```

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

### Get or Set NumberFormatInfo

Source: https://documentation.help/PdfFileWriter/aa1a3fcc-181a-4a6b-5171-bc7203fe3fa3.htm

This C# snippet shows the declaration of the NumberFormatInfo property. It is used to get or set the number format information for a PDF table style.

```csharp
public NumberFormatInfo NumberFormatInfo { get; set; }
```

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

### Instantiate PdfLayer

Source: https://documentation.help/PdfFileWriter/3e3054b2-0ac1-ed54-0e78-0fcaea0f4a85.htm

Use this constructor to create a new PdfLayer object. It requires a PdfLayers object as the parent and a string for the layer's name.

```csharp
public PdfLayer(
	PdfLayers LayersParent,
	string Name
)
```

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

### PdfDocument Constructor (Double, Double, UnitOfMeasure, String)

Source: https://documentation.help/PdfFileWriter/7500f218-532b-3e19-87fe-8bf7bc7212b2.htm

Initializes a new PDF document with a specified width, height, unit of measure, and filename. The page orientation is set to portrait if width is less than height, otherwise landscape. The unit of measure can be Point, Inch, cm, or mm.

```APIDOC
## PdfDocument Constructor (Double, Double, UnitOfMeasure, String)

### Description
Initializes a new PDF document with a specified width, height, unit of measure, and filename. The page orientation is set to portrait if width is less than height, otherwise landscape. The unit of measure can be Point, Inch, cm, or mm.

### Method
Constructor

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **Width** (System.Double) - Required - Page width.
- **Height** (System.Double) - Required - Page height.
- **UnitOfMeasure** (PdfFileWriter.UnitOfMeasure) - Required - Unit of measure code (e.g., Point, Inch, cm, mm).
- **FileName** (System.String) - Required - Document file name.

### Request Example
```csharp
// Example usage:
PdfDocument doc = new PdfDocument(8.5, 11.0, UnitOfMeasure.Inch, "MyDocument.pdf");
```

### Response
#### Success Response (200)
- N/A (Constructor)

#### Response Example
- N/A (Constructor)
```

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

### Get or Set Minimum Header Height - C#

Source: https://documentation.help/PdfFileWriter/784c4dcd-278f-60eb-3613-70ccc9620793.htm

Use this property to define the minimum height for a table header. It is a public property with get and set accessors.

```csharp
public double MinHeaderHeight { get; set; }
```

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

### PdfRadialShading Constructor (PdfDocument, RadialGradientBrush)

Source: https://documentation.help/PdfFileWriter/2a3c1637-10f3-f1e4-bcdf-a8e9817f765d.htm

Use this constructor to create a PDF radial shading object. It requires a PdfDocument and a System.Windows.Media.RadialGradientBrush. Supports WPF media.

```csharp
public PdfRadialShading(
	PdfDocument Document,
	RadialGradientBrush MediaBrush
)
```

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

### Get or Set Image Height

Source: https://documentation.help/PdfFileWriter/52a5c936-301b-e6ac-2fec-1bb56b0a859a.htm

Gets or sets the image height in user units. Refer to the Image property remarks for a full description of ImageWidth and ImageHeight.

```csharp
public double ImageHeight { get; set; }
```

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

### Get or Set PdfDisplayMedia Object

Source: https://documentation.help/PdfFileWriter/35092665-44fa-a385-2611-f04ed5ecd649.htm

This C# code snippet shows how to get or set the PdfDisplayMedia object for the AnnotDisplayMedia class. It is a public property with a getter and setter.

```csharp
public PdfDisplayMedia DisplayMedia { get; set; }
```

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

### PdfTable Initialization

Source: https://documentation.help/PdfFileWriter/1c7c996b-63e0-4912-ca64-2257c96f526a.htm

Performs the initialization of the PdfTable object, setting up its basic properties before drawing.

```APIDOC
## PdfTableInitialization

### Description

Performs the initialization of the PdfTable object.

### Method

Method

### Endpoint

N/A (Class Method)

### Parameters

N/A

### Request Example

N/A

### Response

N/A

```

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

### InitialMediaOperation Method

Source: https://documentation.help/PdfFileWriter/c571f658-55e3-0d6d-2971-edd71a170a6e.htm

Performs an initial media operation. This method is part of the PdfDisplayMedia class in the PdfFileWriter namespace.

```APIDOC
## InitialMediaOperation Method

### Description
Performs an initial media operation.

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)

### Version
1.1.24.0

### Signature
```csharp
public void InitialMediaOperation(
	MediaOperation OperationCode
)
```

### Parameters
#### OperationCode
- **OperationCode** (PdfFileWriterMediaOperation) - Required - Media operation code enumeration.
```

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

### Get Annotation Rectangle

Source: https://documentation.help/PdfFileWriter/34d29396-012d-5d52-021e-0f8bbf2f2e52.htm

This C# code snippet shows how to access the AnnotationRect property of a PdfAnnotation object to get a copy of its rectangular bounds. This property is read-only.

```csharp
public PdfRectangle AnnotationRect { get; }
```

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

### Instantiate PdfTable Constructor

Source: https://documentation.help/PdfFileWriter/d5cd4605-16de-3819-3dad-c7a6ab6a6d1f.htm

Use this constructor to create a new PdfTable instance. It requires the current PdfPage and PdfContents, with optional parameters for default font and font size.

```csharp
public PdfTable(
	PdfPage Page,
	PdfContents Contents,
	PdfFont Font = null,
	double FontSize = 9
)
```

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

### Get or Set Cell Margins - C#

Source: https://documentation.help/PdfFileWriter/30f87cd3-1227-4c87-f269-0306640d2cc9.htm

Use this property to get or set the margins for a cell within a PDF table. The margins are defined by a PdfRectangle object.

```csharp
public PdfRectangle Margin { get; set; }
```

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

### Get or Set Barcode Narrow Bar Width

Source: https://documentation.help/PdfFileWriter/223fd1c7-2814-0c69-88bc-95a816a781e9.htm

Use this property to get or set the width of the narrow bar in a barcode. The value is a Double representing the width.

```csharp
public double BarcodeBarWidth { get; set; }
```

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

### PdfTilingPattern Constructor

Source: https://documentation.help/PdfFileWriter/d4c243bd-334b-b49c-edd4-820a1eda1a4e.htm

Initializes a new instance of the PdfTilingPattern class. This is the constructor for creating a PDF tiling pattern object.

```APIDOC
## PdfTilingPattern Constructor

### Description
PDF Tiling pattern constructor.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
None explicitly listed for the constructor itself in the provided documentation.
```

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

### Set Brush with Tiling Pattern and Opacity - C#

Source: https://documentation.help/PdfFileWriter/b43ba141-f32a-07af-49b9-a31151826ee9.htm

Use this method to set the brush for drawing paths using a PDF tiling pattern. The BrushOpacity parameter controls the transparency of the brush.

```csharp
public void SetBrush(
	PdfTilingPattern TilingPattern,
	double BrushOpacity = 1
)
```

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

### Get Row Bottom Position - C#

Source: https://documentation.help/PdfFileWriter/010caa89-6a4a-ad55-e48f-5e6c550fb55c.htm

This property gets the current row bottom position. It is calculated as RowTopPosition plus RowHeight within the DrawRow method.

```csharp
public double RowBottomPosition { get; }
```

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

### Instantiate WinKerningPair

Source: https://documentation.help/PdfFileWriter/2072cec9-d6f5-a255-bb36-864e4332ba5c.htm

Use this constructor to create a kerning pair object. It requires the first and second characters of the pair.

```csharp
public WinKerningPair(
	char First,
	char Second
)
```

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

### Get or Set WebLinkStr Property

Source: https://documentation.help/PdfFileWriter/8d2217b3-e690-64b7-c4d6-1a1fedb0b180.htm

This property is used to get or set the web link string associated with an annotation. It is part of the AnnotWebLink class within the PdfFileWriter namespace.

```csharp
public string WebLinkStr { get; set; }
```

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

### Get or Set PdfLayer State

Source: https://documentation.help/PdfFileWriter/44cc2673-df8f-d570-2e4d-f48d195d6c4d.htm

Use this property to get or set the initial state of a PDF layer, determining if it is visible or hidden when the document is opened. This is part of the PdfFileWriter library.

```csharp
public LayerState State { get; set; }
```

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

### AnnotStickyNote Constructor

Source: https://documentation.help/PdfFileWriter/26c81f5a-5806-94f8-8551-b04df7cb300c.htm

Initializes a new instance of the Sticky note annotation action class.

```APIDOC
## AnnotStickyNote Constructor

### Description
Sticky note annotation action constructor.

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)

### Parameters
#### Parameters
- **Note** (System.String) - Required - Sticky note text
- **Icon** (PdfFileWriter.StickyNoteIcon) - Required - Sticky note icon
```

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

### PdfRadialShading Constructors

Source: https://documentation.help/PdfFileWriter/60a3147d-de7a-b42c-6a0a-1841dd8efb1f.htm

Provides constructors for initializing PdfRadialShading objects with different parameters for bounding box and shading functions.

```APIDOC
## PdfRadialShading Constructors

### Description
Initializes a new instance of the `PdfRadialShading` class.

### Constructors

- **PdfRadialShading(PdfDocument, PdfShadingFunction)**: PDF radial shading constructor for one unit bounding box.
- **PdfRadialShading(PdfDocument, RadialGradientBrush)**: PDF radial shading constructor for one unit bounding box.
- **PdfRadialShading(PdfDocument, Double, Double, Double, Double, PdfShadingFunction)**: PDF radial shading constructor.
```

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

### Begin Text Mode

Source: https://documentation.help/PdfFileWriter/b63996a8-8964-5989-72d2-f750c24f970e.htm

Enters the text mode for drawing text elements. This is typically called before drawing text.

```csharp
BeginTextMode
```

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

### DrawArc Method Signature

Source: https://documentation.help/PdfFileWriter/59d6e0cc-0462-ab37-4752-db576a891d46.htm

Signature for the DrawArc method, used to draw arcs in PDF documents. It requires start and end points, radius, rotation, arc type, and an output start point.

```csharp
public void DrawArc(
	PointD ArcStart,
	PointD ArcEnd,
	SizeD Radius,
	double Rotate,
	ArcType Type,
	BezierPointOne OutputStartPoint
)
```

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

### AnnotWebLink Constructor

Source: https://documentation.help/PdfFileWriter/ae922eea-18cc-c9c0-52b7-fa35bd2cdb50.htm

Initializes a new instance of the AnnotWebLink class, representing a web link.

```APIDOC
## AnnotWebLink Constructor

### Description
Initializes a new instance of the AnnotWebLink class, representing a web link.

### Method
Constructor

### Parameters
None
```

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

### PdfContents.DrawArc Method

Source: https://documentation.help/PdfFileWriter/59d6e0cc-0462-ab37-4752-db576a891d46.htm

Draws an arc on the PDF page. This method requires specifying the arc's start and end points, radius, rotation, arc type, and an output start point for Bezier curves.

```APIDOC
## PdfContents.DrawArc Method

### Description
Draws an arc on the PDF page. This method requires specifying the arc's start and end points, radius, rotation, arc type, and an output start point for Bezier curves.

### Method Signature
```csharp
public void DrawArc(
	PointD ArcStart,
	PointD ArcEnd,
	SizeD Radius,
	double Rotate,
	ArcType Type,
	BezierPointOne OutputStartPoint
)
```

### Parameters
#### Path Parameters
* **ArcStart** (PdfFileWriter.PointD) - The starting point of the arc.
* **ArcEnd** (PdfFileWriter.PointD) - The ending point of the arc.
* **Radius** (PdfFileWriter.SizeD) - The radius of the arc, specified as Width and Height.
* **Rotate** (System.Double) - The rotation angle of the arc's X-axis in radians.
* **Type** (PdfFileWriter.ArcType) - An enumeration specifying the type of arc.
* **OutputStartPoint** (PdfFileWriter.BezierPointOne) - The output start point, used for Bezier curve calculations.
```

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

### Get or Set Format String - C#

Source: https://documentation.help/PdfFileWriter/122e8754-8b43-c32f-4c57-5c99fc042c12.htm

This property is used to get or set the format string for numeric values in a PDF table. It influences how values are converted to strings using Value.ToString(Format, NumberFormatInfo).

```csharp
public string Format { get; set; }
```

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

### BezierD Constructors

Source: https://documentation.help/PdfFileWriter/8f199f4a-09db-1c59-ed20-3e5e08032a18.htm

Provides constructors for initializing a BezierD object. Use these to create Bezier curves from quadratic bezier points, cubic bezier points, or a combination of points and parameters.

```csharp
BezierD(PointD, PointD, PointD)
```

```csharp
BezierD(PointD, PointD, PointD, PointD)
```

```csharp
BezierD(PointD, Double, Double, Double, Double, PointD)
```

```csharp
BezierD(Double, Double, Double, Double, Double, Double, Double, Double)
```

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

### BezierD Constructor (Double, Double, Double, Double, Double, Double, Double, Double)

Source: https://documentation.help/PdfFileWriter/6bccc2f2-2837-9029-81e4-15b8c0daa978.htm

Initializes a new instance of the BezierD class with the specified control points.

```APIDOC
## BezierD Constructor (Double, Double, Double, Double, Double, Double, Double, Double)

### Description
Initializes a new instance of the BezierD class with the specified control points.

### Method
Constructor

### Parameters
#### Path Parameters
- **X1** (System.Double) - Required - P1-X
- **Y1** (System.Double) - Required - P1-Y
- **X2** (System.Double) - Required - P2-X
- **Y2** (System.Double) - Required - P2-Y
- **X3** (System.Double) - Required - P3-X
- **Y3** (System.Double) - Required - P3-Y
- **X4** (System.Double) - Required - P4-X
- **Y4** (System.Double) - Required - P4-Y

### Request Example
```csharp
public BezierD(
	double X1,
	double Y1,
	double X2,
	double Y2,
	double X3,
	double Y3,
	double X4,
	double Y4
)
```

### Response
#### Success Response (200)
Initializes a BezierD object.

#### Response Example
```json
{
  "message": "BezierD object created successfully"
}
```
```

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

### Get and Set Pen Opacity

Source: https://documentation.help/PdfFileWriter/5251f787-ddec-a352-6618-1533873957d6.htm

This C# code snippet shows the definition of the PenOpacity property. It is used to get or set the opacity of a pen, with values typically ranging from 0.0 (fully transparent) to 1.0 (fully opaque).

```csharp
public double PenOpacity { get; set; }
```

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

### Get or Set PdfTableCell Style

Source: https://documentation.help/PdfFileWriter/1719710d-72f6-4464-e8da-a89bbfdfc2ee.htm

Use this property to get or set the style for a PDF table cell. If not set, it defaults to the default cell style. Changes to the default style affect all cells without a private style.

```csharp
public PdfTableStyle Style { get; set; }
```

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

### FontApi Constructor

Source: https://documentation.help/PdfFileWriter/e6d60222-8784-14fb-27bb-1dd5ab015f13.htm

Initializes a new instance of the FontApi class.

```APIDOC
## FontApi Constructor

### Description
Initializes a new instance of the FontApi class.

### Method
Constructor

### Endpoint
N/A (Class Constructor)

### Parameters
None
```

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

### CharInfo.CharCode Property

Source: https://documentation.help/PdfFileWriter/4d7ba0c6-99cf-755a-f801-d7642a310d9d.htm

Gets the character code.

```APIDOC
## CharInfo.CharCode Property

### Description
Gets the character code.

### Property Value
Type: Int32
```

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

### WinKerningPair Constructor

Source: https://documentation.help/PdfFileWriter/2072cec9-d6f5-a255-bb36-864e4332ba5c.htm

Initializes a new instance of the WinKerningPair class with specified characters.

```APIDOC
## WinKerningPair Constructor

### Description
Kerning pair constructor.

### Namespace
PdfFileWriter

### Assembly
PdfFileWriter (in PdfFileWriter.dll)

### Signature
```csharp
public WinKerningPair(char First, char Second)
```

### Parameters
#### Path Parameters
- **First** (System.Char) - Required - The first character.
- **Second** (System.Char) - Required - The second character.
```

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

### PdfTableStyle Constructor (PdfTable)

Source: https://documentation.help/PdfFileWriter/bb1e36c8-d4bf-3e71-391d-c5baf5a38c63.htm

Initializes a new instance of the PdfTableStyle class based on the table's default cell style. Requires a PdfTable object as input.

```csharp
public PdfTableStyle(
	PdfTable Table
)
```

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

### SizeD Constructor

Source: https://documentation.help/PdfFileWriter/4ee18a9b-892d-9d01-06f9-a1df48e824db.htm

Initializes a new instance of the SizeD class with specified width and height.

```csharp
public SizeD(
	double Width,
	double Height
)
```

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

### Get or Set Image Width in User Units

Source: https://documentation.help/PdfFileWriter/860b49ad-f351-a9bb-5d31-1ca171990a78.htm

Use this property to get or set the width of an image in user units within a PDF table cell. Refer to the Image property's remarks for more details on ImageWidth and ImageHeight.

```csharp
public double ImageWidth { get; set; }
```

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

### Draw Bezier Cubic Path Overloads

Source: https://documentation.help/PdfFileWriter/1df229a6-ea78-a9e1-135a-af7e4755e7be.htm

Includes several methods for drawing Bezier cubic paths with varying point and coordinate specifications.

```csharp
DrawBezier(BezierD, BezierPointOne)
```

```csharp
DrawBezier(PointD, PointD, PointD)
```

```csharp
DrawBezier(Double, Double, Double, Double, Double, Double)
```

```csharp
DrawBezierNoP1(PointD, PointD)
```

```csharp
DrawBezierNoP1(Double, Double, Double, Double)
```

```csharp
DrawBezierNoP2(PointD, PointD)
```

```csharp
DrawBezierNoP2(Double, Double, Double, Double)
```

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

### WinTextMetric.tmHeight Property

Source: https://documentation.help/PdfFileWriter/95227634-1869-fc79-8e91-f23776446e0a.htm

Gets the text metric height.

```APIDOC
## WinTextMetric.tmHeight Property

### Description
Gets the text metric height.

### Property Value
Type: Int32

### C#
```csharp
public int tmHeight { get; }
```
```

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

### PdfDocument Constructor Signature

Source: https://documentation.help/PdfFileWriter/7500f218-532b-3e19-87fe-8bf7bc7212b2.htm

Use this constructor to create a PDF document with a specified width, height, unit of measure, and file name. The page orientation defaults to portrait or landscape based on width and height. The unit of measure can be Point, Inch, cm, or mm.

```csharp
public PdfDocument(
	double Width,
	double Height,
	UnitOfMeasure UnitOfMeasure,
	string FileName
)
```

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

### PdfTableCell.Parent Property

Source: https://documentation.help/PdfFileWriter/59ee9533-3af6-fb86-bb5d-33df9edd79d8.htm

Gets the parent PdfTable of a PdfTableCell.

```APIDOC
## PdfTableCell.Parent Property

### Description
Gets the parent PdfTable.

### Property Value
Type: PdfTable
```

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

### Instantiate PdfShadingFunction with Color Array (C#)

Source: https://documentation.help/PdfFileWriter/f9de09cd-1dc7-38f8-1a8b-e5188fd7d440.htm

Use this constructor to create a PdfShadingFunction with a document and an array of colors. Ensure the PdfDocument object is valid and the Color array is populated.

```csharp
public PdfShadingFunction(
	PdfDocument Document,
	Color[] ColorArray
)
```

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

### PdfLayer.Name Property

Source: https://documentation.help/PdfFileWriter/2b03b228-dc95-64a4-3e3b-d27d64d9c1fc.htm

Gets the name of the PDF layer.

```APIDOC
## PdfLayer.Name Property

### Description
Gets the name of the PDF layer.

### Property Value
Type: String
```

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

### BezierD Constructor - PDF File Writer

Source: https://documentation.help/PdfFileWriter/67848c4e-2763-3b22-7b2e-bb295d2440ef.htm

Use this constructor to create a BezierD object from three quadratic Bezier points. Ensure the PointD objects are correctly defined.

```csharp
public BezierD(
	PointD QP1,
	PointD QP2,
	PointD QP3
)
```

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

### GetGlyphMetricsApiByGlyphIndex

Source: https://documentation.help/PdfFileWriter/f6488bc3-6397-56d9-bcb8-0494c0248e02.htm

Gets glyph metric for a specified glyph index.

```APIDOC
## GetGlyphMetricsApiByGlyphIndex

### Description
Gets glyph metric for a specified glyph index.

### Method
N/A (This is a C# method signature)

### Endpoint
N/A

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **Type**: CharInfo - Character info class

### Response Example
N/A

### Parameters
#### GlyphIndex
- **Type**: System.Int32
- **Description**: Character code
```

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

### AnnotLinkAction Constructor

Source: https://documentation.help/PdfFileWriter/b849a16c-dbc8-280d-ad9d-586482c90bd2.htm

Initializes a new instance of the AnnotLinkAction class, which represents a go to annotation action.

```APIDOC
## AnnotLinkAction Constructor

### Description
Go to annotation action constructor.

### Method
Constructor

### Parameters
None

### Response
None
```

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

### PdfRadialShading Constructor

Source: https://documentation.help/PdfFileWriter/5b8f8bf3-9a05-76b3-def4-fd551835c018.htm

Initializes a new instance of the PdfRadialShading class for a one-unit bounding box. Requires a PdfDocument and a PdfShadingFunction.

```csharp
public PdfRadialShading(
	PdfDocument Document,
	PdfShadingFunction ShadingFunction
)
```

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

### WinKerningPair.KernAmount Property

Source: https://documentation.help/PdfFileWriter/f61aea89-c0d3-888f-0014-9b0c1cb67ec0.htm

Gets kerning amount in design units.

```APIDOC
## WinKerningPair.KernAmount Property

### Description
Gets kerning amount in design units.

### Property Value
Type: Int32
```

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

### PdfDisplayMedia Constructor Signature

Source: https://documentation.help/PdfFileWriter/8166a415-9e9b-d592-1160-e5757c3e3a71.htm

This is the signature for the PdfDisplayMedia constructor. The MediaFile parameter is required, while MimeType is optional. If MimeType is not provided, the library attempts to infer it from the file extension.

```csharp
public PdfDisplayMedia(
	PdfEmbeddedFile MediaFile,
	string MimeType = null
)
```

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

### KerningAdjust.Text Property

Source: https://documentation.help/PdfFileWriter/ce94c824-409b-821d-79dc-14f55618717e.htm

Gets or sets the Text associated with KerningAdjust.

```APIDOC
## KerningAdjust.Text Property

### Description
Gets or sets the Text associated with the KerningAdjust object.

### Property Value
Type: String

### C# Example
```csharp
public string Text { get; set; }
```
```

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

### WinOutlineTextMetric.otmDescent Property

Source: https://documentation.help/PdfFileWriter/cd1a8c11-1613-6c01-25b0-cac18ee7f9d1.htm

Gets the outline text metric descent.

```APIDOC
## WinOutlineTextMetric.otmDescent Property

### Description
Outline text metric descent.

### Property Value
Type: Int32

### C#
```csharp
public int otmDescent { get; }
```
```

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

### PdfRadialShading Constructors

Source: https://documentation.help/PdfFileWriter/6abc43cc-8ed4-b204-79f8-422a530b9d84.htm

Provides information on the different ways to construct a PdfRadialShading object.

```APIDOC
## PdfRadialShading Constructors

### Description
Constructors for creating PDF radial shadings within a one unit bounding box.

### Constructors

1. **PdfRadialShading(PdfDocument, PdfShadingFunction)**
   - Description: PDF radial shading constructor for one unit bounding box.

2. **PdfRadialShading(PdfDocument, RadialGradientBrush)**
   - Description: PDF radial shading constructor for one unit bounding box.

3. **PdfRadialShading(PdfDocument, Double, Double, Double, Double, PdfShadingFunction)**
   - Description: PDF radial shading constructor.
```

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

### PageCropRect

Source: https://documentation.help/PdfFileWriter/a9cb421f-0767-c193-a456-8dd734230338.htm

Gets or sets the crop rectangle for the document page.

```APIDOC
## PageCropRect

### Description
Document page crop rectangle.

### Property Type
Rectangle
```

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

### PdfAxialShading Constructors

Source: https://documentation.help/PdfFileWriter/0a8a8a23-4f18-a808-fa6d-03f51111beea.htm

Provides information on the different ways to construct a PdfAxialShading object.

```APIDOC
## PdfAxialShading Constructors

### Description
Constructors for creating PDF axial shading resources.

### Method Signatures
- `PdfAxialShading(PdfDocument, PdfShadingFunction)`: PDF axial shading constructor for unit bounding box.
- `PdfAxialShading(PdfDocument, LinearGradientBrush)`: PDF axial shading constructor for unit bounding box.
- `PdfAxialShading(PdfDocument, Double, Double, Double, Double, PdfShadingFunction)`: PDF axial shading constructor.
```

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

### PdfTableStart Delegate Signature

Source: https://documentation.help/PdfFileWriter/de33fb50-2959-2cd2-3873-e258593c9673.htm

The signature for the PdfTableStart delegate, used for handling the start of a PDF table.

```APIDOC
## PdfTableStart Delegate

### Description
PDF table start event handler delegate. Allows custom drawing on the page before the header and the first row are drawn, such as drawing a title above the table.

### Parameters
#### Parameters
- **Table** (PdfFileWriter.PdfTable) - Parent object.
- **TableStartPos** (System.Double) - Table top's position on the page.
```

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

### DocumentInColor

Source: https://documentation.help/PdfFileWriter/a9cb421f-0767-c193-a456-8dd734230338.htm

Gets or sets the DocumentInColor flag for the PDF document.

```APIDOC
## DocumentInColor

### Description
Gets or sets the DocumentInColor flag.

### Property Type
Boolean
```

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

### GetGlyphMetricsApiByCode

Source: https://documentation.help/PdfFileWriter/78a29361-9346-177b-676b-419d0d236513.htm

Gets glyph metric for a specified character code.

```APIDOC
## GetGlyphMetricsApiByCode

### Description
Gets glyph metric for a specified character code.

### Method
```csharp
public CharInfo GetGlyphMetricsApiByCode(int CharCode)
```

### Parameters
#### Path Parameters
- **CharCode** (System.Int32) - Required - Character code

### Return Value
Type: CharInfo - Character info class
```
Tokens:
Raw